aicommit2 2.4.11 → 2.4.13
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 -1
- package/dist/cli.mjs +110 -110
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -275,7 +275,7 @@ aicommit2 --all # or -a
|
|
|
275
275
|
- `--disable-lowercase`: Disable automatic lowercase conversion of commit messages (default: **false**)
|
|
276
276
|
- Preserves the original casing of commit types and descriptions
|
|
277
277
|
- Useful when working with custom commit conventions that require specific casing
|
|
278
|
-
- `--hook-mode`: Run as a Git hook, typically used with prepare-commit-msg hook (default: **false**)
|
|
278
|
+
- `--hook-mode`: Run as a Git hook, typically used with [`prepare-commit-msg` hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks#_committing_workflow_hooks) hook (default: **false**)
|
|
279
279
|
- This mode is automatically enabled when running through the Git hook system
|
|
280
280
|
- See [Git hook](#git-hook) section for more details
|
|
281
281
|
- `--pre-commit`: Run in [pre-commit](https://pre-commit.com/) framework mode (default: **false**)
|
|
@@ -320,6 +320,10 @@ Make the hook executable:
|
|
|
320
320
|
chmod +x .git/hooks/prepare-commit-msg
|
|
321
321
|
```
|
|
322
322
|
|
|
323
|
+
##### Use with a custom `core.hooksPath`
|
|
324
|
+
|
|
325
|
+
If you are using [`husky`](https://typicode.github.io/husky/)** or have configured a custom [`core.hooksPath`](https://git-scm.com/docs/git-config#Documentation/git-config.txt-corehooksPath), update the corresponding hooks file instead. For Husky users, this file is `.husky/prepare-commit-message`.
|
|
326
|
+
|
|
323
327
|
#### Integration with pre-commit Framework
|
|
324
328
|
|
|
325
329
|
If you're using the [pre-commit](https://pre-commit.com/) framework, you can add _aicommit2_ to your `.pre-commit-config.yaml`:
|