docs: add instructions to use the package installed locally (#3626)

conventional-changelog · Jul 3, 2023 · c2613aa · c2613aa
1 parent e74f1a9
commit c2613aa
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -112,6 +112,13 @@ yarn husky install
 npx husky add .husky/commit-msg  'npx --no -- commitlint --edit ${1}'
 ```
 
+**Or use installed package instead** 
+```
+npm pkg set scripts.commitlint="commitlint --edit"
+npx husky add .husky/commit-msg 'npm run commitlint ${1}'
+```
+
+
 Check the [husky documentation](https://typicode.github.io/husky/#/?id=manual) on how you can automatically have Git hooks enabled after install for different `yarn` versions.
 
 **Detailed Setup instructions**

diff --git a/docs/guides-local-setup.md b/docs/guides-local-setup.md
@@ -43,6 +43,12 @@ yarn husky install
 npx husky add .husky/commit-msg  'npx --no -- commitlint --edit ${1}'
 ```
 
+**Or use installed package instead** 
+```
+npm pkg set scripts.commitlint="commitlint --edit"
+npx husky add .husky/commit-msg 'npm run commitlint ${1}'
+```
+
 **Please note that currently @commitlint/cli doesn't support yarn v2 Plug'n'Play (using yarn v2 with `nodeLinker: node-modules` in your .yarnrc.yml file may work sometimes)**\
 Check the [husky documentation](https://typicode.github.io/husky/#/?id=manual) on how you can automatically have Git hooks enabled after install for different `yarn` versions.