Skip to content

Commit eac4ee9

Browse files
authored
docs: use ` to escape dollar signs in Windows (#4213)
Windows users should use ` to escape dollar signs
1 parent e2dc109 commit eac4ee9

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/guides/local-setup.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ npx husky init
3535

3636
# Add commit message linting to commit-msg hook
3737
echo "npx --no -- commitlint --edit \$1" > .husky/commit-msg
38+
# Windows users should use ` to escape dollar signs
39+
echo "npx --no commitlint --edit `$1" > .husky/commit-msg
3840
```
3941
4042
As an alternative you can create a script inside `package.json`
@@ -53,6 +55,8 @@ yarn husky init
5355
5456
# Add commit message linting to commit-msg hook
5557
echo "yarn commitlint --edit \$1" > .husky/commit-msg
58+
# Windows users should use ` to escape dollar signs
59+
echo "yarn commitlint --edit `$1" > .husky/commit-msg
5660
```
5761
5862
As an alternative you can create a script inside `package.json`
@@ -74,6 +78,8 @@ pnpm husky init
7478
7579
# Add commit message linting to commit-msg hook
7680
echo "pnpm dlx commitlint --edit \$1" > .husky/commit-msg
81+
# Windows users should use ` to escape dollar signs
82+
echo "pnpm dlx commitlint --edit `$1" > .husky/commit-msg
7783
```
7884
7985
As an alternative you can create a script inside `package.json`
@@ -92,6 +98,8 @@ deno task --eval husky init
9298
9399
# Add commit message linting to commit-msg hook
94100
echo "deno task --eval commitlint --edit \$1" > .husky/commit-msg
101+
# Windows users should use ` to escape dollar signs
102+
echo "deno task --eval commitlint --edit `$1" > .husky/commit-msg
95103
```
96104
97105
:::

0 commit comments

Comments
 (0)