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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commitfmt
-Version: 0.4.0
+Version: 1.0.0
 Summary: Utility for formatting and verifying the commit message.
 Author-email: Mikhael Khrustik <misha@myrt.co>
 License: MIT
@@ -178,13 +178,13 @@ Most of the linting rules are disabled by default. Default config contains 2 rul
 
 ```toml
 [lint.header]
-full-stop = true
+description-full-stop = true
 
 [lint.footer]
 breaking-exclamation = true
 ```
 
-To enable more rules, create a `commitfmt.toml` or (`.commitfmt.toml`) file in the root of your project. Available lint rules can be found in the [rules.md](https://github.com/mishamyrt/commitfmt/blob/main/crates/commitfmt_linter/docs/rules.md) file.
+To enable more rules, create a `commitfmt.toml` or (`.commitfmt.toml`) file in the root of your project. Available lint rules can be found in the [rules.md](https://github.com/mishamyrt/commitfmt/blob/main/crates/commitfmt-linter/docs/rules.md) file.
 
 If there is a problem with an enabled rule and it cannot be automatically fixed, the commit process will be aborted.
 
@@ -237,26 +237,37 @@ Lines starting with the comment symbol will be ignored during parsing.
 
 commitfmt can add additional footers to the commit message.
 
-#### Value template
+#### Static value
 
-You can use a template to format the value of the footer. Inside of template expression you can use any shell command available at the `PATH`.
+You can add a footer with a static value:
 
-For example, to add the `Authored-By` footer with the current user name, add the following to your config file:
+```toml
+[[additional-footers]]
+key = "Authored-By"
+value = "John Doe"
+```
+
+#### Shell commands
+
+You can use shell commands to dynamically generate footer values:
 
 ```toml
-[additional-footers]
+[[additional-footers]]
 key = "Authored-By"
-value-template = "{{ echo $USER }}"
+value = "{{ echo $USER }}"
 ```
 
+Inside the template expression you can use any shell command available in the `PATH`.
+
 #### Branch value pattern
 
 You can also add the ticket number from the task tracker to the footer if it is in the branch name:
 
 ```toml
-[additional-footers]
+[[additional-footers]]
 key = "Ticket-ID"
-branch-value-pattern = "(?:.*)/([A-Z0-9-]+)/?(?:.*)"
+branch-pattern = "(?:.*)/(?<TICKET_ID>[A-Z0-9-]+)/?(?:.*)"
+value = "${{ TICKET_ID }}"
 ```
 
 For example, if your branch name is `feature/CC-123/add-new-feature` or `feature/CC-123`, the `Ticket-ID` footer will be added to the commit message with the value `CC-123`.
@@ -265,27 +276,27 @@ If the ticket number is not found in the branch name, footer will be skipped.
 
 You can use [rustexp](https://rustexp.lpil.uk) to test your pattern.
 
-##### Recipes
+##### Patterns
 
 Examples of patterns for branch names in git flow format:
 
-- Jira/YouTrack: `(?:.*)/([A-Z0-9-]+)/?(?:.*)`
+- Jira/YouTrack: `(?:.*)/(?<TICKET_ID>[A-Z0-9-]+)/?(?:.*)`
   - `feature/CFMT-123`
   - `feature/CFMT-123/add-new-feature`
-- GitHub: `(?:.*)/#?([0-9-]+)/?(?:.*)`
-  - `feature/#123`
+- GitHub: `(?:.*)/(?<ISSUE_ID>[0-9-]+)/?(?:.*)`
   - `feature/123`
-  - `feature/#123/add-new-feature`
+  - `feature/123/add-new-feature`
 
 #### On conflict
 
 If the footer already exists in the commit message, you can specify what to do with it. By default, the footer will be skipped.
 
 ```toml
-[additional-footers]
+[[additional-footers]]
 key = "Ticket-ID"
-branch-value-pattern = "(?:.*)/([A-Z0-9-]+)/?(?:.*)"
-on-conflict = "skip" # skip, append, error
+branch-pattern = "(?:.*)/(?<TICKET_ID>[A-Z0-9-]+)/?(?:.*)"
+value = "${{ TICKET_ID }}"
+on-conflict = "error" # optional. default: skip. available: skip, append, error
 ```
 
 Available options:
@@ -294,6 +305,44 @@ Available options:
 - `append` - append the footer to the end of the footer list
 - `error` - abort the commit
 
+#### Footer formatting
+
+You can customize how footers are formatted using `separator` and `alignment` options:
+
+```toml
+[[additional-footers]]
+key = "Ticket-ID"
+value = "CFMT-123"
+separator = "#"
+alignment = "right"
+```
+
+Available alignment options:
+
+- `left` - align separator to the left (default)
+- `right` - align separator to the right
+
+### Recipe
+
+To enforce conventional commits, you can use the following configuration:
+
+```toml
+[lint.header]
+type-enum = ["chore", "ci", "feat", "fix", "refactor", "style", "test", "docs"]
+description-case = "lower-first"
+description-max-length = 72
+description-full-stop = true
+type-required = true
+# scope-enum = ["cc", "config", "git", "linter"] # optional
+
+[lint.body]
+max-line-length = 72
+case = "upper-first"
+
+[lint.footer]
+breaking-exclamation = true
+```
+
 ## Testing
 
 To test the configuration and the work of commitfmt, run the following command:

commitfmt-1.0.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-1.0.0.dist-info/METADATA,sha256=EggCq9F1yGX-7MWWxP_jTBrHh0hOs2N5UVtp8u3BCgs,10182
+commitfmt-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+commitfmt-1.0.0.dist-info/entry_points.txt,sha256=WbaxVY_kl8rYTrC2jtjP0U5x6gB0Q6CF5V2YKMrXQfc,54
+commitfmt-1.0.0.dist-info/top_level.txt,sha256=YDzuLgcXgStEzOmg2c7IQZIpsye34U2vKCIheKEvyjg,10
+commitfmt-1.0.0.dist-info/RECORD,,

commitfmt-0.4.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.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,,