gitfluff 0.5.0__tar.gz → 0.6.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. {gitfluff-0.5.0 → gitfluff-0.6.0}/PKG-INFO +17 -3
  2. {gitfluff-0.5.0 → gitfluff-0.6.0}/README.md +16 -2
  3. {gitfluff-0.5.0 → gitfluff-0.6.0}/gitfluff/__init__.py +1 -1
  4. {gitfluff-0.5.0 → gitfluff-0.6.0}/gitfluff.egg-info/PKG-INFO +17 -3
  5. {gitfluff-0.5.0 → gitfluff-0.6.0}/pyproject.toml +1 -1
  6. {gitfluff-0.5.0 → gitfluff-0.6.0}/gitfluff/__main__.py +0 -0
  7. {gitfluff-0.5.0 → gitfluff-0.6.0}/gitfluff/cli.py +0 -0
  8. {gitfluff-0.5.0 → gitfluff-0.6.0}/gitfluff/downloader.py +0 -0
  9. {gitfluff-0.5.0 → gitfluff-0.6.0}/gitfluff.egg-info/SOURCES.txt +0 -0
  10. {gitfluff-0.5.0 → gitfluff-0.6.0}/gitfluff.egg-info/dependency_links.txt +0 -0
  11. {gitfluff-0.5.0 → gitfluff-0.6.0}/gitfluff.egg-info/entry_points.txt +0 -0
  12. {gitfluff-0.5.0 → gitfluff-0.6.0}/gitfluff.egg-info/requires.txt +0 -0
  13. {gitfluff-0.5.0 → gitfluff-0.6.0}/gitfluff.egg-info/top_level.txt +0 -0
  14. {gitfluff-0.5.0 → gitfluff-0.6.0}/setup.cfg +0 -0
{gitfluff-0.5.0 → gitfluff-0.6.0}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: gitfluff
3
- Version: 0.5.0
3
+ Version: 0.6.0
4
4
  Summary: Commit message linter and formatter
5
5
  Author-email: Na'aman Hirschfeld <nhirschfeld@gmail.com>
6
6
  License: MIT
@@ -55,6 +55,18 @@ gitfluff lint .git/COMMIT_EDITMSG
55
55
  gitfluff lint .git/COMMIT_EDITMSG --write
56
56
  ```
57
57
 
58
+ ## Optional: fail after rewrite (recommended for hooks)
59
+
60
+ Add a `.gitfluff.toml` to enable automatic cleanup and stop the commit if a rewrite happened:
61
+
62
+ ```toml
63
+ preset = "conventional"
64
+ write = true
65
+
66
+ [rules]
67
+ exit_nonzero_on_rewrite = true
68
+ ```
69
+
58
70
  ## Hook Integrations
59
71
 
60
72
  ### Native Git Hook
@@ -82,10 +94,11 @@ default_install_hook_types:
82
94
 
83
95
  repos:
84
96
  - repo: https://github.com/Goldziher/gitfluff
85
- rev: v0.5.0
97
+ rev: v0.6.0
86
98
  hooks:
87
99
  - id: gitfluff-lint
88
100
  stages: [commit-msg]
101
+ # args: ["--write"] # optional, or set `write = true` in .gitfluff.toml
89
102
  # args: ["--msg-pattern", "^JIRA-[0-9]+: .+"] # optional regex override
90
103
  ```
91
104
 
@@ -118,9 +131,10 @@ No configuration is required—the default Conventional Commits rules apply imme
118
131
 
119
132
  ```toml
120
133
  preset = "conventional-body" # optional preset override
134
+ write = true
121
135
 
122
136
  [rules]
123
- write = true
137
+ exit_nonzero_on_rewrite = true
124
138
  ```
125
139
 
126
140
  Any setting can be left out; omit the file entirely to keep defaults.
{gitfluff-0.5.0 → gitfluff-0.6.0}/README.md RENAMED
@@ -30,6 +30,18 @@ gitfluff lint .git/COMMIT_EDITMSG
30
30
  gitfluff lint .git/COMMIT_EDITMSG --write
31
31
  ```
32
32
 
33
+ ## Optional: fail after rewrite (recommended for hooks)
34
+
35
+ Add a `.gitfluff.toml` to enable automatic cleanup and stop the commit if a rewrite happened:
36
+
37
+ ```toml
38
+ preset = "conventional"
39
+ write = true
40
+
41
+ [rules]
42
+ exit_nonzero_on_rewrite = true
43
+ ```
44
+
33
45
  ## Hook Integrations
34
46
 
35
47
  ### Native Git Hook
@@ -57,10 +69,11 @@ default_install_hook_types:
57
69
 
58
70
  repos:
59
71
  - repo: https://github.com/Goldziher/gitfluff
60
- rev: v0.5.0
72
+ rev: v0.6.0
61
73
  hooks:
62
74
  - id: gitfluff-lint
63
75
  stages: [commit-msg]
76
+ # args: ["--write"] # optional, or set `write = true` in .gitfluff.toml
64
77
  # args: ["--msg-pattern", "^JIRA-[0-9]+: .+"] # optional regex override
65
78
  ```
66
79
 
@@ -93,9 +106,10 @@ No configuration is required—the default Conventional Commits rules apply imme
93
106
 
94
107
  ```toml
95
108
  preset = "conventional-body" # optional preset override
109
+ write = true
96
110
 
97
111
  [rules]
98
- write = true
112
+ exit_nonzero_on_rewrite = true
99
113
  ```
100
114
 
101
115
  Any setting can be left out; omit the file entirely to keep defaults.
{gitfluff-0.5.0 → gitfluff-0.6.0}/gitfluff/__init__.py RENAMED
@@ -1,2 +1,2 @@
1
1
  __all__ = ["__version__"]
2
- __version__ = "0.5.0"
2
+ __version__ = "0.6.0"
{gitfluff-0.5.0 → gitfluff-0.6.0}/gitfluff.egg-info/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: gitfluff
3
- Version: 0.5.0
3
+ Version: 0.6.0
4
4
  Summary: Commit message linter and formatter
5
5
  Author-email: Na'aman Hirschfeld <nhirschfeld@gmail.com>
6
6
  License: MIT
@@ -55,6 +55,18 @@ gitfluff lint .git/COMMIT_EDITMSG
55
55
  gitfluff lint .git/COMMIT_EDITMSG --write
56
56
  ```
57
57
 
58
+ ## Optional: fail after rewrite (recommended for hooks)
59
+
60
+ Add a `.gitfluff.toml` to enable automatic cleanup and stop the commit if a rewrite happened:
61
+
62
+ ```toml
63
+ preset = "conventional"
64
+ write = true
65
+
66
+ [rules]
67
+ exit_nonzero_on_rewrite = true
68
+ ```
69
+
58
70
  ## Hook Integrations
59
71
 
60
72
  ### Native Git Hook
@@ -82,10 +94,11 @@ default_install_hook_types:
82
94
 
83
95
  repos:
84
96
  - repo: https://github.com/Goldziher/gitfluff
85
- rev: v0.5.0
97
+ rev: v0.6.0
86
98
  hooks:
87
99
  - id: gitfluff-lint
88
100
  stages: [commit-msg]
101
+ # args: ["--write"] # optional, or set `write = true` in .gitfluff.toml
89
102
  # args: ["--msg-pattern", "^JIRA-[0-9]+: .+"] # optional regex override
90
103
  ```
91
104
 
@@ -118,9 +131,10 @@ No configuration is required—the default Conventional Commits rules apply imme
118
131
 
119
132
  ```toml
120
133
  preset = "conventional-body" # optional preset override
134
+ write = true
121
135
 
122
136
  [rules]
123
- write = true
137
+ exit_nonzero_on_rewrite = true
124
138
  ```
125
139
 
126
140
  Any setting can be left out; omit the file entirely to keep defaults.
{gitfluff-0.5.0 → gitfluff-0.6.0}/pyproject.toml RENAMED
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "gitfluff"
7
- version = "0.5.0"
7
+ version = "0.6.0"
8
8
  description = "Commit message linter and formatter"
9
9
  readme = "README.md"
10
10
  license = {text = "MIT"}
{gitfluff-0.5.0 → gitfluff-0.6.0}/gitfluff/__main__.py RENAMED
File without changes
{gitfluff-0.5.0 → gitfluff-0.6.0}/gitfluff/cli.py RENAMED
File without changes
{gitfluff-0.5.0 → gitfluff-0.6.0}/setup.cfg RENAMED
File without changes