-
-
Notifications
You must be signed in to change notification settings - Fork 69.5k
Make pnpm check:docs work in native PowerShell #44293
Copy link
Copy link
Description
Problem
pnpm check:docs currently depends on a Unix-style pipeline in format:docs:check:
git ls-files 'docs/**/*.md' 'docs/**/*.mdx' 'README.md' | xargs oxfmt --checkThat works in bash/Git Bash, but fails in native Windows PowerShell because xargs is not available by default.
Why It Matters
- Contributors on native Windows hit a tooling failure before any actual docs formatting is checked.
- This makes the repository appear less Windows-compatible than it really is.
- The repo already supports Windows in other areas, so shell-only docs tooling is an avoidable paper cut.
Repro
- Open native PowerShell on Windows.
- Run
pnpm check:docsfrom the repository root. - Observe
xargs is not recognized as an internal or external command.
Suggested Direction
Replace the shell pipeline with a shell-agnostic approach, for example:
- a small Node script that expands tracked docs files and invokes
oxfmt - or a package command that accepts file lists without requiring
xargs
Acceptance Criteria
pnpm check:docssucceeds in native PowerShell on Windows.- The docs formatting check still runs correctly in bash/Linux/macOS.
- The contributor workflow does not require Git Bash just to validate docs formatting.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels
Type
Fields
Give feedbackNo fields configured for issues without a type.