Use treefmt to nixpkgs-fmt all .nix files

.github/workflows/ci.yml

@@ -4,6 +4,25 @@ on:
    branches: [master, develop]
 
 jobs:
+  treefmt:
+   name: Run treefmt
+   environment: cachix # for secrets
+   runs-on: ubuntu-latest
+   steps:
+     - uses: actions/checkout@v2
+       with:
+         submodules: true
+     - uses: cachix/install-nix-action@v14.1
+     - uses: cachix/cachix-action@v10
+       with:
+         name: wire-server
+         signingKey: '${{ secrets.CACHIX_SIGNING_KEY }}'
+         authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
+     - name: Install treefmt and nixpkgs-fmt (without pulling in all of dev-env)
+       run: nix-env -if nix/default.nix -iA pkgs.treefmt pkgs.nixpkgs-fmt pkgs.shellcheck
+     - name: Run treefmt
+       run: treefmt
+
   build-docs:
     name: Build docs
     environment: cachix

Makefile

@@ -108,7 +108,7 @@ ghcid:
 
 # Used by CI
 .PHONY: lint-all
-lint-all: formatc hlint-check-all shellcheck check-local-nix-derivations
+lint-all: formatc hlint-check-all check-local-nix-derivations treefmt
 
 .PHONY: hlint-check-all
 hlint-check-all:
@@ -171,9 +171,9 @@ add-license:
 	@echo ""
 	@echo "you might want to run 'make formatf' now to make sure ormolu is happy"
 
-.PHONY: shellcheck
-shellcheck:
-	./hack/bin/shellcheck.sh
+.PHONY: treefmt
+treefmt:
+	treefmt
 
 #################################
 ## docker targets

changelog.d/5-internal/treefmt

@@ -0,0 +1 @@
+Use treefmt to ensure consistent formatting of .nix files, use for shellcheck too (#2831)

hack/bin/generate-local-nix-packages.sh

@@ -21,7 +21,7 @@ echo "$cabalFiles" \
 
 # shellcheck disable=SC2016
 echo "$cabalFiles" \
-    | xargs -I {} bash -c 'cd $(dirname {}); cabal2nix . --no-hpack --extra-arguments gitignoreSource | sed "s/.\/./gitignoreSource .\/./g" >> default.nix'
+    | xargs -I {} bash -c 'cd $(dirname {}); cabal2nix . --no-hpack --extra-arguments gitignoreSource | sed "s/.\/./gitignoreSource .\/./g" >> default.nix; nixpkgs-fmt default.nix &> /dev/null'
 
 overridesFile="$ROOT_DIR/nix/local-haskell-packages.nix"
 
@@ -30,3 +30,6 @@ cat "$warningFile" <(echo "{ gitignoreSource }: hsuper: hself: {") > "$overrides
 echo "$cabalFiles" \
     | xargs -I {} bash -c 'name=$(basename {} | sed "s|.cabal||"); echo "  $name = hself.callPackage $(realpath --relative-to='"$ROOT_DIR/nix"' "$(dirname {})")/default.nix { inherit gitignoreSource; };"' >> "$overridesFile"
 echo "}" >> "$overridesFile"
+
+# ensure the file is formatted
+nixpkgs-fmt "$overridesFile" &> /dev/null

libs/api-bot/default.nix

@@ -2,27 +2,89 @@
 # This file is generated by running hack/bin/generate-local-nix-packages.sh and
 # must be regenerated whenever local packages are added or removed, or
 # dependencies are added or removed.
-{ mkDerivation, aeson, ansi-terminal, api-client, async, attoparsec
-, base, base64-bytestring, bilge, bytestring, bytestring-conversion
-, cereal, containers, cryptobox-haskell, cryptonite, exceptions
-, filepath, gitignoreSource, HaskellNet, HaskellNet-SSL
-, http-client, imports, iso639, lib, memory, metrics-core, mime
-, monad-control, mwc-random, optparse-applicative, resource-pool
-, stm, text, time, tinylog, transformers-base, types-common
-, unordered-containers, uuid, vector
+{ mkDerivation
+, aeson
+, ansi-terminal
+, api-client
+, async
+, attoparsec
+, base
+, base64-bytestring
+, bilge
+, bytestring
+, bytestring-conversion
+, cereal
+, containers
+, cryptobox-haskell
+, cryptonite
+, exceptions
+, filepath
+, gitignoreSource
+, HaskellNet
+, HaskellNet-SSL
+, http-client
+, imports
+, iso639
+, lib
+, memory
+, metrics-core
+, mime
+, monad-control
+, mwc-random
+, optparse-applicative
+, resource-pool
+, stm
+, text
+, time
+, tinylog
+, transformers-base
+, types-common
+, unordered-containers
+, uuid
+, vector
 }:
 mkDerivation {
   pname = "api-bot";
   version = "0.4.2";
   src = gitignoreSource ./.;
   libraryHaskellDepends = [
-    aeson ansi-terminal api-client async attoparsec base
-    base64-bytestring bilge bytestring bytestring-conversion cereal
-    containers cryptobox-haskell cryptonite exceptions filepath
-    HaskellNet HaskellNet-SSL http-client imports iso639 memory
-    metrics-core mime monad-control mwc-random optparse-applicative
-    resource-pool stm text time tinylog transformers-base types-common
-    unordered-containers uuid vector
+    aeson
+    ansi-terminal
+    api-client
+    async
+    attoparsec
+    base
+    base64-bytestring
+    bilge
+    bytestring
+    bytestring-conversion
+    cereal
+    containers
+    cryptobox-haskell
+    cryptonite
+    exceptions
+    filepath
+    HaskellNet
+    HaskellNet-SSL
+    http-client
+    imports
+    iso639
+    memory
+    metrics-core
+    mime
+    monad-control
+    mwc-random
+    optparse-applicative
+    resource-pool
+    stm
+    text
+    time
+    tinylog
+    transformers-base
+    types-common
+    unordered-containers
+    uuid
+    vector
   ];
   description = "(Internal) API automation around wire-client";
   license = lib.licenses.agpl3Only;

libs/api-client/default.nix

@@ -2,22 +2,67 @@
 # This file is generated by running hack/bin/generate-local-nix-packages.sh and
 # must be regenerated whenever local packages are added or removed, or
 # dependencies are added or removed.
-{ mkDerivation, aeson, async, base, bilge, bytestring
-, bytestring-conversion, connection, cookie, data-default-class
-, errors, exceptions, gitignoreSource, http-client, http-types
-, imports, lib, mime, retry, text, time, tinylog, transformers
-, types-common, unliftio, unordered-containers, uuid, websockets
+{ mkDerivation
+, aeson
+, async
+, base
+, bilge
+, bytestring
+, bytestring-conversion
+, connection
+, cookie
+, data-default-class
+, errors
+, exceptions
+, gitignoreSource
+, http-client
+, http-types
+, imports
+, lib
+, mime
+, retry
+, text
+, time
+, tinylog
+, transformers
+, types-common
+, unliftio
+, unordered-containers
+, uuid
+, websockets
 , wire-api
 }:
 mkDerivation {
   pname = "api-client";
   version = "0.4.2";
   src = gitignoreSource ./.;
   libraryHaskellDepends = [
-    aeson async base bilge bytestring bytestring-conversion connection
-    cookie data-default-class errors exceptions http-client http-types
-    imports mime retry text time tinylog transformers types-common
-    unliftio unordered-containers uuid websockets wire-api
+    aeson
+    async
+    base
+    bilge
+    bytestring
+    bytestring-conversion
+    connection
+    cookie
+    data-default-class
+    errors
+    exceptions
+    http-client
+    http-types
+    imports
+    mime
+    retry
+    text
+    time
+    tinylog
+    transformers
+    types-common
+    unliftio
+    unordered-containers
+    uuid
+    websockets
+    wire-api
   ];
   description = "(Internal) Wire HTTP API Client";
   license = lib.licenses.agpl3Only;

libs/bilge/default.nix

@@ -2,21 +2,59 @@
 # This file is generated by running hack/bin/generate-local-nix-packages.sh and
 # must be regenerated whenever local packages are added or removed, or
 # dependencies are added or removed.
-{ mkDerivation, aeson, ansi-terminal, base, bytestring
-, case-insensitive, cookie, errors, exceptions, gitignoreSource
-, http-client, http-types, imports, lens, lib, monad-control, mtl
-, text, tinylog, transformers-base, types-common, unliftio
-, uri-bytestring, wai, wai-extra
+{ mkDerivation
+, aeson
+, ansi-terminal
+, base
+, bytestring
+, case-insensitive
+, cookie
+, errors
+, exceptions
+, gitignoreSource
+, http-client
+, http-types
+, imports
+, lens
+, lib
+, monad-control
+, mtl
+, text
+, tinylog
+, transformers-base
+, types-common
+, unliftio
+, uri-bytestring
+, wai
+, wai-extra
 }:
 mkDerivation {
   pname = "bilge";
   version = "0.22.0";
   src = gitignoreSource ./.;
   libraryHaskellDepends = [
-    aeson ansi-terminal base bytestring case-insensitive cookie errors
-    exceptions http-client http-types imports lens monad-control mtl
-    text tinylog transformers-base types-common unliftio uri-bytestring
-    wai wai-extra
+    aeson
+    ansi-terminal
+    base
+    bytestring
+    case-insensitive
+    cookie
+    errors
+    exceptions
+    http-client
+    http-types
+    imports
+    lens
+    monad-control
+    mtl
+    text
+    tinylog
+    transformers-base
+    types-common
+    unliftio
+    uri-bytestring
+    wai
+    wai-extra
   ];
   description = "Library for composing HTTP requests";
   license = lib.licenses.agpl3Only;