commitfmt-windows 0.0.2a1__tar.gz → 0.1.2rc3__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.
@@ -0,0 +1,85 @@
1
+ Metadata-Version: 2.4
2
+ Name: commitfmt_windows
3
+ Version: 0.1.2rc3
4
+ Summary: Utility for formatting and verifying the commit message.
5
+ Author-email: Mikhael Khrustik <misha@myrt.co>
6
+ License: MIT
7
+ Keywords: git,hook
8
+ Classifier: License :: OSI Approved :: MIT License
9
+ Classifier: Development Status :: 5 - Production/Stable
10
+ Classifier: Intended Audience :: Developers
11
+ Classifier: Programming Language :: Python :: 3.9
12
+ Classifier: Programming Language :: Python :: 3.10
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Programming Language :: Python :: 3.13
16
+ Classifier: Operating System :: Microsoft :: Windows
17
+ Requires-Python: >=3.9
18
+ Description-Content-Type: text/markdown
19
+
20
+ # commitfmt [![Quality Assurance](https://github.com/mishamyrt/commitfmt/actions/workflows/qa.yaml/badge.svg)](https://github.com/mishamyrt/commitfmt/actions/workflows/qa.yaml)
21
+
22
+ Utility for formatting and verifying the commit message.
23
+
24
+ It's not a linter. At least not a complete replacement for [commitlint](https://commitlint.js.org), because commitfmt can't prevent you from writing a body or force you to write a description in uppercase (I don't know why you might want to do that), but it will help keep the story high quality.
25
+
26
+ By design, commitfmt runs on the `prepare-commit-msg` hook and formats the message according to git standards and [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) in particular.
27
+
28
+ A message like this:
29
+
30
+ ```
31
+ feat ( scope , scope ) : add new feature.
32
+ body description
33
+ ```
34
+
35
+ Will be formatted to:
36
+
37
+ ```
38
+ feat(scope, scope): add new feature
39
+
40
+ body description
41
+ ```
42
+
43
+ Additionally, you can customize checks, such as limiting the list of available types and scopes. To do this, create a [configuration file](#configuration).
44
+
45
+ ## Installation
46
+
47
+ ### pnpm
48
+
49
+ ```bash
50
+ pnpm add --save-dev commitfmt
51
+ ```
52
+
53
+ ### npm
54
+
55
+ ```bash
56
+ npm install --save-dev commitfmt
57
+ ```
58
+
59
+ ### yarn
60
+
61
+ ```bash
62
+ yarn add --dev commitfmt
63
+ ```
64
+
65
+ ### pip
66
+
67
+ ```bash
68
+ pip install commitfmt
69
+ ```
70
+
71
+ ## Configuration
72
+
73
+ ### TOML
74
+
75
+ Create a `commitfmt.toml` or (`.commitfmt.toml`) file in the root of your project.
76
+
77
+ ```toml
78
+ [lint.body]
79
+ full-stop = false
80
+
81
+ [lint.header]
82
+ scope-case = "lower"
83
+ scope-enum = ["cc", "config", "git", "linter"]
84
+ type-enum = ["build", "chore", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "style", "test"]
85
+ ```
@@ -0,0 +1,66 @@
1
+ # commitfmt [![Quality Assurance](https://github.com/mishamyrt/commitfmt/actions/workflows/qa.yaml/badge.svg)](https://github.com/mishamyrt/commitfmt/actions/workflows/qa.yaml)
2
+
3
+ Utility for formatting and verifying the commit message.
4
+
5
+ It's not a linter. At least not a complete replacement for [commitlint](https://commitlint.js.org), because commitfmt can't prevent you from writing a body or force you to write a description in uppercase (I don't know why you might want to do that), but it will help keep the story high quality.
6
+
7
+ By design, commitfmt runs on the `prepare-commit-msg` hook and formats the message according to git standards and [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) in particular.
8
+
9
+ A message like this:
10
+
11
+ ```
12
+ feat ( scope , scope ) : add new feature.
13
+ body description
14
+ ```
15
+
16
+ Will be formatted to:
17
+
18
+ ```
19
+ feat(scope, scope): add new feature
20
+
21
+ body description
22
+ ```
23
+
24
+ Additionally, you can customize checks, such as limiting the list of available types and scopes. To do this, create a [configuration file](#configuration).
25
+
26
+ ## Installation
27
+
28
+ ### pnpm
29
+
30
+ ```bash
31
+ pnpm add --save-dev commitfmt
32
+ ```
33
+
34
+ ### npm
35
+
36
+ ```bash
37
+ npm install --save-dev commitfmt
38
+ ```
39
+
40
+ ### yarn
41
+
42
+ ```bash
43
+ yarn add --dev commitfmt
44
+ ```
45
+
46
+ ### pip
47
+
48
+ ```bash
49
+ pip install commitfmt
50
+ ```
51
+
52
+ ## Configuration
53
+
54
+ ### TOML
55
+
56
+ Create a `commitfmt.toml` or (`.commitfmt.toml`) file in the root of your project.
57
+
58
+ ```toml
59
+ [lint.body]
60
+ full-stop = false
61
+
62
+ [lint.header]
63
+ scope-case = "lower"
64
+ scope-enum = ["cc", "config", "git", "linter"]
65
+ type-enum = ["build", "chore", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "style", "test"]
66
+ ```
@@ -0,0 +1,85 @@
1
+ Metadata-Version: 2.4
2
+ Name: commitfmt_windows
3
+ Version: 0.1.2rc3
4
+ Summary: Utility for formatting and verifying the commit message.
5
+ Author-email: Mikhael Khrustik <misha@myrt.co>
6
+ License: MIT
7
+ Keywords: git,hook
8
+ Classifier: License :: OSI Approved :: MIT License
9
+ Classifier: Development Status :: 5 - Production/Stable
10
+ Classifier: Intended Audience :: Developers
11
+ Classifier: Programming Language :: Python :: 3.9
12
+ Classifier: Programming Language :: Python :: 3.10
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Programming Language :: Python :: 3.13
16
+ Classifier: Operating System :: Microsoft :: Windows
17
+ Requires-Python: >=3.9
18
+ Description-Content-Type: text/markdown
19
+
20
+ # commitfmt [![Quality Assurance](https://github.com/mishamyrt/commitfmt/actions/workflows/qa.yaml/badge.svg)](https://github.com/mishamyrt/commitfmt/actions/workflows/qa.yaml)
21
+
22
+ Utility for formatting and verifying the commit message.
23
+
24
+ It's not a linter. At least not a complete replacement for [commitlint](https://commitlint.js.org), because commitfmt can't prevent you from writing a body or force you to write a description in uppercase (I don't know why you might want to do that), but it will help keep the story high quality.
25
+
26
+ By design, commitfmt runs on the `prepare-commit-msg` hook and formats the message according to git standards and [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) in particular.
27
+
28
+ A message like this:
29
+
30
+ ```
31
+ feat ( scope , scope ) : add new feature.
32
+ body description
33
+ ```
34
+
35
+ Will be formatted to:
36
+
37
+ ```
38
+ feat(scope, scope): add new feature
39
+
40
+ body description
41
+ ```
42
+
43
+ Additionally, you can customize checks, such as limiting the list of available types and scopes. To do this, create a [configuration file](#configuration).
44
+
45
+ ## Installation
46
+
47
+ ### pnpm
48
+
49
+ ```bash
50
+ pnpm add --save-dev commitfmt
51
+ ```
52
+
53
+ ### npm
54
+
55
+ ```bash
56
+ npm install --save-dev commitfmt
57
+ ```
58
+
59
+ ### yarn
60
+
61
+ ```bash
62
+ yarn add --dev commitfmt
63
+ ```
64
+
65
+ ### pip
66
+
67
+ ```bash
68
+ pip install commitfmt
69
+ ```
70
+
71
+ ## Configuration
72
+
73
+ ### TOML
74
+
75
+ Create a `commitfmt.toml` or (`.commitfmt.toml`) file in the root of your project.
76
+
77
+ ```toml
78
+ [lint.body]
79
+ full-stop = false
80
+
81
+ [lint.header]
82
+ scope-case = "lower"
83
+ scope-enum = ["cc", "config", "git", "linter"]
84
+ type-enum = ["build", "chore", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "style", "test"]
85
+ ```
@@ -6,7 +6,7 @@ authors = [
6
6
  description = "Utility for formatting and verifying the commit message."
7
7
  readme = "README.md"
8
8
  requires-python = ">=3.9"
9
- version = "0.0.2-alpha.1"
9
+ version = "0.1.2-rc.3"
10
10
  keywords = ["git", "hook"]
11
11
  license = {text = "MIT"}
12
12
  classifiers = [
@@ -1,20 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: commitfmt_windows
3
- Version: 0.0.2a1
4
- Summary: Utility for formatting and verifying the commit message.
5
- Author-email: Mikhael Khrustik <misha@myrt.co>
6
- License: MIT
7
- Keywords: git,hook
8
- Classifier: License :: OSI Approved :: MIT License
9
- Classifier: Development Status :: 5 - Production/Stable
10
- Classifier: Intended Audience :: Developers
11
- Classifier: Programming Language :: Python :: 3.9
12
- Classifier: Programming Language :: Python :: 3.10
13
- Classifier: Programming Language :: Python :: 3.11
14
- Classifier: Programming Language :: Python :: 3.12
15
- Classifier: Programming Language :: Python :: 3.13
16
- Classifier: Operating System :: Microsoft :: Windows
17
- Requires-Python: >=3.9
18
- Description-Content-Type: text/markdown
19
-
20
- # commitfmt python wrapper
@@ -1 +0,0 @@
1
- # commitfmt python wrapper
@@ -1,20 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: commitfmt_windows
3
- Version: 0.0.2a1
4
- Summary: Utility for formatting and verifying the commit message.
5
- Author-email: Mikhael Khrustik <misha@myrt.co>
6
- License: MIT
7
- Keywords: git,hook
8
- Classifier: License :: OSI Approved :: MIT License
9
- Classifier: Development Status :: 5 - Production/Stable
10
- Classifier: Intended Audience :: Developers
11
- Classifier: Programming Language :: Python :: 3.9
12
- Classifier: Programming Language :: Python :: 3.10
13
- Classifier: Programming Language :: Python :: 3.11
14
- Classifier: Programming Language :: Python :: 3.12
15
- Classifier: Programming Language :: Python :: 3.13
16
- Classifier: Operating System :: Microsoft :: Windows
17
- Requires-Python: >=3.9
18
- Description-Content-Type: text/markdown
19
-
20
- # commitfmt python wrapper