Skip to content

Commit 1dccfb7

Browse files
authored
docs: Add note about yarn v2 Plug'n'Play (#2638)
* Add note about yarn v2 Plug'n'Play * Update guides-local-setup.md * chore: misc fix * chore: misc fix * fix: fix prettier format
1 parent 9d96f69 commit 1dccfb7

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,8 @@ yarn husky install
110110
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
111111
```
112112

113+
**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)**
114+
113115
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.
114116

115117
**Detailed Setup instructions**

docs/guides-local-setup.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'
3838
yarn husky add .husky/commit-msg 'yarn commitlint --edit $1'
3939
```
4040

41+
**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)**
4142
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.
4243

4344
## Test

0 commit comments

Comments
 (0)