Add taploFmt TOML format function to mkLib

CHANGELOG.md

@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+### Added
+* `taploFmt` is now available for checking TOML formatting
+
 ### Changed
 * **Breaking** (technically): `buildPackage` no longer adds `jq` to
   `nativeBuildInputs` as doing so can result in rebuilding any `*-sys` crates

docs/API.md

@@ -538,6 +538,40 @@ environment variables during the build, you can bring them back via
 * `cargoExtraArgs`
 * `rustFmtExtraArgs`
 
+### `craneLib.taploFmt`
+
+`taploFmt :: set -> drv`
+
+Create a derivation which will run a `taplo fmt` invocation in a cargo
+workspace.
+
+Except where noted below, all derivation attributes are delegated to
+`mkCargoDerivation`, and can be used to influence its behavior.
+* `buildPhaseCargoCommand` will be set to run `taplo fmt` (in check mode) in the
+  workspace.
+* `cargoArtifacts` is disabled/cleared
+* `cargoVendorDir` is disabled/cleared
+* `pnameSuffix` will be set to `"-tomlfmt"`
+
+#### Optional attributes
+* `taploExtraArgs`: additional flags to be passed in the taplo invocation
+  - Default value: `""`
+
+`taplo` command line options for setting `taploExtraArgs` and configuration options
+for `taplo.toml` config files can be found in the _Command Line_ and _Configuration_
+sections of the [taplo documentation](https://taplo.tamasfe.dev/).
+
+#### Native build dependencies
+The `taplo` package is automatically appended as a native build input to any
+other `nativeBuildInputs` specified by the caller.
+
+#### Remove attributes
+The following attributes will be removed before being lowered to
+`mkCargoDerivation`. If you absolutely need these attributes present as
+environment variables during the build, you can bring them back via
+`.overrideAttrs`.
+* `taploExtraArgs`
+
 ### `craneLib.cargoLlvmCov`
 
 `cargoLlvmCov :: set -> drv`

examples/quick-start-workspace/.config/hakari.toml

@@ -15,9 +15,9 @@ resolver = "2"
 # Add triples corresponding to platforms commonly used by developers here.
 # https://doc.rust-lang.org/rustc/platform-support.html
 platforms = [
-    # "x86_64-unknown-linux-gnu",
-    # "x86_64-apple-darwin",
-    # "x86_64-pc-windows-msvc",
+  # "x86_64-unknown-linux-gnu",
+  # "x86_64-apple-darwin",
+  # "x86_64-pc-windows-msvc",
 ]
 
 # Write out exact versions rather than a semver range. (Defaults to false.)

examples/quick-start-workspace/Cargo.toml

@@ -1,9 +1,6 @@
 [workspace]
 resolver = "2"
-members = [
-  "my-*",
-  "my-workspace-hack",
-]
+members = ["my-*", "my-workspace-hack"]
 
 [workspace.package]
 version = "0.1.0"

examples/quick-start-workspace/deny.toml

@@ -3,9 +3,4 @@ multiple-versions = 'allow'
 
 [licenses]
 private = { ignore = true }
-allow = [
-  "Apache-2.0",
-  "BSD-3-Clause",
-  "MIT",
-  "Unicode-DFS-2016",
-]
+allow = ["Apache-2.0", "BSD-3-Clause", "MIT", "Unicode-DFS-2016"]

examples/quick-start-workspace/flake.nix

@@ -120,6 +120,12 @@
             inherit src;
           };
 
+          my-workspace-toml-fmt = craneLib.taploFmt {
+            src = pkgs.lib.sources.sourceFilesBySuffices src [ ".toml" ];
+            # taplo arguments can be further customized below as needed
+            # taploExtraArgs = "--config ./taplo.toml";
+          };
+
           # Audit dependencies
           my-workspace-audit = craneLib.cargoAudit {
             inherit src advisory-db;

examples/quick-start-workspace/taplo.toml

@@ -0,0 +1,13 @@
+# Sorts `Cargo.toml` dependencies. All other `.toml` files are formatted with the default config.
+#
+# https://taplo.tamasfe.dev/configuration/file.html#configuration-file
+
+[formatting]
+reorder_keys = false
+
+[[rule]]
+include = ["**/Cargo.toml"]
+keys = ["dependencies"]
+
+[rule.formatting]
+reorder_keys = true

examples/quick-start/deny.toml

@@ -1,4 +1,2 @@
 [licenses]
-allow = [
-  "MIT"
-]
+allow = ["MIT"]

examples/quick-start/flake.nix

@@ -91,6 +91,12 @@
             inherit src;
           };
 
+          my-crate-toml-fmt = craneLib.taploFmt {
+            src = pkgs.lib.sources.sourceFilesBySuffices src [ ".toml" ];
+            # taplo arguments can be further customized below as needed
+            # taploExtraArgs = "--config ./taplo.toml";
+          };
+
           # Audit dependencies
           my-crate-audit = craneLib.cargoAudit {
             inherit src advisory-db;

examples/quick-start/taplo.toml

@@ -0,0 +1,13 @@
+# Sorts `Cargo.toml` dependencies. All other `.toml` files are formatted with the default config.
+#
+# https://taplo.tamasfe.dev/configuration/file.html#configuration-file
+
+[formatting]
+reorder_keys = false
+
+[[rule]]
+include = ["**/Cargo.toml"]
+keys = ["dependencies"]
+
+[rule.formatting]
+reorder_keys = true

flake.nix

@@ -162,6 +162,7 @@
             mdbook
             nix-eval-jobs
             nixpkgs-fmt
+            taplo
           ];
         };
       });

lib/default.nix

@@ -119,6 +119,7 @@ let
       registryFromSparse = callPackage ./registryFromSparse.nix { };
       removeReferencesToVendoredSourcesHook = callPackage ./setupHooks/removeReferencesToVendoredSources.nix { };
       replaceCargoLockHook = callPackage ./setupHooks/replaceCargoLockHook.nix { };
+      taploFmt = callPackage ./taploFmt.nix { };
       urlForCargoPackage = callPackage ./urlForCargoPackage.nix { };
       vendorCargoDeps = callPackage ./vendorCargoDeps.nix { };
       vendorMultipleCargoDeps = callPackage ./vendorMultipleCargoDeps.nix { };

lib/taploFmt.nix

@@ -0,0 +1,24 @@
+{ taplo
+, mkCargoDerivation
+}:
+
+{ taploExtraArgs ? ""
+, ...
+}@origArgs:
+let
+  args = builtins.removeAttrs origArgs [ "taploExtraArgs" ];
+in
+mkCargoDerivation (args // {
+  cargoArtifacts = null;
+  cargoVendorDir = null;
+  pnameSuffix = "-tomlfmt";
+
+  buildPhaseCargoCommand = "taplo fmt --check ${taploExtraArgs}";
+
+  nativeBuildInputs = (args.nativeBuildInputs or [ ]) ++ [ taplo ];
+
+  preInstallPhases = [ "ensureTargetDir" ] ++ (args.preInstallPhases or [ ]);
+  ensureTargetDir = ''
+    mkdir -p ''${CARGO_TARGET_DIR:-target}
+  '';
+})