aicommits 2.0.0 → 3.1.0
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 +27 -4
- package/dist/cli-fXLbQukQ.mjs +223 -0
- package/dist/cli.mjs +1 -1
- package/dist/{token-COGazqwp.mjs → token-CkJSeVBK.mjs} +1 -1
- package/dist/{token-util-BCVAAj6C.mjs → token-util-C6r3rt16.mjs} +1 -1
- package/dist/{token-util-Do0nA6Hg.mjs → token-util-JRYE6X6v.mjs} +1 -1
- package/package.json +1 -1
- package/dist/cli-DQF9c1au.mjs +0 -208
package/README.md
CHANGED
|
@@ -61,13 +61,19 @@ This will guide you through:
|
|
|
61
61
|
|
|
62
62
|
Check the installed version with:
|
|
63
63
|
|
|
64
|
+
```sh
|
|
65
|
+
aicommits --version
|
|
64
66
|
```
|
|
65
67
|
|
|
66
|
-
|
|
68
|
+
To update to the latest version, run:
|
|
67
69
|
|
|
70
|
+
```sh
|
|
71
|
+
aicommits update
|
|
68
72
|
```
|
|
69
73
|
|
|
70
|
-
|
|
74
|
+
This will automatically detect your package manager (npm, pnpm, yarn, or bun) and update using the correct command.
|
|
75
|
+
|
|
76
|
+
Alternatively, you can manually update:
|
|
71
77
|
|
|
72
78
|
```sh
|
|
73
79
|
npm install -g aicommits
|
|
@@ -117,11 +123,12 @@ aicommits --generate <i> # or -g <i>
|
|
|
117
123
|
|
|
118
124
|
#### Commit Message Formats
|
|
119
125
|
|
|
120
|
-
You can choose from
|
|
126
|
+
You can choose from four different commit message formats:
|
|
121
127
|
|
|
122
128
|
- **plain** (default): Simple, unstructured commit messages
|
|
123
129
|
- **conventional**: [Conventional Commits](https://conventionalcommits.org/) format with type and scope
|
|
124
130
|
- **gitmoji**: Emoji-based commit messages
|
|
131
|
+
- **subject+body**: Git-style subject line plus a body (description) generated from the diff
|
|
125
132
|
|
|
126
133
|
Use the `--type` flag to specify the format:
|
|
127
134
|
|
|
@@ -129,6 +136,7 @@ Use the `--type` flag to specify the format:
|
|
|
129
136
|
aicommits --type conventional # or -t conventional
|
|
130
137
|
aicommits --type gitmoji # or -t gitmoji
|
|
131
138
|
aicommits --type plain # or -t plain (default)
|
|
139
|
+
aicommits --type subject+body # or -t subject+body (subject + body)
|
|
132
140
|
```
|
|
133
141
|
|
|
134
142
|
This feature is useful if your project follows a specific commit message standard or if you're using tools that rely on these commit formats.
|
|
@@ -233,6 +241,21 @@ This will:
|
|
|
233
241
|
- Let you select from available models or enter a custom model name
|
|
234
242
|
- Update your configuration automatically
|
|
235
243
|
|
|
244
|
+
### Updating aicommits
|
|
245
|
+
|
|
246
|
+
To update to the latest version, run:
|
|
247
|
+
|
|
248
|
+
```sh
|
|
249
|
+
aicommits update
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
This will:
|
|
253
|
+
|
|
254
|
+
- Check for the latest version on npm
|
|
255
|
+
- Detect your package manager (npm, pnpm, yarn, or bun)
|
|
256
|
+
- Update using the appropriate command
|
|
257
|
+
- Show progress and confirm when complete
|
|
258
|
+
|
|
236
259
|
### Reading a configuration value
|
|
237
260
|
|
|
238
261
|
To retrieve a configuration option, use the command:
|
|
@@ -359,4 +382,4 @@ Video coming soon where I rebuild it from scratch to show you how to easily buil
|
|
|
359
382
|
|
|
360
383
|
## Contributing
|
|
361
384
|
|
|
362
|
-
If you want to help fix a bug or implement a feature in [Issues](https://github.com/Nutlope/aicommits/issues), checkout the [Contribution Guide](CONTRIBUTING.md) to learn how to setup and test the project
|
|
385
|
+
If you want to help fix a bug or implement a feature in [Issues](https://github.com/Nutlope/aicommits/issues), checkout the [Contribution Guide](CONTRIBUTING.md) to learn how to setup and test the project
|