Skip to content
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

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

Merged
merged 1 commit into from
Dec 15, 2024

Conversation

wy-luke
Copy link
Contributor

@wy-luke wy-luke commented Dec 15, 2024

Windows users should use ` to escape dollar signs.

Description

Windows users should use ` to escape dollar signs, so I add one more command in the Local Setup section.

Motivation and Context

Windows users should use ` to escape dollar signs. The original command below will get wrong outpt

# Original command
echo "deno task --eval commitlint --edit \$1" > .husky/commit-msg
# Result in "commit-msg"
deno task --eval commitlint --edit \

# Right command in Windows
echo "deno task --eval commitlint --edit `$1" > .husky/commit-msg
# Result in "commit-msg"
deno task --eval commitlint --edit $1

Related discuss in StackOverflow: https://stackoverflow.com/questions/17452401/escaping-dollar-signs-in-powershell-path-is-not-working

How Has This Been Tested?

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Copy link

codesandbox-ci bot commented Dec 15, 2024

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

@escapedcat
Copy link
Member

Thanks! Please rename your commit message to:

"docs: use ` to escape dollar signs in Windows"

@wy-luke wy-luke changed the title fix: use ` to escape dollar signs in Windows doc: use ` to escape dollar signs in Windows Dec 15, 2024
Windows users should use ` to escape dollar signs
@wy-luke
Copy link
Contributor Author

wy-luke commented Dec 15, 2024

Thanks! Please rename your commit message to:

"docs: use ` to escape dollar signs in Windows"

Done

@wy-luke wy-luke changed the title doc: use ` to escape dollar signs in Windows docs: use ` to escape dollar signs in Windows Dec 15, 2024
@escapedcat escapedcat merged commit eac4ee9 into conventional-changelog:master Dec 15, 2024
7 checks passed
@escapedcat
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants