Skip to content

Commit

Permalink
docs: use ` to escape dollar signs in Windows (#4213)
Browse files Browse the repository at this point in the history
Windows users should use ` to escape dollar signs
  • Loading branch information
wy-luke authored Dec 15, 2024
1 parent e2dc109 commit eac4ee9
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/guides/local-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ npx husky init

# Add commit message linting to commit-msg hook
echo "npx --no -- commitlint --edit \$1" > .husky/commit-msg
# Windows users should use ` to escape dollar signs
echo "npx --no commitlint --edit `$1" > .husky/commit-msg
```
As an alternative you can create a script inside `package.json`
Expand All @@ -53,6 +55,8 @@ yarn husky init
# Add commit message linting to commit-msg hook
echo "yarn commitlint --edit \$1" > .husky/commit-msg
# Windows users should use ` to escape dollar signs
echo "yarn commitlint --edit `$1" > .husky/commit-msg
```
As an alternative you can create a script inside `package.json`
Expand All @@ -74,6 +78,8 @@ pnpm husky init
# Add commit message linting to commit-msg hook
echo "pnpm dlx commitlint --edit \$1" > .husky/commit-msg
# Windows users should use ` to escape dollar signs
echo "pnpm dlx commitlint --edit `$1" > .husky/commit-msg
```
As an alternative you can create a script inside `package.json`
Expand All @@ -92,6 +98,8 @@ deno task --eval husky init
# Add commit message linting to commit-msg hook
echo "deno task --eval commitlint --edit \$1" > .husky/commit-msg
# Windows users should use ` to escape dollar signs
echo "deno task --eval commitlint --edit `$1" > .husky/commit-msg
```
:::
Expand Down

0 comments on commit eac4ee9

Please sign in to comment.