commitfmt 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl
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.
- {commitfmt-0.2.0.dist-info → commitfmt-0.3.0.dist-info}/METADATA +25 -1
- commitfmt-0.3.0.dist-info/RECORD +8 -0
- commitfmt-0.2.0.dist-info/RECORD +0 -8
- {commitfmt-0.2.0.dist-info → commitfmt-0.3.0.dist-info}/WHEEL +0 -0
- {commitfmt-0.2.0.dist-info → commitfmt-0.3.0.dist-info}/entry_points.txt +0 -0
- {commitfmt-0.2.0.dist-info → commitfmt-0.3.0.dist-info}/top_level.txt +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: commitfmt
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.3.0
|
|
4
4
|
Summary: Utility for formatting and verifying the commit message.
|
|
5
5
|
Author-email: Mikhael Khrustik <misha@myrt.co>
|
|
6
6
|
License: MIT
|
|
@@ -212,6 +212,30 @@ extends = "node_modules/commitfmt-config-standard/commitfmt.toml"
|
|
|
212
212
|
|
|
213
213
|
Extension is only possible for the current configuration. If the current configuration extends another configuration, which in turn extends a third configuration, commitfmt will throw an error when trying to load such a configuration.
|
|
214
214
|
|
|
215
|
+
### Parser Configuration
|
|
216
|
+
|
|
217
|
+
commitfmt can be configured to use custom footer separators and comment symbols for parsing commit messages.
|
|
218
|
+
|
|
219
|
+
#### Footer separators
|
|
220
|
+
|
|
221
|
+
By default, commitfmt uses git's `trailer.separators` configuration to determine which characters separate footer keys from values. You can override this in your config file:
|
|
222
|
+
|
|
223
|
+
```toml
|
|
224
|
+
footer-separators = ":#"
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
This allows footers like `Issue-ID: 123` or `Issue-ID #123` to be recognized.
|
|
228
|
+
|
|
229
|
+
#### Comment symbol
|
|
230
|
+
|
|
231
|
+
By default, commitfmt uses git's `core.commentChar` or `core.commentString` configuration to identify comment lines in commit messages. You can override this:
|
|
232
|
+
|
|
233
|
+
```toml
|
|
234
|
+
comment-symbol = "//"
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
Lines starting with the comment symbol will be ignored during parsing.
|
|
238
|
+
|
|
215
239
|
### Additional footers
|
|
216
240
|
|
|
217
241
|
commitfmt can add additional footers to the commit message.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
commitfmt/__init__.py,sha256=XbqA09CGurplp5_c9PpHKvYDGevnhBjtUoYClkU9TCU,32
|
|
2
|
+
commitfmt/__main__.py,sha256=oYv9CGhyxv4OJDAo8jY-vH3WZ9y6IBt9FAVMIDdGARs,353
|
|
3
|
+
commitfmt/commitfmt.py,sha256=4D-ifjc3kqn_wGGZCUFgp5HKGZ5UmU6qnJahwx7HopI,995
|
|
4
|
+
commitfmt-0.3.0.dist-info/METADATA,sha256=ZRYTWnPUcGY3K_m1ncOwbE3ZKMTO132Uetwbi2sK1BU,9258
|
|
5
|
+
commitfmt-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
6
|
+
commitfmt-0.3.0.dist-info/entry_points.txt,sha256=WbaxVY_kl8rYTrC2jtjP0U5x6gB0Q6CF5V2YKMrXQfc,54
|
|
7
|
+
commitfmt-0.3.0.dist-info/top_level.txt,sha256=YDzuLgcXgStEzOmg2c7IQZIpsye34U2vKCIheKEvyjg,10
|
|
8
|
+
commitfmt-0.3.0.dist-info/RECORD,,
|
commitfmt-0.2.0.dist-info/RECORD
DELETED
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
commitfmt/__init__.py,sha256=XbqA09CGurplp5_c9PpHKvYDGevnhBjtUoYClkU9TCU,32
|
|
2
|
-
commitfmt/__main__.py,sha256=oYv9CGhyxv4OJDAo8jY-vH3WZ9y6IBt9FAVMIDdGARs,353
|
|
3
|
-
commitfmt/commitfmt.py,sha256=4D-ifjc3kqn_wGGZCUFgp5HKGZ5UmU6qnJahwx7HopI,995
|
|
4
|
-
commitfmt-0.2.0.dist-info/METADATA,sha256=am6SFsHB_xubgAZZtMqfH6gb3ZWr-Np6NsPPs-UGW-M,8517
|
|
5
|
-
commitfmt-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
6
|
-
commitfmt-0.2.0.dist-info/entry_points.txt,sha256=WbaxVY_kl8rYTrC2jtjP0U5x6gB0Q6CF5V2YKMrXQfc,54
|
|
7
|
-
commitfmt-0.2.0.dist-info/top_level.txt,sha256=YDzuLgcXgStEzOmg2c7IQZIpsye34U2vKCIheKEvyjg,10
|
|
8
|
-
commitfmt-0.2.0.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|
|
File without changes
|