Commit ae99d6a

authored

docs: 📝 add pnpm to the getting started and local setup guides (conventional-changelog#4041)

1 parent 9c9f732 commit ae99d6aCopy full SHA for ae99d6a

File tree

+22

-0

lines changed

+22

-0

lines changed

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,10 @@ yarn add --dev @commitlint/{cli,config-conventional}`
`18`	`18`	`npm install --save-dev @commitlint/config-conventional @commitlint/cli`
`19`	`19`	```
`20`	`20`
	`21`	+```sh [pnpm]
	`22`	`+pnpm add --save-dev @commitlint/{cli,config-conventional}`
	`23`	+```
	`24`	`+`
`21`	`25`	`:::`
`22`	`26`
`23`	`27`	`## Configuration`

Lines changed: 18 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,24 @@ echo "yarn commitlint \${1}" > .husky/commit-msg`
`62`	`62`	`> [!WARNING]`
`63`	`63`	> 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)
`64`	`64`
	`65`	`+== pnpm`
	`66`	`+`
	`67`	+```sh
	`68`	`+pnpm add --save-dev husky`
	`69`	`+`
	`70`	`+pnpm husky init`
	`71`	`+`
	`72`	`+# Add commit message linting to commit-msg hook`
	`73`	`+echo "pnpm dlx commitlint --edit \$1" > .husky/commit-msg`
	`74`	+```
	`75`	`+`
	`76`	+As an alternative you can create a script inside `package.json`
	`77`	`+`
	`78`	+```sh
	`79`	`+npm pkg set scripts.commitlint="commitlint --edit"`
	`80`	`+echo "pnpm commitlint \${1}" > .husky/commit-msg`
	`81`	+```
	`82`	`+`
`65`	`83`	`:::`
`66`	`84`
`67`	`85`	`---`

Comments

(0)