@tarsilla/commit-wizard 1.0.4 → 1.0.5
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.
- package/README.md +5 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -25,7 +25,7 @@ yarn add --dev @tarsilla/commit-wizard
|
|
|
25
25
|
|
|
26
26
|
## Usage
|
|
27
27
|
|
|
28
|
-
###
|
|
28
|
+
### commitizen
|
|
29
29
|
|
|
30
30
|
Create a `.czrc` file in your project root with the following content:
|
|
31
31
|
|
|
@@ -37,7 +37,7 @@ Create a `.czrc` file in your project root with the following content:
|
|
|
37
37
|
|
|
38
38
|
When you run `npx git-cz`, Commitizen will present you with an interactive prompt to format your commit messages.
|
|
39
39
|
|
|
40
|
-
###
|
|
40
|
+
### commitlint
|
|
41
41
|
|
|
42
42
|
Create a `commitlint.config.mjs` file in your project root with the following content:
|
|
43
43
|
|
|
@@ -50,7 +50,7 @@ export default {
|
|
|
50
50
|
Commitlint enforces commit message conventions by using the conventional commits preset.
|
|
51
51
|
It is recommended to run commitlint during your commit process, ex. using husky (e.g. see [.husky/commit-msg](src/commitlint/commit-msg)).
|
|
52
52
|
|
|
53
|
-
###
|
|
53
|
+
### semantic-release
|
|
54
54
|
|
|
55
55
|
Create a `.releaserc.cjs` file in your project root with the following content:
|
|
56
56
|
|
|
@@ -65,7 +65,7 @@ module.exports = {
|
|
|
65
65
|
The semantic-release configuration automates version management and changelog generation.
|
|
66
66
|
It is recommended to configure CI/CD to run semantic-release, ex. using github actions (e.g. see [.github/workflows/npm-publish.yml](src/semantic-release/npm-publish.yml)).
|
|
67
67
|
|
|
68
|
-
##
|
|
68
|
+
## Configuration Options
|
|
69
69
|
|
|
70
70
|
You can override default settings by creating a `commit-wizard.config.json` file in your project root.
|
|
71
71
|
The plugin accepts an object of type `CommitWizardOptions`:
|
|
@@ -74,8 +74,8 @@ The plugin accepts an object of type `CommitWizardOptions`:
|
|
|
74
74
|
|----------|--------|--------------------------------------------------------------|-------------|
|
|
75
75
|
| maxLineLength | number | The maximum length of the commit message. If not provided, the plugin will run with the default settings. | 120 |
|
|
76
76
|
|
|
77
|
-
|
|
78
77
|
Example `commit-wizard.config.json`:
|
|
78
|
+
|
|
79
79
|
```json
|
|
80
80
|
{
|
|
81
81
|
"maxLineLength": 100
|