gitfluff 0.3.1__tar.gz → 0.4.0__tar.gz

{gitfluff-0.3.1 → gitfluff-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitfluff
-Version: 0.3.1
+Version: 0.4.0
 Summary: Commit message linter and formatter
 Author-email: Na'aman Hirschfeld <nhirschfeld@gmail.com>
 License: MIT
@@ -31,22 +31,26 @@ This Python package distributes prebuilt `gitfluff` binaries. On first use, the
 
 ## Quick Start
 
-**Install with pip:**
+**Install with uv:**
+
 ```bash
-pip install gitfluff
+uv tool install gitfluff
 ```
 
 **Run without installation (uvx):**
+
 ```bash
 uvx gitfluff --version
 ```
 
 **Lint a commit message:**
+
 ```bash
 gitfluff lint .git/COMMIT_EDITMSG
 ```
 
 **Auto-clean and rewrite:**
+
 ```bash
 gitfluff lint .git/COMMIT_EDITMSG --write
 ```
@@ -56,11 +60,13 @@ gitfluff lint .git/COMMIT_EDITMSG --write
 ### Native Git Hook
 
 **Install commit-msg hook:**
+
 ```bash
 gitfluff hook install commit-msg
 ```
 
 **With auto-cleanup:**
+
 ```bash
 gitfluff hook install commit-msg --write
 ```
@@ -68,6 +74,7 @@ gitfluff hook install commit-msg --write
 ### pre-commit Framework
 
 **Add to `.pre-commit-config.yaml`:**
+
 ```yaml
 default_install_hook_types:
   - pre-commit
@@ -75,13 +82,15 @@ default_install_hook_types:
 
 repos:
   - repo: https://github.com/Goldziher/gitfluff
-    rev: v0.3.1
+    rev: v0.4.0
     hooks:
       - id: gitfluff-lint
         stages: [commit-msg]
+        # args: ["--msg-pattern", "^JIRA-[0-9]+: .+"]  # optional regex override
 ```
 
 **Install the hooks:**
+
 ```bash
 pre-commit install
 ```
@@ -89,6 +98,7 @@ pre-commit install
 ### Lefthook (uvx)
 
 **Add to `lefthook.yml`:**
+
 ```yaml
 commit-msg:
   commands:
@@ -97,6 +107,7 @@ commit-msg:
 ```
 
 **Install hooks:**
+
 ```bash
 npx lefthook install
 ```
@@ -116,7 +127,7 @@ Any setting can be left out; omit the file entirely to keep defaults.
 
 ## Advanced usage
 
-- Override rules per-invocation using CLI flags (e.g. `--preset`, `--exclude`, `--cleanup`, `--single-line`).
+- Override rules per-invocation using CLI flags (e.g. `--preset`, `--msg-pattern`, `--cleanup-pattern`, `--exclude`, `--cleanup`, `--single-line`).
 - Set `GITFLUFF_BINARY` to point at a custom build when testing unpublished versions.
 - Clear the cache (`rm ~/.cache/gitfluff/gitfluff*`) to force a fresh download.
 

{gitfluff-0.3.1 → gitfluff-0.4.0}/README.md

@@ -6,22 +6,26 @@ This Python package distributes prebuilt `gitfluff` binaries. On first use, the
 
 ## Quick Start
 
-**Install with pip:**
+**Install with uv:**
+
 ```bash
-pip install gitfluff
+uv tool install gitfluff
 ```
 
 **Run without installation (uvx):**
+
 ```bash
 uvx gitfluff --version
 ```
 
 **Lint a commit message:**
+
 ```bash
 gitfluff lint .git/COMMIT_EDITMSG
 ```
 
 **Auto-clean and rewrite:**
+
 ```bash
 gitfluff lint .git/COMMIT_EDITMSG --write
 ```
@@ -31,11 +35,13 @@ gitfluff lint .git/COMMIT_EDITMSG --write
 ### Native Git Hook
 
 **Install commit-msg hook:**
+
 ```bash
 gitfluff hook install commit-msg
 ```
 
 **With auto-cleanup:**
+
 ```bash
 gitfluff hook install commit-msg --write
 ```
@@ -43,6 +49,7 @@ gitfluff hook install commit-msg --write
 ### pre-commit Framework
 
 **Add to `.pre-commit-config.yaml`:**
+
 ```yaml
 default_install_hook_types:
   - pre-commit
@@ -50,13 +57,15 @@ default_install_hook_types:
 
 repos:
   - repo: https://github.com/Goldziher/gitfluff
-    rev: v0.3.1
+    rev: v0.4.0
     hooks:
       - id: gitfluff-lint
         stages: [commit-msg]
+        # args: ["--msg-pattern", "^JIRA-[0-9]+: .+"]  # optional regex override
 ```
 
 **Install the hooks:**
+
 ```bash
 pre-commit install
 ```
@@ -64,6 +73,7 @@ pre-commit install
 ### Lefthook (uvx)
 
 **Add to `lefthook.yml`:**
+
 ```yaml
 commit-msg:
   commands:
@@ -72,6 +82,7 @@ commit-msg:
 ```
 
 **Install hooks:**
+
 ```bash
 npx lefthook install
 ```
@@ -91,7 +102,7 @@ Any setting can be left out; omit the file entirely to keep defaults.
 
 ## Advanced usage
 
-- Override rules per-invocation using CLI flags (e.g. `--preset`, `--exclude`, `--cleanup`, `--single-line`).
+- Override rules per-invocation using CLI flags (e.g. `--preset`, `--msg-pattern`, `--cleanup-pattern`, `--exclude`, `--cleanup`, `--single-line`).
 - Set `GITFLUFF_BINARY` to point at a custom build when testing unpublished versions.
 - Clear the cache (`rm ~/.cache/gitfluff/gitfluff*`) to force a fresh download.
 

{gitfluff-0.3.1 → gitfluff-0.4.0}/gitfluff/__init__.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.3.1"
+__version__ = "0.4.0"

{gitfluff-0.3.1 → gitfluff-0.4.0}/gitfluff/downloader.py

@@ -81,7 +81,9 @@ def _extract(archive: Path, ext: str, destination: Path) -> None:
     else:
         with tarfile.open(archive, "r:gz") as tar:
             for member in tar.getmembers():
-                if member.name.endswith("gitfluff") or member.name.endswith("gitfluff.exe"):
+                if member.name.endswith("gitfluff") or member.name.endswith(
+                    "gitfluff.exe"
+                ):
                     with tar.extractfile(member) as src, destination.open("wb") as dst:
                         dst.write(src.read())
                     return

{gitfluff-0.3.1 → gitfluff-0.4.0}/gitfluff.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitfluff
-Version: 0.3.1
+Version: 0.4.0
 Summary: Commit message linter and formatter
 Author-email: Na'aman Hirschfeld <nhirschfeld@gmail.com>
 License: MIT
@@ -31,22 +31,26 @@ This Python package distributes prebuilt `gitfluff` binaries. On first use, the
 
 ## Quick Start
 
-**Install with pip:**
+**Install with uv:**
+
 ```bash
-pip install gitfluff
+uv tool install gitfluff
 ```
 
 **Run without installation (uvx):**
+
 ```bash
 uvx gitfluff --version
 ```
 
 **Lint a commit message:**
+
 ```bash
 gitfluff lint .git/COMMIT_EDITMSG
 ```
 
 **Auto-clean and rewrite:**
+
 ```bash
 gitfluff lint .git/COMMIT_EDITMSG --write
 ```
@@ -56,11 +60,13 @@ gitfluff lint .git/COMMIT_EDITMSG --write
 ### Native Git Hook
 
 **Install commit-msg hook:**
+
 ```bash
 gitfluff hook install commit-msg
 ```
 
 **With auto-cleanup:**
+
 ```bash
 gitfluff hook install commit-msg --write
 ```
@@ -68,6 +74,7 @@ gitfluff hook install commit-msg --write
 ### pre-commit Framework
 
 **Add to `.pre-commit-config.yaml`:**
+
 ```yaml
 default_install_hook_types:
   - pre-commit
@@ -75,13 +82,15 @@ default_install_hook_types:
 
 repos:
   - repo: https://github.com/Goldziher/gitfluff
-    rev: v0.3.1
+    rev: v0.4.0
     hooks:
       - id: gitfluff-lint
         stages: [commit-msg]
+        # args: ["--msg-pattern", "^JIRA-[0-9]+: .+"]  # optional regex override
 ```
 
 **Install the hooks:**
+
 ```bash
 pre-commit install
 ```
@@ -89,6 +98,7 @@ pre-commit install
 ### Lefthook (uvx)
 
 **Add to `lefthook.yml`:**
+
 ```yaml
 commit-msg:
   commands:
@@ -97,6 +107,7 @@ commit-msg:
 ```
 
 **Install hooks:**
+
 ```bash
 npx lefthook install
 ```
@@ -116,7 +127,7 @@ Any setting can be left out; omit the file entirely to keep defaults.
 
 ## Advanced usage
 
-- Override rules per-invocation using CLI flags (e.g. `--preset`, `--exclude`, `--cleanup`, `--single-line`).
+- Override rules per-invocation using CLI flags (e.g. `--preset`, `--msg-pattern`, `--cleanup-pattern`, `--exclude`, `--cleanup`, `--single-line`).
 - Set `GITFLUFF_BINARY` to point at a custom build when testing unpublished versions.
 - Clear the cache (`rm ~/.cache/gitfluff/gitfluff*`) to force a fresh download.
 

{gitfluff-0.3.1 → gitfluff-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gitfluff"
-version = "0.3.1"
+version = "0.4.0"
 description = "Commit message linter and formatter"
 readme = "README.md"
 license = {text = "MIT"}