feat(build): #262 lint git mailmap

- Add lintGitMailMap, docs, module, arg, etc

Author: kamadorueda

.github/workflows/dev.yml

@@ -73,6 +73,16 @@ jobs:
       name: /lintCommitMsg
       with:
         args: sh -c "nix-env -if . && m . /lintCommitMsg"
+  lintGitMailMap:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - uses: docker://docker.io/nixos/nix:2.3.12
+      name: /lintGitMailMap
+      with:
+        args: sh -c "nix-env -if . && m . /lintGitMailMap"
   lintMarkdown:
     runs-on: ubuntu-latest
     steps:

.mailmap

@@ -0,0 +1,7 @@
+Daniel Salazar <podany270895@gmail.com> Daniel Salazar <dsalaza4@eafit.edu.co>
+Daniel Salazar <podany270895@gmail.com> Daniel Salazar <dsalazar@fluidattacks.com>
+Daniel Salazar <podany270895@gmail.com> Daniel Salazar <podany270895@gmail.com>
+Fluid Attacks <help@fluidattacks.com> Fluid Attacks <help@fluidattacks.com>
+Github Octocat <noreply@github.com> GitHub <noreply@github.com>
+Kevin Amado <kamadorueda@gmail.com> Kevin Amado <kamadorueda@gmail.com>
+Luis Saavedra <lsaavedra@fluidattacks.com> Luis Saavedra <lsaavedra@fluidattacks.com>

README.md

@@ -41,6 +41,7 @@ in just a few steps, in any technology.
     - [Linters](#linters)
         - [lintBash](#lintbash)
         - [lintCommitMsg](#lintcommitmsg)
+        - [lintGitMailMap](#lintgitmailmap)
         - [lintMarkdown](#lintmarkdown)
         - [lintNix](#lintnix)
         - [lintPython](#lintpython)
@@ -748,6 +749,28 @@ Example `makes.nix`:
 
 Example invocation: `$ m . /lintCommitMsg`
 
+### lintGitMailMap
+
+Lint the [Git][GIT] [MailMap][GIT_MAILMAP] of the project
+with [MailMap Linter][MAILMAP_LINTER].
+
+Attributes:
+
+- enable (`boolean`): Optional.
+  Defaults to false.
+
+Example `makes.nix`:
+
+```nix
+{
+  lintGitMailMap = {
+    enable = true;
+  };
+}
+```
+
+Example invocation: `$ m . /lintGitMailMap`
+
 ### lintMarkdown
 
 Lints Markdown code with [Markdown lint tool][MARKDOWN_LINT].
@@ -1695,6 +1718,12 @@ $ m . /example
 - [FLUID_ATTACKS]: https://fluidattacks.com
   [Fluid Attacks][FLUID_ATTACKS]
 
+- [GIT]: https://git-scm.com/
+  [Git][GIT]
+
+- [GIT_MAILMAP]: https://git-scm.com/docs/gitmailmap
+  [Git Mailmap][GIT_MAILMAP]
+
 - [GITHUB_ACTIONS]: https://github.com/features/actions
   [Github Actions][GITHUB_ACTIONS]
 
@@ -1740,6 +1769,9 @@ $ m . /example
 - [LIZARD]: https://github.com/terryyin/lizard
   [Lizard][LIZARD]
 
+- [MAILMAP_LINTER]: https://github.com/kamadorueda/mailmap-linter
+  [Mailmap Linter][MAILMAP_LINTER]
+
 - [MAKES]: https://github.com/fluidattacks/makes
   [Makes][MAKES]
 

makes.nix

@@ -62,6 +62,9 @@
     enable = true;
     branch = "main";
   };
+  lintGitMailMap = {
+    enable = true;
+  };
   lintMarkdown = {
     enable = true;
     targets = [ "/" ];

src/args/default.nix

@@ -15,13 +15,15 @@ let
     asContent = import ./as-content/default.nix;
     deployContainerImage = import ./deploy-container-image/default.nix args;
     fakeSha256 = lib.fakeSha256;
+    fetchGithub = import ./fetchers/github.nix args;
     fetchNixpkgs = import ./fetchers/nixpkgs.nix args;
     fetchUrl = import ./fetchers/url.nix args;
     fetchZip = import ./fetchers/zip.nix args;
     formatBash = import ./format-bash args;
     formatTerraform = import ./format-terraform args;
     getAttr = import ./get-attr/default.nix;
     inherit inputs;
+    lintGitMailMap = import ./lint-git-mailmap/default.nix args;
     lintTerraform = import ./lint-terraform/default.nix args;
     makeContainerImage = import ./make-container-image/default.nix args;
     makeDerivation = import ./make-derivation/default.nix args;

src/args/lint-git-mailmap/default.nix

@@ -0,0 +1,28 @@
+{ fetchGithub
+, makeScript
+, ...
+}:
+{ name
+, src
+, ...
+}:
+let
+  mailmapLinter = fetchGithub {
+    owner = "kamadorueda";
+    repo = "mailmap-linter";
+    rev = "5ae9d2654375afb76dfb3087b1e9b200257331a2";
+    sha256 = "124pka1mf25mwlzip3fa66l73zc3x0zmba5vkd7p7c521hz9xphi";
+  };
+in
+makeScript {
+  entrypoint = ./entrypoint.sh;
+  replace = {
+    __argSrc__ = src;
+  };
+  name = "lint-git-mailmap-for-${name}";
+  searchPaths = {
+    bin = [
+      (import mailmapLinter)
+    ];
+  };
+}

src/args/lint-git-mailmap/entrypoint.sh

@@ -0,0 +1,8 @@
+# shellcheck shell=bash
+
+function main {
+  cd '__argSrc__' \
+    && mailmap-linter
+}
+
+main "${@}"

src/evaluator/modules/outputs/builtins/default.nix

@@ -11,6 +11,7 @@ args:
     (import ./hello-world/default.nix args)
     (import ./lint-bash/default.nix args)
     (import ./lint-commit-msg/default.nix args)
+    (import ./lint-git-mailmap/default.nix args)
     (import ./lint-markdown/default.nix args)
     (import ./lint-nix/default.nix args)
     (import ./lint-python/default.nix args)

src/evaluator/modules/outputs/builtins/lint-git-mailmap/default.nix

@@ -0,0 +1,25 @@
+{ lintGitMailMap
+, pathImpure
+, ...
+}:
+{ lib
+, ...
+}:
+{
+  options = {
+    lintGitMailMap = {
+      enable = lib.mkOption {
+        default = false;
+        type = lib.types.bool;
+      };
+    };
+  };
+  config = {
+    outputs = {
+      "/lintGitMailMap" = lintGitMailMap {
+        name = "lint-git-mailmap";
+        src = pathImpure "/";
+      };
+    };
+  };
+}