flake: fmt, comments, renames

Author: Sk7Str1p3

flake.nix

@@ -1,11 +1,11 @@
 {
-  description = "Git repository summary on your terminal";
+  description = ''
+    Git repository summary on your terminal
+  '';
 
   inputs = {
     nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
-
     crane.url = "github:ipetkov/crane";
-
     flake-utils.url = "github:numtide/flake-utils";
 
     advisory-db = {
@@ -14,8 +14,17 @@
     };
   };
 
-  outputs = { self, nixpkgs, crane, flake-utils, advisory-db, ... }:
-    flake-utils.lib.eachDefaultSystem (system:
+  outputs =
+    {
+      self,
+      nixpkgs,
+      crane,
+      flake-utils,
+      advisory-db,
+      ...
+    }:
+    flake-utils.lib.eachDefaultSystem (
+      system:
       let
         pkgs = nixpkgs.legacyPackages.${system};
 
@@ -25,78 +34,89 @@
         src = ./.;
 
         # Common arguments can be set here to avoid repeating them later
-        commonArgs = {
+        common = {
           inherit src;
           strictDeps = true;
 
-          buildInputs = with pkgs;
+          # Bunch of libraries required for package proper work
+          buildInputs =
+            with pkgs;
             [
               # package dependencies
               zstd
-            ] ++ lib.optionals pkgs.stdenv.isDarwin (with pkgs; [
+            ]
+            ++ lib.optionals pkgs.stdenv.isDarwin (
+              with pkgs;
+              [
               # additional dependencies on Darwin systems
               CoreFoundation
               libresolv
               Security
-            ]);
-          nativeBuildInputs = with pkgs; [ cmake pkg-config ];
+              ]
+            );
+          # Software required for project build
+          nativeBuildInputs = with pkgs; [
+            cmake
+            pkg-config
+          ];
+          # Tools required for checks
           nativeCheckInputs = with pkgs; [ git ];
 
           # Additional environment variables can be set directly
           # MY_CUSTOM_VAR = "some value";
         };
 
-        # Build *just* the cargo dependencies, so we can reuse
-        # all of that work (e.g. via cachix) when running in CI
-        cargoArtifacts = craneLib.buildDepsOnly commonArgs;
+        # Build dependencies only, so we will be able to reuse them further
+        cargoArtifacts = craneLib.buildDepsOnly common;
 
         # Build the actual crate itself, reusing the dependency
         # artifacts from above.
-        onefetch =
-          craneLib.buildPackage (commonArgs // { inherit cargoArtifacts; });
-      in {
+        build = craneLib.buildPackage (common // { inherit cargoArtifacts; });
+      in
+      {
         checks = {
           # Build the crate as part of `nix flake check` for convenience
-          inherit onefetch;
+          inherit build;
 
           # Run clippy (and deny all warnings) on the crate source,
           # again, reusing the dependency artifacts from above.
-          #
-          # Note that this is done as a separate derivation so that
-          # we can block the CI if there are issues here, but not
-          # prevent downstream consumers from building our crate by itself.
-          onefetch-clippy = craneLib.cargoClippy (commonArgs // {
+          clippy = craneLib.cargoClippy (
+            common
+            // {
             inherit cargoArtifacts;
             cargoClippyExtraArgs = "--all-targets -- --deny warnings";
-          });
+            }
+          );
 
-          onefetch-doc =
-            craneLib.cargoDoc (commonArgs // { inherit cargoArtifacts; });
+          doc = craneLib.cargoDoc (common // { inherit cargoArtifacts; });
 
           # Check formatting
-          onefetch-fmt = craneLib.cargoFmt { inherit src; };
+          fmt = craneLib.cargoFmt { inherit src; };
 
-          onefetch-toml-fmt = craneLib.taploFmt {
+          tomlFmt = craneLib.taploFmt {
             src = pkgs.lib.sources.sourceFilesBySuffices src [ ".toml" ];
             # taplo arguments can be further customized below as needed
             # taploExtraArgs = "--config ./taplo.toml";
           };
 
           # Audit dependencies
-          onefetch-audit = craneLib.cargoAudit { inherit src advisory-db; };
+          audit = craneLib.cargoAudit { inherit src advisory-db; };
 
           # Audit licenses
-          onefetch-deny = craneLib.cargoDeny { inherit src; };
+          deny = craneLib.cargoDeny { inherit src; };
 
           # Run tests with cargo-nextest
           # Consider setting `doCheck = false` on `my-crate` if you do not want
           # the tests to run twice
-          onefetch-nextest = craneLib.cargoNextest (commonArgs // {
+          nextest = craneLib.cargoNextest (
+            common
+            // {
             inherit cargoArtifacts;
             partitions = 1;
             partitionType = "count";
             cargoNextestPartitionsExtraArgs = "--no-tests=pass";
-          });
+            }
+          );
         };
 
         packages = rec {
@@ -110,7 +130,7 @@
           default = onefetch-debug;
         };
 
-        apps.default = flake-utils.lib.mkApp { drv = onefetch; };
+        apps.default = flake-utils.lib.mkApp { drv = build; };
 
         devShells.default = craneLib.devShell {
           # Inherit inputs from checks.
@@ -123,14 +143,17 @@
           packages = with pkgs; [
             # pkgs.ripgrep
             nixd
-            nixfmt
+            nixfmt-rfc-style
           ];
         };
-      });
+      }
+    );
   # Sets substituters to avoid locally building something already built
   nixConfig = {
-    extra-substituters =
-      [ "https://crane.cachix.org" "https://cache.garnix.io" ];
+    extra-substituters = [
+      "https://crane.cachix.org"
+      "https://cache.garnix.io"
+    ];
     extra-trusted-public-keys = [
       "crane.cachix.org-1:8Scfpmn9w+hGdXH/Q9tTLiYAE/2dnJYRJP7kl80GuRk="
       "cache.garnix.io:CTFPyKSLcx5RMJKfLo5EEPUObbA78b0YQ2DTCJXqr9g="