commitfmt 0.2.0__tar.gz → 0.4.0__tar.gz

{commitfmt-0.2.0 → commitfmt-0.4.0}/PKG-INFO

@@ -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.2.0 → commitfmt-0.4.0}/README.md

@@ -151,15 +151,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
 ```
@@ -189,6 +186,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.2.0 → commitfmt-0.4.0}/commitfmt.egg-info/PKG-INFO

@@ -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.2.0 → commitfmt-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ authors = [
     {name = "Mikhael Khrustik", email = "misha@myrt.co"},
 ]
 description = "Utility for formatting and verifying the commit message."
-version = "0.2.0"
+version = "0.4.0"
 readme = "README.md"
 requires-python = ">=3.9"
 keywords = ["git", "hook"]