Revisit Dependencies, Nix Setup

.chglog/config.yml

@@ -25,4 +25,4 @@ options:
       - Subject
   notes:
     keywords:
-      - BREAKING CHANGE
+      - BREAKING CHANGE

.github/workflows/check.yaml

@@ -0,0 +1,23 @@
+name: "Check, Test and Build Codebase"
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  check:
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - name: "Checkout main"
+        uses: "actions/checkout@v4"
+
+      - name: "Install Nix"
+        uses: "DeterminateSystems/nix-installer-action@v14"
+
+      - name: "Use Nix Cache"
+        uses: "DeterminateSystems/magic-nix-cache-action@v8"
+
+      - name: "Check, Test and Build"
+        run: |
+          nix-shell --pure --run "dev-test-build"

.gitignore

@@ -1,26 +1,7 @@
-.cabal-sandbox/
-.ghc.environment.*
-.hpc
-.hsenv
-.HTF/
-.stack-work/
-*.aux
-*.chi
-*.chs.h
-*.dyn_hi
-*.dyn_o
-*.eventlog
-*.hi
-*.hie
-*.hp
-*.o
-*.prof
-cabal-dev
-cabal.project.local
-cabal.project.local~
-cabal.sandbox.config
-dist
-dist-*
-
-## Nix stuff:
+*~
+/.direnv
+/.envrc
+/dist
+/dist-newstyle
 /result
+/tmp

.hlint.yaml

@@ -9,45 +9,45 @@
 #######################
 
 - modules:
-  - {name: Control.Monad.Error, within: []}
-  - {name: [Data.Aeson], as: Aeson}
-  - {name: Data.ByteString, as: B }
-  - {name: Data.ByteString.Char8, as: BC }
-  - {name: Data.ByteString.Lazy, as: BL }
-  - {name: Data.ByteString.Lazy.Char8, as: BLC }
-  - {name: Data.Text, as: T }
-  - {name: Data.Text.Lazy, as: TL }
-  - {name: Data.Text.Encoding, as: TE }
+    - { name: Control.Monad.Error, within: [] }
+    - { name: [Data.Aeson], as: Aeson }
+    - { name: Data.ByteString, as: B }
+    - { name: Data.ByteString.Char8, as: BC }
+    - { name: Data.ByteString.Lazy, as: BL }
+    - { name: Data.ByteString.Lazy.Char8, as: BLC }
+    - { name: Data.Text, as: T }
+    - { name: Data.Text.Lazy, as: TL }
+    - { name: Data.Text.Encoding, as: TE }
 
 ##########################
 # EXTENSION RESTRICTIONS #
 ##########################
 
 - extensions:
-  - default: false # All extension are banned by default
-  - name:
-    - DataKinds
-    - DeriveGeneric
-    - DeriveLift
-    - FlexibleContexts
-    - FlexibleInstances
-    - GADTs
-    - GeneralizedNewtypeDeriving
-    - KindSignatures
-    - OverloadedStrings
-    - RankNTypes
-    - RecordWildCards
-    - ScopedTypeVariables
-    - StandaloneDeriving
-    - TypeApplications
-    - TypeOperators
+    - default: false # All extension are banned by default
+    - name:
+        - DataKinds
+        - DeriveGeneric
+        - DeriveLift
+        - FlexibleContexts
+        - FlexibleInstances
+        - GADTs
+        - GeneralizedNewtypeDeriving
+        - KindSignatures
+        - OverloadedStrings
+        - RankNTypes
+        - RecordWildCards
+        - ScopedTypeVariables
+        - StandaloneDeriving
+        - TypeApplications
+        - TypeOperators
 
 ################
 # CUSTOM RULES #
 ################
 
 # Replace a $ b $ c with a . b $ c
-- group: {name: dollar, enabled: true}
+- group: { name: dollar, enabled: true }
 
 # Generalise map to fmap, ++ to <>
-- group: {name: generalise, enabled: true}
+- group: { name: generalise, enabled: true }

.prettierignore

@@ -0,0 +1,4 @@
+dist-newstyle/
+dist/
+nix/
+*.md

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "tabWidth": 2,
+  "singleQuote": false,
+  "trailingComma": "es5",
+  "printWidth": 120
+}

.stan.toml

@@ -0,0 +1,8 @@
+# Big tuples
+# Using tuples of big size (>= 4) can decrease code readability
+# In serveral places Stack uses 4-tuples and in one place Stack uses a
+# 5-tuple.
+[[check]]
+  id = "STAN-0302"
+  scope = "all"
+  type = "Exclude"

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-2024 Telostat Pte Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -13,123 +13,31 @@
 *haspara* is a Haskell library that provides monetary definitions and a
 rudimentary (and experimental) accounting functionality.
 
-## Supported GHC Versions
-
-1. `ghc90`
-1. `ghc92`
-
-At the moment, there is no particular reason for not supporting
-`ghc94` except that required settings are not done yet in Nix support
-files, in particular for Cabal dependency.
-
-## Testing Against GHC Versions
-
-You can use Nix support to test against different GHC versions:
-
-```sh
-nix-build --arg compiler "\"ghc92\""
-nix-build --arg compiler "\"ghc90\""
-```
-
-`nix-build` command will default to `ghc90`. Check `./default.nix`
-file for the default `ghc` version in case that this documentation is
-out of date.
-
 ## Development
 
-Before committing code to repository, reformat the code:
+Big, long build command for the impatient:
 
 ```sh
-fourmolu -i src/ test/
-```
-
-Compile the codebase, check warnings and errors:
-
-```sh
-cabal build -O0
-cabal test -O0
-cabal haddock -O0
-```
-
-Run [hlint](https://github.com/ndmitchell/hlint):
-
-```sh
-hlint src/
+hpack &&
+    direnv reload &&
+    fourmolu -i src/ test/ &&
+    prettier --write . &&
+    find . -iname "*.nix" -not -path "*/nix/sources.nix" -print0 | xargs --null nixpkgs-fmt &&
+    hlint src/ test/ &&
+    cabal build -O0 &&
+    cabal run -O0 haspara -- --version &&
+    cabal v1-test &&
+    cabal haddock -O0
 ```
 
-Run [weeder](https://hackage.haskell.org/package/weeder):
+To test and build codebase in development environment, run:
 
 ```sh
-weeder --require-hs-files
+dev-test-build
 ```
 
-## Making Releases
-
-1. Checkout `main` branch:
-
-    ```sh
-    git checkout main
-    ```
-
-2. Ensure that your branch is up to date:
-
-    ```sh
-    git pull
-    ```
-
-3. Update the `version` information in [package.yaml](./package.yaml) if
-   required, run `hpack` to reflect the change on the `.cabal` file, and
-   recompile the project, run tests and generate Haddock documentation:
-
-    ```sh
-    hpack
-    cabal clean
-    cabal build -O0
-    cabal test -O0
-    cabal haddock -O0
-    nix-build --arg compiler "\"ghc92\""
-    nix-build --arg compiler "\"ghc90\""
-    ```
-
-4. Update [CHANGELOG.md](./CHANGELOG.md) file:
-
-    ```sh
-    git-chglog --next-tag <NEW-VERSION> -o CHANGELOG.md
-    ```
-
-5. Commit, tag and push:
-
-    ```sh
-    git commit -am "chore(release): <NEW-VERSION>"
-    git tag -a -m "Release <NEW-VERSION>" <NEW-VERSION>
-    git push --follow-tags origin main
-    ```
-
-6. Publish GitHub release:
-
-    ```sh
-    gh release create "<NEW-VERSION>" --title "v<NEW-VERSION>" --generate-notes
-    ```
-
-7. Create the package, upload to Hackage as a candidate first and check the result:
-
-    ```sh
-    cabal clean
-    cabal build -O0
-    cabal test -O0
-    cabal haddock -O0
-    cabal sdist
-    cabal upload <path to .tar.gz archive>
-    ```
-
-8. If the candidate package release works fine, release to Hackage:
-
-    ```sh
-    cabal upload --publish <path to .tar.gz archive>
-    ```
-
 ## License
 
-Copyright Telostat Pte Ltd (c) 2021-2022.
+Copyright Telostat Pte Ltd (c) 2021-2024.
 
 This work is licensed under MIT license. See [LICENSE](./LICENSE).

cabal.project

@@ -0,0 +1,5 @@
+packages:
+  *.cabal
+
+package *
+  ghc-options: -fwrite-ide-info