about summary refs log tree commit diff stats
path: root/modules/by-name/gi
diff options
context:
space:
mode:
authorBenedikt Peetz <benedikt.peetz@b-peetz.de>2024-10-24 18:21:22 +0200
committerBenedikt Peetz <benedikt.peetz@b-peetz.de>2024-10-24 18:21:22 +0200
commit7adbf27b250833d5fc3751d4d348037b24e30442 (patch)
tree25e54bb63acbd280c2d8f327f554ded8bf4e78cb /modules/by-name/gi
parentfeat(modules/unison): Auto-ignore all symlinks made with `home.file` (diff)
downloadnixos-config-7adbf27b250833d5fc3751d4d348037b24e30442.tar.gz
nixos-config-7adbf27b250833d5fc3751d4d348037b24e30442.zip
refactor(modules/git): Migrate and parameterize
Diffstat (limited to 'modules/by-name/gi')
-rw-r--r--modules/by-name/gi/git/aliases.nix82
-rw-r--r--modules/by-name/gi/git/git_ignore.git4
-rw-r--r--modules/by-name/gi/git/git_template.git66
-rw-r--r--modules/by-name/gi/git/module.nix114
4 files changed, 266 insertions, 0 deletions
diff --git a/modules/by-name/gi/git/aliases.nix b/modules/by-name/gi/git/aliases.nix
new file mode 100644
index 00000000..96456bea
--- /dev/null
+++ b/modules/by-name/gi/git/aliases.nix
@@ -0,0 +1,82 @@
+{
+  lib,
+  defaultBranchName,
+}: {
+  cmr = "commit --file .git/COMMIT_EDITMSG --edit --verbose";
+
+  st = "status";
+  sts = "status --short --branch";
+
+  ds = "diff --staged";
+  di = "diff";
+  rs = "restore --staged";
+
+  ## Logging:
+  ls = "log --max-count=10 --color --format=format:'%C(bold red)%h%C(reset) %C(dim bold blue)%s%C(reset) %C(dim white)[%aN] %C(bold red)<%G?>%C(reset)%C(auto)%d%C(reset)'";
+
+  # https://stackoverflow.com/a/61487052
+  lg = "lg1";
+  lg1 = "lg1-specific --all";
+  lg2 = "lg2-specific --all";
+  lg3 = "lg3-specific --all";
+
+  lg1-specific = "log --graph --abbrev-commit --decorate \
+                      --format=format:'%C(bold blue)%h%C(reset) - %C(bold green)(%ar)%C(reset) %C(white)%s%C(reset) %C(dim white)- %an%C(reset)%C(bold cyan) [%G?]%C(reset)%C(auto)%d%C(reset)'";
+
+  lg2-specific = "log --graph --abbrev-commit --decorate \
+                      --format=format:'%C(bold blue)%h%C(reset) - %C(bold cyan)%aD%C(reset) %C(bold green)(%ar)%C(reset)%C(auto)%d%C(reset)%n''          %C(white)%s%C(reset) %C(dim white)- %an%C(reset)'";
+
+  lg3-specific = "log --graph --abbrev-commit --decorate \
+                      --format=format:'%C(bold blue)%h%C(reset)\
+                      - %C(bold cyan)%aD%C(reset) %C(bold green)(%ar)%C(reset)\
+                      %C(bold cyan)(committed: %cD)%C(reset) %C(auto)%d%C(reset)\
+                      %C(bold red)(signature: %G? by %GS, trust: %GT)%C(reset)%n\
+                      ''          %C(white)%s%C(reset)%n''\
+                      %C(dim white)- %an <%ae> %C(reset) %C(dim white)(committer: %cn <%ce>)%C(reset)\
+                      %C(bold white)- trailers: %(trailers) %C(reset)'";
+
+  # hard reset with commit before (use reflog to recover)
+  #    git wipe [<commit>]
+  wipe = lib.strings.concatStringsSep " " [
+    "!git"
+    "add"
+    "--all"
+    "&&"
+    "git"
+    "commit"
+    "--quiet"
+    "--message='WIPE-SAVEPOINT'"
+    "--no-gpg-sign"
+    "&&"
+    "git reset \${1:-HEAD~} --hard"
+    "&&"
+    "git clean -fd"
+  ];
+
+  branches = lib.strings.concatStringsSep " " [
+    "!git"
+    "for-each-ref"
+    "--sort=-committerdate"
+    "--color=always"
+    "--format='${
+      lib.strings.concatStringsSep "|" [
+        "%(color:blue)%(authordate:relative)"
+        "%(color:red)%(authorname)"
+        "%(color:green)%(color:bold)%(refname:short)"
+      ]
+    }'"
+    "refs/remotes"
+    "|"
+    "column -ts'|' -o '   '"
+  ];
+
+  tags = "tag --list";
+
+  remotes = "remote --verbose";
+
+  day = "!git log --stat --since '1 day ago' --author $(git config user.email)";
+
+  unpush = "push --force-with-lease origin HEAD~1:${defaultBranchName}";
+
+  wip = "!git add . && git commit --amend && git push --force-with-lease";
+}
diff --git a/modules/by-name/gi/git/git_ignore.git b/modules/by-name/gi/git/git_ignore.git
new file mode 100644
index 00000000..8f29815e
--- /dev/null
+++ b/modules/by-name/gi/git/git_ignore.git
@@ -0,0 +1,4 @@
+# default nvim Session file name
+Session.vim
+
+# vim: ft=gitignore
diff --git a/modules/by-name/gi/git/git_template.git b/modules/by-name/gi/git/git_template.git
new file mode 100644
index 00000000..6af39119
--- /dev/null
+++ b/modules/by-name/gi/git/git_template.git
@@ -0,0 +1,66 @@
+
+# Title: Summary, imperative, start upper case, don't end with a period
+# If applied, this commit will <your Title>
+
+# Body: Explain *what* and *why* (not *how*).
+
+
+# BREAKING CHANGE: <description>
+# Fixes: #
+# Refs: #
+# Co-authored-by: <name> <email>
+
+
+
+# Convention Commits (https://www.conventionalcommits.org/en/v1.0.0/ or https://github.com/angular/angular/blob/85b4941be137a2fcdc664dc870e408dd72ad7de7/CONTRIBUTING.md#commit):
+#  feat: [Features] -> MINOR version bump
+#      A new feature
+#
+#  fix: [Bug Fixes] -> PATCH version bump
+#      A bug fix
+#
+#  append '!' after the type/scope: [Breaking Change] -> MAJOR version bump
+#      A breaking API change
+#
+#  docs: [Documentation]
+#      Documentation only changes
+#
+#  style: [Styles]
+#      Changes that do not affect the meaning of the code
+#      (white-space, formatting, missing semi-colons, etc)
+#
+#  refactor: [Code Refactoring]
+#      A code change that neither fixes a bug nor adds a feature
+#
+#  perf: [Performance Improvements] -> PATCH version bump
+#      A code change that improves performance
+#
+#  test: [Tests]
+#      Adding missing tests or correcting existing tests
+#
+#  build: [Builds] -> PATCH version bump
+#      Changes that affect the build system or external dependencies
+#      (example scopes: gulp, broccoli, npm)
+#
+#  ci: [Continuous Integrations]
+#      Changes to our CI configuration files and scripts
+#      (example scopes: Travis, Circle, BrowserStack, SauceLabs)
+#
+#  chore: [Chores]
+#      Other changes that don't modify src or test files
+#
+#  reverts: [Reverts]
+#      Reverts a previous commit
+
+# How to Write a Git Commit Message:
+# [https://chris.beams.io/posts/git-commit/] -> https://cbea.ms/git-commit/
+#
+# 1. Separate subject from body with a blank line
+# 2. Limit the subject line to 50 characters
+# 3. Capitalize the subject line
+# 4. Do not end the subject line with a period
+# 5. Use the imperative mood in the subject line
+# 6. Wrap the body at 72 characters
+# 7. Use the body to explain *what* and *why* vs. *how*
+#
+# vim: ft=gitcommit
diff --git a/modules/by-name/gi/git/module.nix b/modules/by-name/gi/git/module.nix
new file mode 100644
index 00000000..8e413e8a
--- /dev/null
+++ b/modules/by-name/gi/git/module.nix
@@ -0,0 +1,114 @@
+{
+  lib,
+  config,
+  ...
+}: let
+  cfg = config.soispha.programs.git;
+
+  gitIgnoreFile = ./git_ignore.git;
+  gitTemplateFile = ./git_template.git;
+in {
+  options.soispha.programs.git = {
+    enable = lib.mkEnableOption "an opinionated git config";
+    defaultBranchName = lib.mkOption {
+      type = lib.types.str;
+      description = "The Name of the default branch.";
+      default = "prime";
+    };
+  };
+
+  config = lib.mkIf cfg.enable {
+    home-manager.users.soispha = {
+      programs.git = {
+        enable = true;
+        #package = pkgs.gitAndTools.gitFull; # TODO: for git send-email support
+        aliases = import ./aliases.nix {
+          inherit lib;
+          inherit (cfg) defaultBranchName;
+        };
+        extraConfig = {
+          core = {
+            excludesFile = "${gitIgnoreFile}";
+          };
+          rebase = {
+            autoStash = true;
+            autoSquash = true;
+          };
+          init = {
+            defaultBranch = cfg.defaultBranchName;
+          };
+          user = {
+            name = "Benedikt Peetz";
+            email = "benedikt.peetz@b-peetz.de";
+            # signingKey = "[is down below]";
+          };
+          help = {
+            autocorrect = 5;
+          };
+          push = {
+            gpgSign = "if-asked";
+          };
+          commit = {
+            template = "${gitTemplateFile}";
+          };
+          diff = {
+            colorMoved = "default";
+            # Usually leads to better results
+            algorithm = "patience";
+            bin = {
+              textconv = "hexdump -v -C";
+            };
+          };
+          # Makes it a bit more readable
+          blame = {
+            coloring = "repeatedLines";
+            markIgnoredLines = true;
+            markUnblamables = true;
+          };
+          merge = {
+            conflictstyle = "zdiff3";
+          };
+          url = {
+            "git@codeberg.org:" = {
+              insteadOf = "@cb:";
+            };
+            "https://codeberg.org/" = {
+              insteadOf = "cb://";
+            };
+
+            "git@github.com:" = {
+              insteadOf = "@gh:";
+            };
+            "https://github.com/" = {
+              insteadOf = "gh://";
+            };
+
+            "git@gitlab.com:" = {
+              insteadOf = "@gl:";
+            };
+            "https://gitlab.com/" = {
+              insteadOf = "gl://";
+            };
+          };
+        };
+        delta = {
+          enable = true;
+          options = {
+            decorations = {
+              commit-decoration-style = "bold yellow box ul";
+              file-decoration-style = "none";
+              file-style = "bold yellow ul";
+            };
+            keep-plus-minus-markers = true;
+            features = "decorations";
+            whitespace-error-style = "22 reverse";
+          };
+        };
+        signing = {
+          key = "8321ED3A8DB999A51F3BF80FF2682914EA42DE26";
+          signByDefault = true;
+        };
+      };
+    };
+  };
+}