Skip to content

docs: use ` to escape dollar signs in Windows #4213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 15, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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