From 315c2471950401912aaf39ba07c8d1719203942e Mon Sep 17 00:00:00 2001 From: silentip404 <242152069+silentip404@users.noreply.github.com> Date: Tue, 11 Nov 2025 16:00:38 +0800 Subject: [PATCH] docs: fix missing backtick in Windows setup commands This fixes a documentation bug that caused Windows users to encounter shell syntax errors during local setup. The missing closing backtick in the echo command was interpreted as an unclosed command substitution, resulting in: Error: unexpected EOF while looking for matching `' Impact: All Windows users following the guide with npm, yarn, pnpm, bun, or deno would encounter this error. --- docs/guides/local-setup.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/guides/local-setup.md b/docs/guides/local-setup.md index af597d7367..3b9f2cb2a4 100644 --- a/docs/guides/local-setup.md +++ b/docs/guides/local-setup.md @@ -39,7 +39,7 @@ npx husky install # 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 +echo "npx --no -- commitlint --edit `$1`" > .husky/commit-msg ``` As an alternative you can create a script inside `package.json` @@ -62,7 +62,7 @@ yarn husky install # 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 +echo "yarn commitlint --edit `$1`" > .husky/commit-msg ``` As an alternative you can create a script inside `package.json` @@ -88,7 +88,7 @@ pnpm husky install # 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 +echo "pnpm dlx commitlint --edit `$1`" > .husky/commit-msg ``` As an alternative you can create a script inside `package.json` @@ -111,7 +111,7 @@ bunx husky install # Add commit message linting to commit-msg hook echo "bunx commitlint --edit \$1" > .husky/commit-msg # Windows users should use ` to escape dollar signs -echo "bunx commitlint --edit `$1" > .husky/commit-msg +echo "bunx commitlint --edit `$1`" > .husky/commit-msg ``` == deno @@ -127,7 +127,7 @@ deno task --eval husky install # 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 +echo "deno task --eval commitlint --edit `$1`" > .husky/commit-msg ``` :::