docs: document Windows/PowerShell npx invocation#104
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the working
npxinvocation for Windows/PowerShell users in the README installation section.Why this matters (#93)
Running
npx @google/design.md lint DESIGN.mdin PowerShell on Windows produces no output, and in some cases Windows opens theDESIGN.mdfile in a Markdown editor instead of running the CLI. The root cause is thedesign.mdbin name: the.mdsuffix collides with the Windows Markdown file association during command resolution, so the token resolves to a file rather than the npm shim.The package already ships a dot-free
designmdbin alias pointing at the same entrypoint, and the README already documents it for thepackage.json-script case. The gap was the direct-npxcase that #93 is specifically about.Changes
npxinstall example, pointing users atnpx -p @google/design.md designmd lint DESIGN.mdand briefly explaining the.mdfile-association collision. Wording is kept consistent with the existingdesignmd-alias guidance for the scripts case.Docs-only; no code touched.
Testing
packages/cli/package.json: thebinmap exposes bothdesign.mdanddesignmd, both pointing at./dist/index.js, so the documenteddesignmdalias is accurate and resolves to the same entrypoint.npx @google/design.md lint DESIGN.mdinstructions are unchanged.designmd-alias tip.Fixes #93.