Skip to content

Make pnpm check:docs work in native PowerShell #44293

@aniruddhaadak80

Description

@aniruddhaadak80

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 --check

That 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

  1. Open native PowerShell on Windows.
  2. Run pnpm check:docs from the repository root.
  3. 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:docs succeeds 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions