jinja2-git-dir 0.4.1

Jinja2 filter extension for detecting if a directory is a git repository

Git Directory Extension

Jinja2 filter extension for detecting if a directory is an (empty) git repository.

Usage

gitdir

Detects if the path being filtered by gitdir is the top level git repository directory.

So, if my path is /git/path/here and there exists /git/path/here/.git, then {{ '/git/path/here' | gitdir }} will be true.

However, if my path is /git/path/here and there exists /git/path/.git, then {{ '/git/path/here' | gitdir }} will be false.

This is because the top level directory is /git/path, not the tested path of /git/path/here.

Examples:

• Detect if git_path is a git directory
  {{ git_path | gitdir }}
• Assert that git_path is a git directory
  {{ git_path | gitdir is true }}
• Assert that git_path is NOT a git directory
  {{ git_path | gitdir is false }}
• Using gitdir in a conditional
  {% if (git_path | gitdir) %}{{ git_path }} is a git directory{% else %}no git directory at {{ git_path }}{% endif %}

emptygit

Detects if the path being filtered by emptygit contains exactly 0 commits across all references. This will work for subdirectories within a git directory.

So, if my path is /git/path/here and there have been no commits, then {{ '/git/path/here' | emptygit }} will be true.

However, if my path is /git/path/here and there have been any commits anywhere, then {{ '/git/path/here' | emptygit }} will be false.

Examples:

• Detect if git_path is an empty git directory
  {{ git_path | emptygit }}
• Assert that git_path is an empty git directory
  {{ git_path | emptygit is true }}
• Assert that git_path is NOT an empty git directory
  {{ git_path | emptygit is false }}
• Using emptygit in a conditional
  {% if (git_path | emptygit) %}{{ git_path }} has commits{% else %}{{ git_path }} has NO commits{% endif %}

Copier

This can be utilized within a Copier copier.yaml file for determining if the destination path is already initialized as a git directory.

Example:

This will configure a Copier _task to run git init but only if the destination path isn't already a git directory.

_jinja_extensions:
    - jinja2_git_dir.GitDirectoryExtension
_tasks:
  - command: "git init"
    when: "{{ _copier_conf.dst_path | realpath | gitdir is false }}"
  # `emptygit is false` test must come first, otherwise both tasks trigger
  - command: "git commit -am 'template update applied'"
    when: "{{ _copier_conf.dst_path | realpath | emptygit is false }}"
  - command: "git commit -am 'initial commit'"
    when: "{{ _copier_conf.dst_path | realpath | emptygit is true }}"

Development

• Use cog commit for conventional commits -- cog commit -a feat "new thing"
• Use cog bump for SemVer versioning -- cog bump --auto
• Use hatch build for building new package releases after the repo version has been bumped -- uvx hatch build
• Use hatch publish to push the new package to PyPI -- uvx hatch publish
• Bump the nixpkgs release to the new version -- https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/python-modules/jinja2-git-dir/default.nix