commitfmt 0.2.0__py3-none-any.whl → 0.4.0__py3-none-any.whl

{commitfmt-0.2.0.dist-info → commitfmt-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commitfmt
-Version: 0.2.0
+Version: 0.4.0
 Summary: Utility for formatting and verifying the commit message.
 Author-email: Mikhael Khrustik <misha@myrt.co>
 License: MIT
@@ -174,15 +174,12 @@ It is an opinionated formatter and the author has established best practices tha
 
 ### Linting
 
-Most of the linting rules are disabled by default. Default config contains 3 rules as they can be safely auto-fixed:
+Most of the linting rules are disabled by default. Default config contains 2 rules as they can be safely auto-fixed:
 
 ```toml
 [lint.header]
 full-stop = true
 
-[lint.body]
-new-line = true
-
 [lint.footer]
 breaking-exclamation = true
 ```
@@ -212,6 +209,30 @@ extends = "node_modules/commitfmt-config-standard/commitfmt.toml"
 
 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.
 
+### Parser Configuration
+
+commitfmt can be configured to use custom footer separators and comment symbols for parsing commit messages.
+
+#### Footer separators
+
+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:
+
+```toml
+footer-separators = ":#"
+```
+
+This allows footers like `Issue-ID: 123` or `Issue-ID #123` to be recognized.
+
+#### Comment symbol
+
+By default, commitfmt uses git's `core.commentChar` or `core.commentString` configuration to identify comment lines in commit messages. You can override this:
+
+```toml
+comment-symbol = "//"
+```
+
+Lines starting with the comment symbol will be ignored during parsing.
+
 ### Additional footers
 
 commitfmt can add additional footers to the commit message.

commitfmt-0.4.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+commitfmt/__init__.py,sha256=XbqA09CGurplp5_c9PpHKvYDGevnhBjtUoYClkU9TCU,32
+commitfmt/__main__.py,sha256=oYv9CGhyxv4OJDAo8jY-vH3WZ9y6IBt9FAVMIDdGARs,353
+commitfmt/commitfmt.py,sha256=4D-ifjc3kqn_wGGZCUFgp5HKGZ5UmU6qnJahwx7HopI,995
+commitfmt-0.4.0.dist-info/METADATA,sha256=DR0nMBkLVtxvla9gphzG1Y_viW1VdqufMG89GOe0h44,9229
+commitfmt-0.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+commitfmt-0.4.0.dist-info/entry_points.txt,sha256=WbaxVY_kl8rYTrC2jtjP0U5x6gB0Q6CF5V2YKMrXQfc,54
+commitfmt-0.4.0.dist-info/top_level.txt,sha256=YDzuLgcXgStEzOmg2c7IQZIpsye34U2vKCIheKEvyjg,10
+commitfmt-0.4.0.dist-info/RECORD,,

commitfmt-0.2.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-commitfmt/__init__.py,sha256=XbqA09CGurplp5_c9PpHKvYDGevnhBjtUoYClkU9TCU,32
-commitfmt/__main__.py,sha256=oYv9CGhyxv4OJDAo8jY-vH3WZ9y6IBt9FAVMIDdGARs,353
-commitfmt/commitfmt.py,sha256=4D-ifjc3kqn_wGGZCUFgp5HKGZ5UmU6qnJahwx7HopI,995
-commitfmt-0.2.0.dist-info/METADATA,sha256=am6SFsHB_xubgAZZtMqfH6gb3ZWr-Np6NsPPs-UGW-M,8517
-commitfmt-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-commitfmt-0.2.0.dist-info/entry_points.txt,sha256=WbaxVY_kl8rYTrC2jtjP0U5x6gB0Q6CF5V2YKMrXQfc,54
-commitfmt-0.2.0.dist-info/top_level.txt,sha256=YDzuLgcXgStEzOmg2c7IQZIpsye34U2vKCIheKEvyjg,10
-commitfmt-0.2.0.dist-info/RECORD,,