Adding a commit-msg hook following the documentation does not work

Hey maintainers 👋 . If follow the instructions in the “Getting started” document to add a commit-msg hook using husky

npx husky add .husky/commit-msg  "npx --no -- commitlint --edit ${1}"

The result in .husky/commit-msg will be

npx --no -- commitlint --edit 

I think the reason is that the $ sign is mistaken for a variable in shell script. Even if I manually type the command, linting will always complain

✖   Please add rules to your `commitlint.config.js`
    - Getting started guide: https://commitlint.js.org/#/?id=getting-started
    - Example config: https://github.com/conventional-changelog/commitlint/blob/master/%40commitlint/config-conventional/index.js [empty-rules]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

Possible Solution

The workaround I’m using is to have a command in package.json

"commitlint": "npx --no -- commitlint --edit ${1}"

and call it in commit-msg

npm run commitlint

Your Environment

Executable	Version
commitlint --version	17.1.2
git --version	2.37.0
node --version	14.20.0

[TheKangaroo]

Which shell/os are you testing this with? for me (zsh/MacOS) both

npx husky add .husky/commit-msg  'npx --no -- commitlint --edit "${1}"'

and

npx husky add .husky/commit-msg  'npx --no -- commitlint --edit ${1}'

work fine. The single qoutes prevent my shell from expanding the ${1} at the husky add runtime as expected.

[TheKangaroo]

Perfect, I still think this needs to be fixed to single quotes in the docs. I can fix this in another PR. WDYT @escapedcat ?