Update linting tooling (#179)

* Use fourmolu v0.17.0.0 and cabal-gild

* format the code

* Ignore the formatting commit

Author: Kleidukos

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# fourmolu 0.17.0.0 and cabal-gild formatting
+eab5847b465349bdda613f00dec7f31d83bb1f6d

.github/workflows/linting.yml

@@ -13,7 +13,7 @@ jobs:
 
     - uses: haskell-actions/run-fourmolu@v11
       with:
-        version: "0.14.1.0"
+        version: "0.17.0.0"
         pattern: |
           sel/**/*.hs
           libsodium-bindings/**/*.hs

CONTRIBUTING.md

@@ -10,14 +10,14 @@ We need you to read, acknowledge, and abide by our [Code of Conduct][CoC].
 
 When making a PR, ensure that you have a Github issue that explains the context for your changes.
 
-## Code Style 
+## Code Style
 
 ### C FFI
 
 * The [CApiFFI convention](https://www.haskell.org/ghc/blog/20210709-capi-usage.html) must be used at all times.
 * The datatypes from [`Foreign`](https://hackage.haskell.org/package/base/docs/Foreign.html) must be used when
 getting results from C, like `CInt` in favour of `Int`.
-  Example: 
+  Example:
   - ❌ `foreign export ccall sodium_init :: IO Int`
 
   - ✅ `foreign import capi "sodium.h sodium_init"  c_sodium_init :: IO CInt`
@@ -28,14 +28,12 @@ We have a git hook in place to ensure the following formatting and linting tools
 are being used:
 
 * All Haskell source files are formatted with
-  [`fourmolu`](https://hackage.haskell.org/package/fourmolu);
-* All Haskell source files are linted with 
-  [HLint](https://hackage.haskell.org/package/hlint), as per the `.hlint.yaml` 
+  [`fourmolu`](https://flora.pm/packages/@hackage/fourmolu/0.17.0.0) v0.17.0.0;
+* All Haskell source files are linted with
+  [`hlint` v3.8](https://flora.pm/packages/@hackage/hlint/3.8), as per the `.hlint.yaml`
   configuration file.
 * The Cabal file is formatted with
-  [`cabal-fmt`](https://github.com/phadej/cabal-fmt)
-
-Check the version of these tools in https://github.com/haskell-cryptography/libsodium-bindings/blob/main/.github/workflows/linting.yml.
+  [`cabal-gild` v1.5.0.1](https://flora.pm/packages/@hackage/cabal-gild/1.5.0.1)
 
 To ensure that you are using the git hook, run the following, once:
 
@@ -45,7 +43,7 @@ git config core.hooksPath .githooks
 
 You can also use the provided `Makefile` by running `make init`.
 
-### Questions 
+### Questions
 
 Open a thread in the [Questions][Questions board] discussion board. That way,
 you can get help from everyone in the community.

Makefile

@@ -23,7 +23,8 @@ lint: ## Run the code linter (HLint)
 	@find sel libsodium-bindings -name "*.hs" | xargs -P $(PROCS) -I {} hlint --refactor-options="-i" --refactor {}
 
 style: ## Run the code formatter (fourmolu, cabal-fmt)
-	@cabal-fmt -i **/**.cabal
+	@cabal-gild --mode=format --io=libsodium-bindings/libsodium-bindings.cabal
+	@cabal-gild --mode=format --io=sel/sel.cabal
 	@fourmolu -q --mode inplace sel libsodium-bindings
 
 help: ## Display this help message

fourmolu.yaml

@@ -9,3 +9,7 @@ newlines-between-decls: 1 # number of newlines between top-level declarations
 fixities: []
 function-arrows: leading
 single-constraint-parens: never
+import-grouping: by-scope
+sort-constraints: true
+sort-derived-classes: true
+sort-deriving-clauses: true

libsodium-bindings/libsodium-bindings.cabal

@@ -1,69 +1,81 @@
-cabal-version:      3.0
-name:               libsodium-bindings
-version:            0.0.3.0
-category:           Cryptography
-synopsis:           FFI bindings to libsodium
+cabal-version: 3.0
+name: libsodium-bindings
+version: 0.0.3.0
+category: Cryptography
+synopsis: FFI bindings to libsodium
 description:
   This library embeds FFI bindings to the stable version of libsodium 1.0.18.
   The interface exposed by this library is kept close to the C library.
 
-homepage:           https://github.com/haskell-cryptography/libsodium-bindings
+homepage: https://github.com/haskell-cryptography/libsodium-bindings
 bug-reports:
   https://github.com/haskell-cryptography/libsodium-bindings/issues
 
-author:             Hécate Moonlight, Koz Ross
-maintainer:         The Haskell Cryptography contributors
-license:            BSD-3-Clause
-build-type:         Simple
+author: Hécate Moonlight, Koz Ross
+maintainer: The Haskell Cryptography contributors
+license: BSD-3-Clause
+build-type: Simple
 tested-with:
-  GHC ==9.2.8 || ==9.4.8 || ==9.6.6 || ==9.8.2 || ==9.10.1
+  ghc ==9.2.8 || ==9.4.8 || ==9.6.6 || ==9.8.2 || ==9.10.1
 
 extra-source-files:
   LICENSE
   README.md
 
-extra-doc-files:    CHANGELOG.md
+extra-doc-files: CHANGELOG.md
 
 flag pkg-config
   description: Use pkg-config to find Libsodium (macOS and linux only).
-  default:     False
-  manual:      True
+  default: False
+  manual: True
 
 flag homebrew
   description: Use Homebrew version of Libsodium (macOS only).
-  default:     False
-  manual:      True
+  default: False
+  manual: True
 
 source-repository head
-  type:     git
+  type: git
   location: https://github.com/haskell-cryptography/libsodium-bindings
 
 common common
-  build-depends:    base >=4.14 && <5
+  build-depends: base >=4.14 && <5
   ghc-options:
-    -Wall -Wcompat -Widentities -Wincomplete-record-updates
-    -Wincomplete-uni-patterns -Wpartial-fields -Wredundant-constraints
-    -fhide-source-paths -Wno-unused-do-bind
+    -Wall
+    -Wcompat
+    -Widentities
+    -Wincomplete-record-updates
+    -Wincomplete-uni-patterns
+    -Wpartial-fields
+    -Wredundant-constraints
+    -fhide-source-paths
+    -Wno-unused-do-bind
 
   if (os(osx) && flag(homebrew))
-    include-dirs:   /opt/local/include /opt/homebrew/include
-    extra-lib-dirs: /user/local/opt/libsodium/lib /opt/homebrew/lib
+    include-dirs:
+      /opt/homebrew/include
+      /opt/local/include
+
+    extra-lib-dirs:
+      /opt/homebrew/lib
+      /user/local/opt/libsodium/lib
 
   if flag(pkg-config)
     pkgconfig-depends: libsodium >=1.0.18
-
   else
     extra-libraries: sodium
 
   default-language: Haskell2010
 
 common common-rts-options
-  ghc-options: -rtsopts -threaded -with-rtsopts=-N
+  ghc-options:
+    -rtsopts
+    -threaded
+    -with-rtsopts=-N
 
 library
-  import:          common
-  hs-source-dirs:  src
-
+  import: common
+  hs-source-dirs: src
   -- cabal-fmt: expand src/
   exposed-modules:
     LibSodium.Bindings
@@ -78,12 +90,12 @@ library
     LibSodium.Bindings.Main
     LibSodium.Bindings.PasswordHashing
     LibSodium.Bindings.Random
+    LibSodium.Bindings.SHA2
     LibSodium.Bindings.Scrypt
     LibSodium.Bindings.SealedBoxes
-    LibSodium.Bindings.Secretbox
     LibSodium.Bindings.SecretStream
+    LibSodium.Bindings.Secretbox
     LibSodium.Bindings.SecureMemory
-    LibSodium.Bindings.SHA2
     LibSodium.Bindings.ShortHashing
     LibSodium.Bindings.Utils
     LibSodium.Bindings.XChaCha20

libsodium-bindings/src/LibSodium/Bindings/SealedBoxes.hs

@@ -23,6 +23,7 @@ module LibSodium.Bindings.SealedBoxes
 
 import Foreign (Ptr)
 import Foreign.C (CInt (CInt), CSize (CSize), CUChar, CULLong (CULLong))
+
 import LibSodium.Bindings.CryptoBox (cryptoBoxKeyPair, cryptoBoxSeedKeyPair)
 
 -- $introduction

libsodium-bindings/src/LibSodium/Bindings/ShortHashing.hs

@@ -35,6 +35,7 @@ module LibSodium.Bindings.ShortHashing
 import Data.Word (Word8)
 import Foreign.C (CInt (CInt), CSize (CSize), CUChar, CULLong (CULLong))
 import Foreign.Ptr (Ptr, castPtr)
+
 import LibSodium.Bindings.Random (randombytesBuf)
 
 -- | Create a secret key of size 'cryptoShortHashKeyBytes'.

sel/sel.cabal

@@ -1,59 +1,70 @@
-cabal-version:      3.0
-name:               sel
-version:            0.0.3.0
-category:           Cryptography
-synopsis:           Cryptography for the casual user
+cabal-version: 3.0
+name: sel
+version: 0.0.3.0
+category: Cryptography
+synopsis: Cryptography for the casual user
 description:
   The high-level library aimed at casual users of cryptography, by the Haskell Cryptography Group
 
-homepage:           https://github.com/haskell-cryptography/libsodium-bindings
+homepage: https://github.com/haskell-cryptography/libsodium-bindings
 bug-reports:
   https://github.com/haskell-cryptography/libsodium-bindings/issues
 
-author:             Hécate Moonlight, Koz Ross
-maintainer:         The Haskell Cryptography contributors
-license:            BSD-3-Clause
-build-type:         Simple
+author: Hécate Moonlight, Koz Ross
+maintainer: The Haskell Cryptography contributors
+license: BSD-3-Clause
+build-type: Simple
 tested-with:
-  GHC ==9.2.8 || ==9.4.8 || ==9.6.6 || ==9.8.2 || ==9.10.1
+  ghc ==9.2.8 || ==9.4.8 || ==9.6.6 || ==9.8.2 || ==9.10.1
 
 extra-source-files:
   LICENSE
   README.md
 
-extra-doc-files:    CHANGELOG.md
+extra-doc-files: CHANGELOG.md
 
 source-repository head
-  type:     git
+  type: git
   location: https://github.com/haskell-cryptography/libsodium-bindings
 
 common common
   ghc-options:
-    -Wall -Wcompat -Widentities -Wincomplete-record-updates
-    -Wincomplete-uni-patterns -Wpartial-fields -Wredundant-constraints
-    -fhide-source-paths -Wno-unused-do-bind -fshow-hole-constraints
-    -fprint-potential-instances -Wno-unticked-promoted-constructors
+    -Wall
+    -Wcompat
+    -Widentities
+    -Wincomplete-record-updates
+    -Wincomplete-uni-patterns
+    -Wpartial-fields
+    -Wredundant-constraints
+    -fhide-source-paths
+    -Wno-unused-do-bind
+    -fshow-hole-constraints
+    -fprint-potential-instances
+    -Wno-unticked-promoted-constructors
     -Werror=unused-imports
 
   default-language: Haskell2010
 
 common test-options
-  ghc-options: -rtsopts -threaded -with-rtsopts=-N
+  ghc-options:
+    -rtsopts
+    -threaded
+    -with-rtsopts=-N
 
 library
-  import:          common
-  hs-source-dirs:  src
+  import: common
+  hs-source-dirs: src
   exposed-modules:
     Sel
+    Sel.HMAC
+    Sel.HMAC.SHA256
+    Sel.HMAC.SHA512
+    Sel.HMAC.SHA512_256
     Sel.Hashing
     Sel.Hashing.Password
     Sel.Hashing.SHA256
     Sel.Hashing.SHA512
     Sel.Hashing.Short
-    Sel.HMAC
-    Sel.HMAC.SHA256
-    Sel.HMAC.SHA512
-    Sel.HMAC.SHA512_256
     Sel.PublicKey.Cipher
     Sel.PublicKey.Seal
     Sel.PublicKey.Signature
@@ -69,26 +80,26 @@ library
     Sel.Internal.Sodium
 
   build-depends:
-    , base                 >=4.14   && <5
-    , base16               ^>=1.0
-    , bytestring           >=0.10   && <0.13
-    , libsodium-bindings   ^>=0.0.2
-    , text                 >=1.2    && <2.2
-    , text-builder-linear  ^>=0.1
-    , text-display         ^>=1.0
-    , transformers         ^>=0.6.0
+    base >=4.14 && <5,
+    base16 ^>=1.0,
+    bytestring >=0.10 && <0.13,
+    libsodium-bindings ^>=0.0.2,
+    text >=1.2 && <2.2,
+    text-builder-linear ^>=0.1,
+    text-display ^>=1.0,
+    transformers ^>=0.6.0,
 
 test-suite sel-tests
-  import:         common
-  import:         test-options
-  type:           exitcode-stdio-1.0
-  main-is:        Main.hs
+  import: common
+  import: test-options
+  type: exitcode-stdio-1.0
+  main-is: Main.hs
   other-modules:
+    Test.HMAC
     Test.Hashing
     Test.Hashing.Password
     Test.Hashing.SHA2
     Test.Hashing.Short
-    Test.HMAC
     Test.PublicKey.Cipher
     Test.PublicKey.Seal
     Test.PublicKey.Signature
@@ -100,13 +111,13 @@ test-suite sel-tests
 
   hs-source-dirs: test
   build-depends:
-    , base
-    , base16
-    , bytestring
-    , hedgehog            ^>=1.4
-    , libsodium-bindings
-    , sel
-    , tasty               >=1.4   && <1.6
-    , tasty-hunit         ^>=0.10
-    , text
-    , text-display
+    base,
+    base16,
+    bytestring,
+    hedgehog ^>=1.4,
+    libsodium-bindings,
+    sel,
+    tasty >=1.4 && <1.6,
+    tasty-hunit ^>=0.10,
+    text,
+    text-display,

sel/src/Sel/HMAC/SHA256.hs

@@ -65,8 +65,6 @@ import Foreign (ForeignPtr, Ptr, Word8)
 import qualified Foreign
 import Foreign.C (CChar, CSize, CUChar, CULLong)
 import Foreign.C.Error (throwErrno)
-import System.IO.Unsafe (unsafeDupablePerformIO)
-
 import LibSodium.Bindings.SHA2
   ( CryptoAuthHMACSHA256State
   , cryptoAuthHMACSHA256
@@ -80,6 +78,8 @@ import LibSodium.Bindings.SHA2
   , cryptoAuthHMACSHA256Verify
   )
 import LibSodium.Bindings.SecureMemory (finalizerSodiumFree, sodiumMalloc)
+import System.IO.Unsafe (unsafeDupablePerformIO)
+
 import Sel.Internal (allocateWith, foreignPtrEqConstantTime, foreignPtrOrdConstantTime)
 import Sel.Internal.Sodium (binaryToHex)