Files
pnpm/package.json
Zoltan KochanandClaude Opus 5.5 6f95957063 docs: lint prose with Vale (#17238)
* docs: lint prose with Vale

Add Vale with an in-repo style, .vale/styles/pnpm, that turns the
writing rules in AGENTS.md and the Google developer documentation style
guide into lint rules. The stock Vale packages (Google, Microsoft,
RedHat, write-good) were too noisy to block on, for example 1,300
passive-voice hits in the v12 docs alone, so the rules are written for
this repo, following the GitLab model. Each one links the guideline it
enforces.

Levels:
- error, fails CI: dashes, plain-word substitutions, condescending
  words, "please", "note that", hedges, puffery, optional plurals,
  exclamation marks, ellipses, curly quotes, generic link text, product
  spellings, sentence-case headings, repeated words, double spaces,
  implementation history in comments; in changesets, bold or italic
  emphasis, internal names and release-line names.
- warning: future tense, sentences over 30 words, "instead of" and
  "so that" tails in changesets.
- suggestion: passive voice.

.vale.ini scopes the rules. Docs get every rule. Contributor Markdown
and code comments keep dashes and headings as warnings until their
roughly 8,100 em dashes are rewritten. Released changesets stay in
.changeset/ and are not rewritten, so lint-prose.mjs lints only the
changesets added since PROSE_BASE (the PR base in CI).

The prose workflow installs a pinned, checksum-verified Vale release and
runs `pnpm lint:prose`. The rest of this change rewrites the existing
docs, READMEs, contributor Markdown, and code comments to pass the
error-level rules. Only prose and comment text changed. Renamed
headings keep their anchors.

Spelling stays with cspell, which checks identifiers that Vale does not
see.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs: keep prose lint from flattening meaning

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-22 21:48:09 +02:00

102 lines
5.3 KiB
JSON

{
"name": "monorepo-root",
"private": true,
"scripts": {
"bump": "node pnpm11/__utils__/scripts/src/bump.ts",
"prepare": "husky",
"pretest": "pn compile-only && pn prepare-fixtures",
"prepare-fixtures": "pn --dir=pnpm11/__fixtures__ prepareFixtures",
"lint": "pn spellcheck && pn lint:meta && pn check:versioning && pn lint:ts",
"spellcheck": "cspell \"**/*.ts\" \"**/README.md\" \".changeset/*.md\" --no-progress",
"lint:prose": "node .github/scripts/lint-prose.mjs",
"lint:ts": "eslint \"**/src/**/*.ts\" \"**/test/**/*.ts\" --cache --concurrency auto",
"test-all": "pn pretest && pn lint && pn test-pkgs-all",
"ci:test-all": "pn prepare-fixtures && pn test-pkgs-all-report-summary",
"remove-temp-dir": "shx rm -rf ../pnpm_tmp",
"test-pkgs-all": "pn remove-temp-dir && pn --no-sort --workspace-concurrency=2 -r .test",
"test-pkgs-all-report-summary": "pn remove-temp-dir && pn --no-sort --workspace-concurrency=2 -r --report-summary .test",
"test-branch": "pn pretest && pn lint && git remote set-branches --add origin main && git fetch origin main && pn test-pkgs-branch",
"ci:test-branch": "pn prepare-fixtures && pn test-pkgs-branch",
"test-pkgs-branch": "pn remove-temp-dir && pn --workspace-concurrency=2 --filter=...[origin/main] --no-sort --if-present .test",
"compile-only": "pn typecheck-all && pn -F=pnpm compile",
"typecheck-all": "tsgo --build pnpm11/workspace/workspace-manifest-reader pnpm11/workspace/projects-reader && pnx node@runtime:26.12.1 pnpm11/__utils__/scripts/src/typecheck-only.ts",
"compile": "pn compile-only && pn update-manifests",
"build:pnpm": "cargo build --release --bin pnpm",
"build:pnpm:wasm": "node pnpm/wasm/build.mjs",
"pack:pnpm:wasm": "node pnpm/wasm/pack.mjs",
"build:wasm-runtime-probe": "node pnpm/tasks/ecosystem-e2e/webcontainer/runtime-probe/build.mjs",
"ready:rust": "just ready",
"test:rust": "node pnpm/scripts/run-rust-tests.mjs",
"test:rust-affected": "node pnpm/scripts/test-affected.mjs",
"test:rust-smoke": "node pnpm/scripts/run-rust-tests.mjs --profile smoke",
"check:rust": "just check",
"lint:rust": "just lint",
"fix:rust": "just fix",
"pre-push:rust": "bash pnpm/scripts/pre-push-rust.sh",
"make-lcov": "shx mkdir -p coverage && lcov-result-merger 'pnpm11/**/coverage/lcov.info' 'coverage/lcov.info'",
"update-manifests": "pn meta-updater && pn install",
"meta-updater": "pn --filter=@pnpm-private/updater compile && pn exec meta-updater",
"lint:meta": "pn meta-updater --test",
"check:versioning": "pnpm change check",
"copy-artifacts": "node pnpm11/__utils__/scripts/src/copy-artifacts.ts",
"make-release-description": "pn --filter=@pnpm/get-release-text run write-release-text",
"check:npm-signing-keys": "node pnpm11/deps/security/signatures/scripts/update-npm-signing-keys.mjs",
"update:npm-signing-keys": "node pnpm11/deps/security/signatures/scripts/update-npm-signing-keys.mjs --update",
"check:node-release-keys": "node pnpm11/crypto/shasums-file/scripts/update-node-release-keys.mjs",
"update:node-release-keys": "node pnpm11/crypto/shasums-file/scripts/update-node-release-keys.mjs --update",
"release": "pn --filter=@pnpm/exe run build-artifacts && pn --filter=@pnpm/exe publish --tag=next-11 --access=public --provenance && pn publish --filter=!pnpm --filter=!@pnpm/exe --access=public --provenance && pn publish --filter=pnpm --tag=next-11 --access=public --provenance",
"dev-setup": "pn -C=./pnpm11/pnpm/dev link -g",
"ci:compile": "pn typecheck-all && pn -F=pnpm build",
"ci:lint": "pn lint",
"ci:test-chunk": "node .github/scripts/run-ts-tests-chunk.mjs",
"ci:rust-test": "just test-pacquet",
"ci:pnpr-test": "just test-pnpr",
"ci:rust-clippy": "cargo clippy --locked --workspace --all-targets -- -D warnings",
"ci:rust-doc": "cargo doc --no-deps --workspace --document-private-items",
"ci:rust-deny": "cargo deny check",
"ci:rust-fmt": "node pnpm/scripts/rustfmt.mjs --all -- --check",
"ci:toml-fmt": "taplo format --check",
"ci:rust-dylint": "node pnpm/scripts/cargo-dylint.mjs --all -- --all-targets --workspace",
"ci:build-pnpr": "cargo build --locked --release -p pnpr --bin pnpr -p pnpr-fixtures --bin pnpr-prepare"
},
"devDependencies": {
"@commitlint/cli": "catalog:",
"@commitlint/config-conventional": "catalog:",
"@commitlint/prompt-cli": "catalog:",
"@pnpm/eslint-config": "workspace:*",
"@pnpm/jest-config": "workspace:*",
"@pnpm/meta-updater": "catalog:",
"@pnpm/tgz-fixtures": "catalog:",
"@pnpm/tsconfig": "workspace:*",
"@types/jest": "catalog:",
"@types/node": "catalog:",
"@types/picomatch": "catalog:",
"@typescript/native-preview": "catalog:",
"c8": "catalog:",
"cross-env": "catalog:",
"cspell": "catalog:",
"eslint": "catalog:",
"eslint-plugin-regexp": "catalog:",
"husky": "catalog:",
"jest": "catalog:",
"keyv": "catalog:",
"lcov-result-merger": "catalog:",
"rimraf": "catalog:",
"shx": "catalog:",
"typescript": "catalog:"
},
"packageManager": "pnpm@12.15.0",
"devEngines": {
"packageManager": {
"name": "pnpm",
"version": "12.15.0",
"onFail": "download"
},
"runtime": {
"name": "node",
"version": "26.12.1",
"onFail": "download"
}
}
}