From 59796e5a199c4c1f57b72b5ca32c86ca82ac803c Mon Sep 17 00:00:00 2001 From: Tom Arra Date: Thu, 2 Jul 2026 09:11:40 -0500 Subject: [PATCH 1/9] docs: add Vale-based heading sentence-case style check Adds a Shorebird.Headings Vale rule that flags Title Case headings and suggests sentence case, with an exceptions list for brand names, products, and acronyms. Wires it into CI as a PR-diff-scoped, non-blocking check (via errata-ai/vale-action) since most existing headings predate this rule and haven't been migrated yet. Run `npm run lint:style` locally to check docs content. Co-Authored-By: Claude Sonnet 5 --- .github/workflows/main.yaml | 23 ++++ .vale.ini | 8 ++ .vale/styles/Shorebird/Headings.yml | 69 +++++++++++ package-lock.json | 181 ++++++++++++++++++++++++++++ package.json | 7 +- 5 files changed, 286 insertions(+), 2 deletions(-) create mode 100644 .vale.ini create mode 100644 .vale/styles/Shorebird/Headings.yml diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index 854382e6..d7c9af4f 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -47,3 +47,26 @@ jobs: with: config: .cspell.yaml modified_files_only: false + + style-check: + # Only lints lines touched by the PR, since most existing headings + # predate this check and haven't been migrated to sentence case yet. + if: ${{ github.event_name == 'pull_request' }} + + runs-on: ubuntu-latest + + permissions: + contents: read + checks: write + pull-requests: write + + steps: + - name: šŸ“š Git Checkout + uses: actions/checkout@v7 + + - name: āœļø Vale + uses: errata-ai/vale-action@v2 + with: + reporter: github-pr-check + filter_mode: added + fail_on_error: false diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 00000000..94532c3f --- /dev/null +++ b/.vale.ini @@ -0,0 +1,8 @@ +StylesPath = .vale/styles +MinAlertLevel = warning + +[formats] +mdx = md + +[*.{md,mdx}] +BasedOnStyles = Shorebird diff --git a/.vale/styles/Shorebird/Headings.yml b/.vale/styles/Shorebird/Headings.yml new file mode 100644 index 00000000..0e91c39b --- /dev/null +++ b/.vale/styles/Shorebird/Headings.yml @@ -0,0 +1,69 @@ +extends: capitalization +message: + "'%s' should use sentence case (capitalize only the first word and proper + nouns)" +link: https://developers.google.com/style/capitalization +level: warning +scope: heading +match: $sentence +exceptions: + - Shorebird + - Shorebird's + - Flutter + - Flutter's + - Dart + - Android + - iOS + - macOS + - Windows + - Linux + - Ubuntu + - Xcode + - GitHub + - CocoaPods + - Codemagic + - Fastlane + - Sentry + - Crashlytics + - Firebase + - Firestore + - TestFlight + - Darkly + - Google + - Play + - Store + - HashiCorp + - Vault + - Azure + - AWS + - GCP + - KMS + - CLI + - CI + - SDK + - API + - UI + - URL + - JSON + - YAML + - TLS + - PEM + - DER + - RSA + - OTA + - MDM + - PR + - OS + - APKs + - VS + - Podfile + - Swift + - Kotlin + - Java + - Objective-C + - BLoC + - npm + - I + - I'm + - I've + - I'll diff --git a/package-lock.json b/package-lock.json index 83c27c86..629031fe 100644 --- a/package-lock.json +++ b/package-lock.json @@ -28,6 +28,7 @@ "devDependencies": { "@lavamoat/allow-scripts": "^5.1.0", "@types/react": "^19.2.17", + "@vvago/vale": "^3.15.1", "prettier": "^3.9.1", "prettier-plugin-astro": "^0.14.1", "prettier-plugin-tailwindcss": "^0.8.0", @@ -3674,6 +3675,22 @@ "integrity": "sha512-KYSIHVmslkaCDyw013pphY+d7x1qV8IZupYfeIfzNA+nsaWHbn5uPuQRvdRFsa9zFzGeudPuoGoZ1Op4jrJXIQ==", "license": "MIT" }, + "node_modules/@vvago/vale": { + "version": "3.15.1", + "resolved": "https://registry.npmjs.org/@vvago/vale/-/vale-3.15.1.tgz", + "integrity": "sha512-2tVObU1Tprq/ItvQNGnWFKYd5rAqlMw5BPuqSTBz0yYI2g8B7xPf/xQXUi7FtmNpwD4VImvuZtvpTh6eQO1AZg==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "dependencies": { + "rimraf": "^6.1.3", + "tar": "^7.5.15", + "unzipper": "^0.12.3" + }, + "bin": { + "vale": "bin/vale" + } + }, "node_modules/@zag-js/dismissable": { "version": "1.41.2", "resolved": "https://registry.npmjs.org/@zag-js/dismissable/-/dismissable-1.41.2.tgz", @@ -5111,6 +5128,13 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/bluebird": { + "version": "3.7.2", + "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz", + "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==", + "dev": true, + "license": "MIT" + }, "node_modules/boolbase": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz", @@ -5417,6 +5441,13 @@ "integrity": "sha512-lXVyvUvrNXblMqzIRrxHb57UUVmqsSWlxqt3XIjCkUP0wDAf6uicO6KMbEgYrMNtEvWgWHwe42CKxPu9MYAnWw==", "license": "MIT" }, + "node_modules/core-util-is": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.3.tgz", + "integrity": "sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ==", + "dev": true, + "license": "MIT" + }, "node_modules/cose-base": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/cose-base/-/cose-base-1.0.3.tgz", @@ -6361,6 +6392,16 @@ "node": ">=4" } }, + "node_modules/duplexer2": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/duplexer2/-/duplexer2-0.1.4.tgz", + "integrity": "sha512-asLFVfWWtJ90ZyOUHMqk7/S2w2guQKxUI2itj3d92ADHhxUSbCMGi1f1cBcJ7xM1To+pE/Khbwo1yuNbMEPKeA==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "readable-stream": "^2.0.2" + } + }, "node_modules/emmet": { "version": "2.4.11", "resolved": "https://registry.npmjs.org/emmet/-/emmet-2.4.11.tgz", @@ -6738,6 +6779,21 @@ "node": ">=20" } }, + "node_modules/fs-extra": { + "version": "11.3.1", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.1.tgz", + "integrity": "sha512-eXvGGwZ5CL17ZSwHWd3bbgk7UUpF6IFHtP57NYYakPvHOs8GDgDe5KJI36jIJzDkJ6eJjuzRA8eBQb6SkKue0g==", + "dev": true, + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=14.14" + } + }, "node_modules/fsevents": { "version": "2.3.3", "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", @@ -7465,6 +7521,13 @@ "node": ">=0.8.19" } }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "dev": true, + "license": "ISC" + }, "node_modules/ini": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/ini/-/ini-6.0.0.tgz", @@ -7707,6 +7770,13 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/isarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", + "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", + "dev": true, + "license": "MIT" + }, "node_modules/isexe": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-4.0.0.tgz", @@ -7825,6 +7895,19 @@ "integrity": "sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ==", "license": "MIT" }, + "node_modules/jsonfile": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.1.tgz", + "integrity": "sha512-zwOTdL3rFQ/lRdBnntKVOX6k5cKJwEc1HdilT71BWEu7J41gXIB2MRp+vxduPSwZJPWBxEzv4yH1wYLJGUHX4Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "universalify": "^2.0.0" + }, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, "node_modules/katex": { "version": "0.16.45", "resolved": "https://registry.npmjs.org/katex/-/katex-0.16.45.tgz", @@ -9524,6 +9607,13 @@ "node": ">=18.17" } }, + "node_modules/node-int64": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/node-int64/-/node-int64-0.4.0.tgz", + "integrity": "sha512-O5lz91xSOeoXP6DulyHfllpq+Eg00MWitZIbtPfoSEvqIHdl5gfcY6hYzDWnj0qD5tz52PI08u9qUvSVeUBeHw==", + "dev": true, + "license": "MIT" + }, "node_modules/node-mock-http": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/node-mock-http/-/node-mock-http-1.0.4.tgz", @@ -9739,6 +9829,13 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/package-json-from-dist": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz", + "integrity": "sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==", + "dev": true, + "license": "BlueOak-1.0.0" + }, "node_modules/package-manager-detector": { "version": "1.6.0", "resolved": "https://registry.npmjs.org/package-manager-detector/-/package-manager-detector-1.6.0.tgz", @@ -10279,6 +10376,13 @@ "node": ">=18.0.0" } }, + "node_modules/process-nextick-args": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", + "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==", + "dev": true, + "license": "MIT" + }, "node_modules/property-information": { "version": "6.5.0", "resolved": "https://registry.npmjs.org/property-information/-/property-information-6.5.0.tgz", @@ -10354,6 +10458,22 @@ "node": "^14.17.0 || ^16.13.0 || >=18.0.0" } }, + "node_modules/readable-stream": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz", + "integrity": "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==", + "dev": true, + "license": "MIT", + "dependencies": { + "core-util-is": "~1.0.0", + "inherits": "~2.0.3", + "isarray": "~1.0.0", + "process-nextick-args": "~2.0.0", + "safe-buffer": "~5.1.1", + "string_decoder": "~1.1.1", + "util-deprecate": "~1.0.1" + } + }, "node_modules/readdirp": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-4.1.2.tgz", @@ -10828,6 +10948,26 @@ "node": ">=0.10.0" } }, + "node_modules/rimraf": { + "version": "6.1.3", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-6.1.3.tgz", + "integrity": "sha512-LKg+Cr2ZF61fkcaK1UdkH2yEBBKnYjTyWzTJT6KNPcSPaiT7HSdhtMXQuN5wkTX0Xu72KQ1l8S42rlmexS2hSA==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "glob": "^13.0.3", + "package-json-from-dist": "^1.0.1" + }, + "bin": { + "rimraf": "dist/esm/bin.mjs" + }, + "engines": { + "node": "20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/robust-predicates": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/robust-predicates/-/robust-predicates-3.0.3.tgz", @@ -10919,6 +11059,13 @@ "devOptional": true, "license": "MIT" }, + "node_modules/safe-buffer": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", + "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", + "dev": true, + "license": "MIT" + }, "node_modules/safer-buffer": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", @@ -11438,6 +11585,16 @@ "integrity": "sha512-TlnjJ1C0QrmxRNrON00JvaFFlNh5TTG00APw23j74ET7gkQpTASi6/L2fuiav8pzK715HXtUeClpBTw2NPSn6w==", "license": "MIT" }, + "node_modules/string_decoder": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", + "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", + "dev": true, + "license": "MIT", + "dependencies": { + "safe-buffer": "~5.1.0" + } + }, "node_modules/string.prototype.codepointat": { "version": "0.2.1", "resolved": "https://registry.npmjs.org/string.prototype.codepointat/-/string.prototype.codepointat-0.2.1.tgz", @@ -12270,6 +12427,16 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/universalify": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", + "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 10.0.0" + } + }, "node_modules/unstorage": { "version": "1.17.5", "resolved": "https://registry.npmjs.org/unstorage/-/unstorage-1.17.5.tgz", @@ -12394,6 +12561,20 @@ "url": "https://paulmillr.com/funding/" } }, + "node_modules/unzipper": { + "version": "0.12.5", + "resolved": "https://registry.npmjs.org/unzipper/-/unzipper-0.12.5.tgz", + "integrity": "sha512-tXYOi9R57Uj/2Z25SOs5RRSzq886MBQj2gY8dPL+xl/kv6s6SvByoKfAtvfVeEuhntWDgjd2o9p2lb4TVPAz0A==", + "dev": true, + "license": "MIT", + "dependencies": { + "bluebird": "~3.7.2", + "duplexer2": "~0.1.4", + "fs-extra": "11.3.1", + "graceful-fs": "^4.2.2", + "node-int64": "^0.4.0" + } + }, "node_modules/url-extras": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/url-extras/-/url-extras-0.1.0.tgz", diff --git a/package.json b/package.json index ccffcffe..ff18089e 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,8 @@ "preview": "astro preview", "astro": "astro", "format": "prettier --write .", - "format:check": "prettier --check ." + "format:check": "prettier --check .", + "lint:style": "vale --config=.vale.ini src/content/docs" }, "dependencies": { "@astrojs/check": "^0.9.9", @@ -32,6 +33,7 @@ "devDependencies": { "@lavamoat/allow-scripts": "^5.1.0", "@types/react": "^19.2.17", + "@vvago/vale": "^3.15.1", "prettier": "^3.9.1", "prettier-plugin-astro": "^0.14.1", "prettier-plugin-tailwindcss": "^0.8.0", @@ -44,7 +46,8 @@ "astro>esbuild": false, "astro>sharp": false, "sharp": false, - "astro>vite>esbuild": false + "astro>vite>esbuild": false, + "@vvago/vale#3.15.1": true } } } From 6cf74236c56ee1d364ef0934b40f328da6478ff0 Mon Sep 17 00:00:00 2001 From: Tom Arra Date: Thu, 2 Jul 2026 09:22:21 -0500 Subject: [PATCH 2/9] docs: check every heading in CI instead of only PR-changed lines Switches the Vale style-check job to filter_mode: nofilter so it reports every heading violation on each PR, not just newly touched ones. Still non-blocking (fail_on_error: false) since this surfaces the full existing backlog of Title Case headings. Co-Authored-By: Claude Sonnet 5 --- .github/workflows/main.yaml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index d7c9af4f..ed209aa7 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -49,8 +49,9 @@ jobs: modified_files_only: false style-check: - # Only lints lines touched by the PR, since most existing headings - # predate this check and haven't been migrated to sentence case yet. + # Lints every heading in the docs, not just lines touched by the PR. + # Most existing headings predate this check and haven't been migrated + # to sentence case yet, so this is non-blocking for now. if: ${{ github.event_name == 'pull_request' }} runs-on: ubuntu-latest @@ -68,5 +69,5 @@ jobs: uses: errata-ai/vale-action@v2 with: reporter: github-pr-check - filter_mode: added + filter_mode: nofilter fail_on_error: false From b36767411e4143a6404a0057d124b9ed859e5dfc Mon Sep 17 00:00:00 2001 From: Tom Arra Date: Thu, 2 Jul 2026 10:43:01 -0500 Subject: [PATCH 3/9] docs: codify marketing content guidelines into style checks Adds Vale-based checks for three more of the marketing team's content guidelines, alongside the existing heading sentence-case rule: - Vale.Terms (via a Shorebird Vocab) enforces exact capitalization of "Shorebird", "Flutter", and "Code Push" anywhere in prose, not just headings. - Shorebird.Exclamation flags exclamation points in prose, ignoring code spans/blocks and markdown image syntax. - Shorebird.SecondPerson heuristically flags first-person pronouns (I/we/our/us) in body paragraphs. Scoped to paragraphs rather than headings so it doesn't flag the site's many FAQ-style "Can I...?" headings, which are an intentional convention. Also adds scripts/lint-component-labels.mjs, since Vale (a markdown prose linter) can't see MDX/JSX attributes or isolate component boundaries: it checks for sentence case and text for upper case, reusing the same exceptions list as the heading rule. Co-Authored-By: Claude Sonnet 5 --- .vale.ini | 7 +- .vale/styles/Shorebird/Exclamation.yml | 8 ++ .vale/styles/Shorebird/SecondPerson.yml | 21 +++++ .../config/vocabularies/Shorebird/accept.txt | 3 + package-lock.json | 1 + package.json | 3 +- scripts/lint-component-labels.mjs | 77 +++++++++++++++++++ 7 files changed, 118 insertions(+), 2 deletions(-) create mode 100644 .vale/styles/Shorebird/Exclamation.yml create mode 100644 .vale/styles/Shorebird/SecondPerson.yml create mode 100644 .vale/styles/config/vocabularies/Shorebird/accept.txt create mode 100644 scripts/lint-component-labels.mjs diff --git a/.vale.ini b/.vale.ini index 94532c3f..023dc283 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,8 +1,13 @@ StylesPath = .vale/styles MinAlertLevel = warning +Vocab = Shorebird [formats] mdx = md [*.{md,mdx}] -BasedOnStyles = Shorebird +BasedOnStyles = Shorebird, Vale +# Only Vale.Terms (the Vocab-driven proper-noun check) is wanted from the +# built-in Vale style; spell-checking is already handled by cspell. +Vale.Spelling = NO +Vale.Repetition = NO diff --git a/.vale/styles/Shorebird/Exclamation.yml b/.vale/styles/Shorebird/Exclamation.yml new file mode 100644 index 00000000..d87d4bfd --- /dev/null +++ b/.vale/styles/Shorebird/Exclamation.yml @@ -0,0 +1,8 @@ +extends: existence +message: 'Avoid exclamation points in documentation.' +link: https://developers.google.com/style/exclamation-points +level: warning +scope: text +nonword: true +tokens: + - '!(?!\[)' diff --git a/.vale/styles/Shorebird/SecondPerson.yml b/.vale/styles/Shorebird/SecondPerson.yml new file mode 100644 index 00000000..39f51270 --- /dev/null +++ b/.vale/styles/Shorebird/SecondPerson.yml @@ -0,0 +1,21 @@ +extends: existence +message: + '''%s'' is first person; docs should be written in second person ("you")' +level: warning +scope: paragraph +ignorecase: true +tokens: + - "\\bI\\b" + - "\\bI'm\\b" + - "\\bI've\\b" + - "\\bI'll\\b" + - "\\bwe\\b" + - "\\bwe're\\b" + - "\\bwe've\\b" + - "\\bwe'll\\b" + - "\\bour\\b" + - "\\bours\\b" + - "\\bus\\b" + - "\\blet's\\b" + - "\\bmy\\b" + - "\\bmine\\b" diff --git a/.vale/styles/config/vocabularies/Shorebird/accept.txt b/.vale/styles/config/vocabularies/Shorebird/accept.txt new file mode 100644 index 00000000..67b353cf --- /dev/null +++ b/.vale/styles/config/vocabularies/Shorebird/accept.txt @@ -0,0 +1,3 @@ +Shorebird +Flutter +Code Push diff --git a/package-lock.json b/package-lock.json index 629031fe..58e7a1f8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -29,6 +29,7 @@ "@lavamoat/allow-scripts": "^5.1.0", "@types/react": "^19.2.17", "@vvago/vale": "^3.15.1", + "js-yaml": "^4.1.1", "prettier": "^3.9.1", "prettier-plugin-astro": "^0.14.1", "prettier-plugin-tailwindcss": "^0.8.0", diff --git a/package.json b/package.json index ff18089e..29558fb1 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,7 @@ "astro": "astro", "format": "prettier --write .", "format:check": "prettier --check .", - "lint:style": "vale --config=.vale.ini src/content/docs" + "lint:style": "vale --config=.vale.ini src/content/docs; node scripts/lint-component-labels.mjs" }, "dependencies": { "@astrojs/check": "^0.9.9", @@ -34,6 +34,7 @@ "@lavamoat/allow-scripts": "^5.1.0", "@types/react": "^19.2.17", "@vvago/vale": "^3.15.1", + "js-yaml": "^4.1.1", "prettier": "^3.9.1", "prettier-plugin-astro": "^0.14.1", "prettier-plugin-tailwindcss": "^0.8.0", diff --git a/scripts/lint-component-labels.mjs b/scripts/lint-component-labels.mjs new file mode 100644 index 00000000..45dd2a46 --- /dev/null +++ b/scripts/lint-component-labels.mjs @@ -0,0 +1,77 @@ +#!/usr/bin/env node +// Checks component props/slots that Vale can't see, since Vale only parses +// markdown prose and has no visibility into MDX/JSX attributes or children: +// - should use sentence case, like other headings. +// - ... text should be upper case, like other +// button labels. +import { globSync, readFileSync } from 'node:fs'; +import { load } from 'js-yaml'; + +const docsGlob = 'src/content/docs/**/*.mdx'; +const headingsRulePath = '.vale/styles/Shorebird/Headings.yml'; + +const exceptions = new Set( + load(readFileSync(headingsRulePath, 'utf8')).exceptions, +); + +function lineNumberAt(text, index) { + return text.slice(0, index).split('\n').length; +} + +function sentenceCaseViolations(text) { + return text + .split(/\s+/) + .map((rawWord, i) => ({ rawWord, i })) + .filter(({ rawWord, i }) => { + const word = rawWord.replace(/^[^A-Za-z0-9]+|[^A-Za-z0-9']+$/g, ''); + if (!word || i === 0) return false; + if (!/^[A-Z]/.test(word)) return false; + if (/^[A-Z0-9]+$/.test(word)) return false; // acronym, e.g. "DSL" + return !exceptions.has(word); + }) + .map(({ rawWord }) => rawWord); +} + +const findings = []; + +for (const file of globSync(docsGlob)) { + const content = readFileSync(file, 'utf8'); + + for (const match of content.matchAll( + /]*\blabel="([^"]+)"[^>]*>/g, + )) { + const label = match[1]; + const violations = sentenceCaseViolations(label); + if (violations.length > 0) { + findings.push({ + file, + line: lineNumberAt(content, match.index), + message: `TabItem label '${label}' should use sentence case (${violations.join(', ')})`, + }); + } + } + + for (const match of content.matchAll( + /]*>([\s\S]*?)<\/LinkButton>/g, + )) { + const text = match[1].trim(); + if (text && text !== text.toUpperCase()) { + findings.push({ + file, + line: lineNumberAt(content, match.index), + message: `LinkButton label '${text}' should be upper case`, + }); + } + } +} + +if (findings.length === 0) { + console.log('āœ” No component label issues found.'); + process.exit(0); +} + +for (const { file, line, message } of findings) { + console.log(`${file}:${line} ${message}`); +} +console.log(`\nāœ– ${findings.length} component label issue(s) found.`); +process.exit(1); From 04c8780ce00d9358cf20650abc8a4f6da6ed142c Mon Sep 17 00:00:00 2001 From: Tom Arra Date: Thu, 2 Jul 2026 11:13:46 -0500 Subject: [PATCH 4/9] docs: combine cspell, Vale, and component-label checks into one script Renames lint:style to lint:content and adds cspell as a local devDependency so all three content checks (spelling, Vale style rules, and the component-label script) run from a single command instead of requiring cspell to be run separately via CI's reusable workflow. Spelling and style stay on separate engines under the hood (cspell's dictionary is purpose-built for this codebase and shared via VeryGoodOpenSource/very_good_workflows; Vale's built-in speller isn't a good fit) but now share one local entry point. Also fixes a real spell-check CI failure this branch introduced: "vvago" (from the @vvago/vale package name) wasn't in the cspell word list. Co-Authored-By: Claude Sonnet 5 --- .cspell.yaml | 1 + package-lock.json | 1041 ++++++++++++++++++++++++++++++++++++++++++++- package.json | 3 +- 3 files changed, 1038 insertions(+), 7 deletions(-) diff --git a/.cspell.yaml b/.cspell.yaml index 5e62550e..058bec09 100644 --- a/.cspell.yaml +++ b/.cspell.yaml @@ -90,6 +90,7 @@ words: - tabler - temurin - uiscene + - vvago - webkitallowfullscreen - widgetbook - xcarchive diff --git a/package-lock.json b/package-lock.json index 58e7a1f8..fc66def1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -29,6 +29,7 @@ "@lavamoat/allow-scripts": "^5.1.0", "@types/react": "^19.2.17", "@vvago/vale": "^3.15.1", + "cspell": "^10.0.1", "js-yaml": "^4.1.1", "prettier": "^3.9.1", "prettier-plugin-astro": "^0.14.1", @@ -817,6 +818,635 @@ "sisteransi": "^1.0.5" } }, + "node_modules/@cspell/cspell-bundled-dicts": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/@cspell/cspell-bundled-dicts/-/cspell-bundled-dicts-10.0.1.tgz", + "integrity": "sha512-WvkSDNX4Uyyj/ZgbPO6L38iFNMfK1EqsH1FteRiI2qLz6QZMXRFrIt12OqiWIplzZDDaVpBH9FCJOPJll0fjCQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspell/dict-ada": "^4.1.1", + "@cspell/dict-al": "^1.1.1", + "@cspell/dict-aws": "^4.0.17", + "@cspell/dict-bash": "^4.2.2", + "@cspell/dict-companies": "^3.2.11", + "@cspell/dict-cpp": "^7.0.2", + "@cspell/dict-cryptocurrencies": "^5.0.5", + "@cspell/dict-csharp": "^4.0.8", + "@cspell/dict-css": "^4.1.1", + "@cspell/dict-dart": "^2.3.2", + "@cspell/dict-data-science": "^2.0.13", + "@cspell/dict-django": "^4.1.6", + "@cspell/dict-docker": "^1.1.17", + "@cspell/dict-dotnet": "^5.0.13", + "@cspell/dict-elixir": "^4.0.8", + "@cspell/dict-en_us": "^4.4.33", + "@cspell/dict-en-common-misspellings": "^2.1.12", + "@cspell/dict-en-gb-mit": "^3.1.22", + "@cspell/dict-filetypes": "^3.0.18", + "@cspell/dict-flutter": "^1.1.1", + "@cspell/dict-fonts": "^4.0.6", + "@cspell/dict-fsharp": "^1.1.1", + "@cspell/dict-fullstack": "^3.2.9", + "@cspell/dict-gaming-terms": "^1.1.2", + "@cspell/dict-git": "^3.1.0", + "@cspell/dict-golang": "^6.0.26", + "@cspell/dict-google": "^1.0.9", + "@cspell/dict-haskell": "^4.0.6", + "@cspell/dict-html": "^4.0.15", + "@cspell/dict-html-symbol-entities": "^4.0.5", + "@cspell/dict-java": "^5.0.12", + "@cspell/dict-julia": "^1.1.1", + "@cspell/dict-k8s": "^1.0.12", + "@cspell/dict-kotlin": "^1.1.1", + "@cspell/dict-latex": "^5.1.0", + "@cspell/dict-lorem-ipsum": "^4.0.5", + "@cspell/dict-lua": "^4.0.8", + "@cspell/dict-makefile": "^1.0.5", + "@cspell/dict-markdown": "^2.0.16", + "@cspell/dict-monkeyc": "^1.0.12", + "@cspell/dict-node": "^5.0.9", + "@cspell/dict-npm": "^5.2.38", + "@cspell/dict-php": "^4.1.1", + "@cspell/dict-powershell": "^5.0.15", + "@cspell/dict-public-licenses": "^2.0.16", + "@cspell/dict-python": "^4.2.26", + "@cspell/dict-r": "^2.1.1", + "@cspell/dict-ruby": "^5.1.1", + "@cspell/dict-rust": "^4.1.2", + "@cspell/dict-scala": "^5.0.9", + "@cspell/dict-shell": "^1.1.2", + "@cspell/dict-software-terms": "^5.2.2", + "@cspell/dict-sql": "^2.2.1", + "@cspell/dict-svelte": "^1.0.7", + "@cspell/dict-swift": "^2.0.6", + "@cspell/dict-terraform": "^1.1.3", + "@cspell/dict-typescript": "^3.2.3", + "@cspell/dict-vue": "^3.0.5", + "@cspell/dict-zig": "^1.0.0" + }, + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/@cspell/cspell-json-reporter": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/@cspell/cspell-json-reporter/-/cspell-json-reporter-10.0.1.tgz", + "integrity": "sha512-/nes1RGILec3WCBcoMOd0byNTBtnJuPaVz/+ZzqYkLtY7x58VMcBG5kyP6hPyN8cIwjRADE/SR43gwdXuqk/FA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspell/cspell-types": "10.0.1" + }, + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/@cspell/cspell-performance-monitor": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/@cspell/cspell-performance-monitor/-/cspell-performance-monitor-10.0.1.tgz", + "integrity": "sha512-9tVcHXwRnbazUv4WSG0h3MqV4+LgmLNgSALAQUflPPW0EMxTf7C4Dmv9cgxJyCEQrdnVKCr58nPPaahhz9LJUg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/@cspell/cspell-pipe": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/@cspell/cspell-pipe/-/cspell-pipe-10.0.1.tgz", + "integrity": "sha512-HPeXMD9AZ3V/qPkvQaPcak+C7cJ2z7JTHN8smd6J8L2aThLRky2cHc2OyeaHPSHB7WA47b4z2n5u5nawZhv5VQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/@cspell/cspell-resolver": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/@cspell/cspell-resolver/-/cspell-resolver-10.0.1.tgz", + "integrity": "sha512-PIzkZHD1fGUQx1XteK2d1iQ0Mzq/maYcoB4jkvAiiR6WqP3MWYNKFdI9z+R5pOq5KgMfW+5Ig1q0oSR6h8irlA==", + "dev": true, + "license": "MIT", + "dependencies": { + "global-directory": "^5.0.0" + }, + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/@cspell/cspell-service-bus": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/@cspell/cspell-service-bus/-/cspell-service-bus-10.0.1.tgz", + "integrity": "sha512-y6NcIGP2IdXaBL4PVH8vxsr7K27wzz3Ech87UtUtrDSXAiVEOvXgAIknEOUVp59rTlUE8Rn4IRURC6f/hgMyfw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/@cspell/cspell-types": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/@cspell/cspell-types/-/cspell-types-10.0.1.tgz", + "integrity": "sha512-kLgLShnWADDVreKC63pBrWkcvxgZzFIfO34Jhx/SWfuOIA3cD8AXT+HjyuLfoGJ7mUb58hv2kUziKzEy4INb1w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/@cspell/cspell-worker": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/@cspell/cspell-worker/-/cspell-worker-10.0.1.tgz", + "integrity": "sha512-L2bJerfuYOls2wEknm8FmynLtj/G7O4UqX9I/HznRggEW6i2yZIxagDetpVDNowpyavNHJ3SJtUFiyMiZc16Sw==", + "dev": true, + "license": "MIT", + "dependencies": { + "cspell-lib": "10.0.1" + }, + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/@cspell/dict-ada": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/@cspell/dict-ada/-/dict-ada-4.1.1.tgz", + "integrity": "sha512-E+0YW9RhZod/9Qy2gxfNZiHJjCYFlCdI69br1eviQQWB8yOTJX0JHXLs79kOYhSW0kINPVUdvddEBe6Lu6CjGQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-al": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@cspell/dict-al/-/dict-al-1.1.1.tgz", + "integrity": "sha512-sD8GCaZetgQL4+MaJLXqbzWcRjfKVp8x+px3HuCaaiATAAtvjwUQ5/Iubiqwfd1boIh2Y1/3EgM3TLQ7Q8e0wQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-aws": { + "version": "4.0.17", + "resolved": "https://registry.npmjs.org/@cspell/dict-aws/-/dict-aws-4.0.17.tgz", + "integrity": "sha512-ORcblTWcdlGjIbWrgKF+8CNEBQiLVKdUOFoTn0KPNkAYnFcdPP0muT4892h7H4Xafh3j72wqB4/loQ6Nti9E/w==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-bash": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/@cspell/dict-bash/-/dict-bash-4.2.3.tgz", + "integrity": "sha512-ljUZoKHbDqw5Sx0qpL2qTUlmkmr+vhZH/sCNrNaBZKTbdgiswErSnIF1jRbGmEitJNxHRHWsuZyVgnTGfVO1Yw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspell/dict-shell": "1.2.0" + } + }, + "node_modules/@cspell/dict-companies": { + "version": "3.2.11", + "resolved": "https://registry.npmjs.org/@cspell/dict-companies/-/dict-companies-3.2.11.tgz", + "integrity": "sha512-0cmafbcz2pTHXLd59eLR1gvDvN6aWAOM0+cIL4LLF9GX9yB2iKDNrKsvs4tJRqutoaTdwNFBbV0FYv+6iCtebQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-cpp": { + "version": "7.0.2", + "resolved": "https://registry.npmjs.org/@cspell/dict-cpp/-/dict-cpp-7.0.2.tgz", + "integrity": "sha512-dfbeERiVNeqmo/npivdR6rDiBCqZi3QtjH2Z0HFcXwpdj6i97dX1xaKyK2GUsO/p4u1TOv63Dmj5Vm48haDpuA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-cryptocurrencies": { + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/@cspell/dict-cryptocurrencies/-/dict-cryptocurrencies-5.0.5.tgz", + "integrity": "sha512-R68hYYF/rtlE6T/dsObStzN5QZw+0aQBinAXuWCVqwdS7YZo0X33vGMfChkHaiCo3Z2+bkegqHlqxZF4TD3rUA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-csharp": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/@cspell/dict-csharp/-/dict-csharp-4.0.8.tgz", + "integrity": "sha512-qmk45pKFHSxckl5mSlbHxmDitSsGMlk/XzFgt7emeTJWLNSTUK//MbYAkBNRtfzB4uD7pAFiKgpKgtJrTMRnrQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-css": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/@cspell/dict-css/-/dict-css-4.1.2.tgz", + "integrity": "sha512-+ylGoKdwZ2sVOCOnU2Eq5wDZx+RaVX3HoKyNHGGsFvhSw6IidQ6tH/mAPKBDofViHJoWCPNlklE0lTr6MDG3QA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-dart": { + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/@cspell/dict-dart/-/dict-dart-2.3.2.tgz", + "integrity": "sha512-sUiLW56t9gfZcu8iR/5EUg+KYyRD83Cjl3yjDEA2ApVuJvK1HhX+vn4e4k4YfjpUQMag8XO2AaRhARE09+/rqw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-data-science": { + "version": "2.0.14", + "resolved": "https://registry.npmjs.org/@cspell/dict-data-science/-/dict-data-science-2.0.14.tgz", + "integrity": "sha512-jl6Ds4u5u5JT+yY30pWQpAbdCHfy3lCcNkLbpL/AZKoUaLEoXbaYsps9xQtvD7DyaiXxiLZkdH2yHHXtoFtZyg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-django": { + "version": "4.1.6", + "resolved": "https://registry.npmjs.org/@cspell/dict-django/-/dict-django-4.1.6.tgz", + "integrity": "sha512-SdbSFDGy9ulETqNz15oWv2+kpWLlk8DJYd573xhIkeRdcXOjskRuxjSZPKfW7O3NxN/KEf3gm3IevVOiNuFS+w==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-docker": { + "version": "1.1.17", + "resolved": "https://registry.npmjs.org/@cspell/dict-docker/-/dict-docker-1.1.17.tgz", + "integrity": "sha512-OcnVTIpHIYYKhztNTyK8ShAnXTfnqs43hVH6p0py0wlcwRIXe5uj4f12n7zPf2CeBI7JAlPjEsV0Rlf4hbz/xQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-dotnet": { + "version": "5.0.13", + "resolved": "https://registry.npmjs.org/@cspell/dict-dotnet/-/dict-dotnet-5.0.13.tgz", + "integrity": "sha512-xPp7jMnFpOri7tzmqmm/dXMolXz1t2bhNqxYkOyMqXhvs08oc7BFs+EsbDY0X7hqiISgeFZGNqn0dOCr+ncPYw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-elixir": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/@cspell/dict-elixir/-/dict-elixir-4.0.8.tgz", + "integrity": "sha512-CyfphrbMyl4Ms55Vzuj+mNmd693HjBFr9hvU+B2YbFEZprE5AG+EXLYTMRWrXbpds4AuZcvN3deM2XVB80BN/Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-en_us": { + "version": "4.4.35", + "resolved": "https://registry.npmjs.org/@cspell/dict-en_us/-/dict-en_us-4.4.35.tgz", + "integrity": "sha512-xWpxBCc/FzzMMo/A+0qwARVaIIhR0Ql8yhhv4rvsvg+GfQF+LG9yzg2GwTM5N2rjvzmM3nKuR9zxFZq2I6fJSg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-en-common-misspellings": { + "version": "2.1.12", + "resolved": "https://registry.npmjs.org/@cspell/dict-en-common-misspellings/-/dict-en-common-misspellings-2.1.12.tgz", + "integrity": "sha512-14Eu6QGqyksqOd4fYPuRb58lK1Va7FQK9XxFsRKnZU8LhL3N+kj7YKDW+7aIaAN/0WGEqslGP6lGbQzNti8Akw==", + "dev": true, + "license": "CC BY-SA 4.0" + }, + "node_modules/@cspell/dict-en-gb-mit": { + "version": "3.1.24", + "resolved": "https://registry.npmjs.org/@cspell/dict-en-gb-mit/-/dict-en-gb-mit-3.1.24.tgz", + "integrity": "sha512-Oowb/Uzkh7OmDRdCcETzMc9imEb4IpLlHJXoYjX8A8DS2X/54gqSjI915JFB8hKtFjBko5OM0BLQ+6cZhFEMmQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-filetypes": { + "version": "3.0.18", + "resolved": "https://registry.npmjs.org/@cspell/dict-filetypes/-/dict-filetypes-3.0.18.tgz", + "integrity": "sha512-yU7RKD/x1IWmDLzWeiItMwgV+6bUcU/af23uS0+uGiFUbsY1qWV/D4rxlAAO6Z7no3J2z8aZOkYIOvUrJq0Rcw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-flutter": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@cspell/dict-flutter/-/dict-flutter-1.1.1.tgz", + "integrity": "sha512-UlOzRcH2tNbFhZmHJN48Za/2/MEdRHl2BMkCWZBYs+30b91mWvBfzaN4IJQU7dUZtowKayVIF9FzvLZtZokc5A==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-fonts": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/@cspell/dict-fonts/-/dict-fonts-4.0.6.tgz", + "integrity": "sha512-aR/0csY01dNb0A1tw/UmN9rKgHruUxsYsvXu6YlSBJFu60s26SKr/k1o4LavpHTQ+lznlYMqAvuxGkE4Flliqw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-fsharp": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@cspell/dict-fsharp/-/dict-fsharp-1.1.1.tgz", + "integrity": "sha512-imhs0u87wEA4/cYjgzS0tAyaJpwG7vwtC8UyMFbwpmtw+/bgss+osNfyqhYRyS/ehVCWL17Ewx2UPkexjKyaBA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-fullstack": { + "version": "3.2.9", + "resolved": "https://registry.npmjs.org/@cspell/dict-fullstack/-/dict-fullstack-3.2.9.tgz", + "integrity": "sha512-diZX+usW5aZ4/b2T0QM/H/Wl9aNMbdODa1Jq0ReBr/jazmNeWjd+PyqeVgzd1joEaHY+SAnjrf/i9CwKd2ZtWQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-gaming-terms": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/@cspell/dict-gaming-terms/-/dict-gaming-terms-1.1.2.tgz", + "integrity": "sha512-9XnOvaoTBscq0xuD6KTEIkk9hhdfBkkvJAIsvw3JMcnp1214OCGW8+kako5RqQ2vTZR3Tnf3pc57o7VgkM0q1Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-git": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@cspell/dict-git/-/dict-git-3.1.0.tgz", + "integrity": "sha512-KEt9zGkxqGy2q1nwH4CbyqTSv5nadpn8BAlDnzlRcnL0Xb3LX9xTgSGShKvzb0bw35lHoYyLWN2ZKAqbC4pgGQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-golang": { + "version": "6.0.26", + "resolved": "https://registry.npmjs.org/@cspell/dict-golang/-/dict-golang-6.0.26.tgz", + "integrity": "sha512-YKA7Xm5KeOd14v5SQ4ll6afe9VSy3a2DWM7L9uBq4u3lXToRBQ1W5PRa+/Q9udd+DTURyVVnQ+7b9cnOlNxaRg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-google": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/@cspell/dict-google/-/dict-google-1.0.9.tgz", + "integrity": "sha512-biL65POqialY0i4g6crj7pR6JnBkbsPovB2WDYkj3H4TuC/QXv7Pu5pdPxeUJA6TSCHI7T5twsO4VSVyRxD9CA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-haskell": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/@cspell/dict-haskell/-/dict-haskell-4.0.6.tgz", + "integrity": "sha512-ib8SA5qgftExpYNjWhpYIgvDsZ/0wvKKxSP+kuSkkak520iPvTJumEpIE+qPcmJQo4NzdKMN8nEfaeci4OcFAQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-html": { + "version": "4.0.15", + "resolved": "https://registry.npmjs.org/@cspell/dict-html/-/dict-html-4.0.15.tgz", + "integrity": "sha512-GJYnYKoD9fmo2OI0aySEGZOjThnx3upSUvV7mmqUu8oG+mGgzqm82P/f7OqsuvTaInZZwZbo+PwJQd/yHcyFIw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-html-symbol-entities": { + "version": "4.0.5", + "resolved": "https://registry.npmjs.org/@cspell/dict-html-symbol-entities/-/dict-html-symbol-entities-4.0.5.tgz", + "integrity": "sha512-429alTD4cE0FIwpMucvSN35Ld87HCyuM8mF731KU5Rm4Je2SG6hmVx7nkBsLyrmH3sQukTcr1GaiZsiEg8svPA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-java": { + "version": "5.0.12", + "resolved": "https://registry.npmjs.org/@cspell/dict-java/-/dict-java-5.0.12.tgz", + "integrity": "sha512-qPSNhTcl7LGJ5Qp6VN71H8zqvRQK04S08T67knMq9hTA8U7G1sTKzLmBaDOFhq17vNX/+rT+rbRYp+B5Nwza1A==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-julia": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@cspell/dict-julia/-/dict-julia-1.1.1.tgz", + "integrity": "sha512-WylJR9TQ2cgwd5BWEOfdO3zvDB+L7kYFm0I9u0s9jKHWQ6yKmfKeMjU9oXxTBxIufhCXm92SKwwVNAC7gjv+yA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-k8s": { + "version": "1.0.12", + "resolved": "https://registry.npmjs.org/@cspell/dict-k8s/-/dict-k8s-1.0.12.tgz", + "integrity": "sha512-2LcllTWgaTfYC7DmkMPOn9GsBWsA4DZdlun4po8s2ysTP7CPEnZc1ZfK6pZ2eI4TsZemlUQQ+NZxMe9/QutQxg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-kotlin": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@cspell/dict-kotlin/-/dict-kotlin-1.1.1.tgz", + "integrity": "sha512-J3NzzfgmxRvEeOe3qUXnSJQCd38i/dpF9/t3quuWh6gXM+krsAXP75dY1CzDmS8mrJAlBdVBeAW5eAZTD8g86Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-latex": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@cspell/dict-latex/-/dict-latex-5.1.0.tgz", + "integrity": "sha512-qxT4guhysyBt0gzoliXYEBYinkAdEtR2M7goRaUH0a7ltCsoqqAeEV8aXYRIdZGcV77gYSobvu3jJL038tlPAw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-lorem-ipsum": { + "version": "4.0.5", + "resolved": "https://registry.npmjs.org/@cspell/dict-lorem-ipsum/-/dict-lorem-ipsum-4.0.5.tgz", + "integrity": "sha512-9a4TJYRcPWPBKkQAJ/whCu4uCAEgv/O2xAaZEI0n4y1/l18Yyx8pBKoIX5QuVXjjmKEkK7hi5SxyIsH7pFEK9Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-lua": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/@cspell/dict-lua/-/dict-lua-4.0.8.tgz", + "integrity": "sha512-N4PkgNDMu9JVsRu7JBS/3E/dvfItRgk9w5ga2dKq+JupP2Y3lojNaAVFhXISh4Y0a6qXDn2clA6nvnavQ/jjLA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-makefile": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@cspell/dict-makefile/-/dict-makefile-1.0.5.tgz", + "integrity": "sha512-4vrVt7bGiK8Rx98tfRbYo42Xo2IstJkAF4tLLDMNQLkQ86msDlYSKG1ZCk8Abg+EdNcFAjNhXIiNO+w4KflGAQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-markdown": { + "version": "2.0.17", + "resolved": "https://registry.npmjs.org/@cspell/dict-markdown/-/dict-markdown-2.0.17.tgz", + "integrity": "sha512-H8bAxih6U8NOnSPL7R8My+tqjaB4tmnJTjERuz4zYqmf+cH+5xshX3UVgKlwWFcyjsYfv/zEDuRdMctQv1q6HQ==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "@cspell/dict-css": "^4.1.2", + "@cspell/dict-html": "^4.0.15", + "@cspell/dict-html-symbol-entities": "^4.0.5", + "@cspell/dict-typescript": "^3.2.3" + } + }, + "node_modules/@cspell/dict-monkeyc": { + "version": "1.0.12", + "resolved": "https://registry.npmjs.org/@cspell/dict-monkeyc/-/dict-monkeyc-1.0.12.tgz", + "integrity": "sha512-MN7Vs11TdP5mbdNFQP5x2Ac8zOBm97ARg6zM5Sb53YQt/eMvXOMvrep7+/+8NJXs0jkp70bBzjqU4APcqBFNAw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-node": { + "version": "5.0.9", + "resolved": "https://registry.npmjs.org/@cspell/dict-node/-/dict-node-5.0.9.tgz", + "integrity": "sha512-hO+ga+uYZ/WA4OtiMEyKt5rDUlUyu3nXMf8KVEeqq2msYvAPdldKBGH7lGONg6R/rPhv53Rb+0Y1SLdoK1+7wQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-npm": { + "version": "5.2.41", + "resolved": "https://registry.npmjs.org/@cspell/dict-npm/-/dict-npm-5.2.41.tgz", + "integrity": "sha512-To3xsfRmMBYVXtWVEdUgV35M9a/JZ54dSuoY6m6D3uHKKL3I326Wmy4xifZ3PU8MQaWhyEH7zbIcUEtKwTQMcA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-php": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/@cspell/dict-php/-/dict-php-4.1.1.tgz", + "integrity": "sha512-EXelI+4AftmdIGtA8HL8kr4WlUE11OqCSVlnIgZekmTkEGSZdYnkFdiJ5IANSALtlQ1mghKjz+OFqVs6yowgWA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-powershell": { + "version": "5.0.15", + "resolved": "https://registry.npmjs.org/@cspell/dict-powershell/-/dict-powershell-5.0.15.tgz", + "integrity": "sha512-l4S5PAcvCFcVDMJShrYD0X6Huv9dcsQPlsVsBGbH38wvuN7gS7+GxZFAjTNxDmTY1wrNi1cCatSg6Pu2BW4rgg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-public-licenses": { + "version": "2.0.16", + "resolved": "https://registry.npmjs.org/@cspell/dict-public-licenses/-/dict-public-licenses-2.0.16.tgz", + "integrity": "sha512-EQRrPvEOmwhwWezV+W7LjXbIBjiy6y/shrET6Qcpnk3XANTzfvWflf9PnJ5kId/oKWvihFy0za0AV1JHd03pSQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-python": { + "version": "4.2.27", + "resolved": "https://registry.npmjs.org/@cspell/dict-python/-/dict-python-4.2.27.tgz", + "integrity": "sha512-Rj6xQgYS4X6ienjgAZF+njA0GRY4oSPouJWv0vfikCTn6EWlfk0V6Dy1HP3Migj1O+IC2NmespgVq+BZNSp8OA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspell/dict-data-science": "^2.0.14" + } + }, + "node_modules/@cspell/dict-r": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@cspell/dict-r/-/dict-r-2.1.1.tgz", + "integrity": "sha512-71Ka+yKfG4ZHEMEmDxc6+blFkeTTvgKbKAbwiwQAuKl3zpqs1Y0vUtwW2N4b3LgmSPhV3ODVY0y4m5ofqDuKMw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-ruby": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/@cspell/dict-ruby/-/dict-ruby-5.1.1.tgz", + "integrity": "sha512-LHrp84oEV6q1ZxPPyj4z+FdKyq1XAKYPtmGptrd+uwHbrF/Ns5+fy6gtSi7pS+uc0zk3JdO9w/tPK+8N1/7WUA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-rust": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/@cspell/dict-rust/-/dict-rust-4.1.2.tgz", + "integrity": "sha512-O1FHrumYcO+HZti3dHfBPUdnDFkI+nbYK3pxYmiM1sr+G0ebOd6qchmswS0Wsc6ZdEVNiPYJY/gZQR6jfW3uOg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-scala": { + "version": "5.0.9", + "resolved": "https://registry.npmjs.org/@cspell/dict-scala/-/dict-scala-5.0.9.tgz", + "integrity": "sha512-AjVcVAELgllybr1zk93CJ5wSUNu/Zb5kIubymR/GAYkMyBdYFCZ3Zbwn4Zz8GJlFFAbazABGOu0JPVbeY59vGg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-shell": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@cspell/dict-shell/-/dict-shell-1.2.0.tgz", + "integrity": "sha512-PVctvT22lJ49niMiakO8xieY7ELCAzjSqhejWR7bAMb5AZ9F4WDEs+XdGMnoVHWeXq7K5rcepLPmEJb+37zzIw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-software-terms": { + "version": "5.2.2", + "resolved": "https://registry.npmjs.org/@cspell/dict-software-terms/-/dict-software-terms-5.2.2.tgz", + "integrity": "sha512-0CaYd6TAsKtEoA7tNswm1iptEblTzEe3UG8beG2cpSTHk7afWIVMtJLgXDv0f/Li67Lf3Z1Jf3JeXR7GsJ2TRw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-sql": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/@cspell/dict-sql/-/dict-sql-2.2.1.tgz", + "integrity": "sha512-qDHF8MpAYCf4pWU8NKbnVGzkoxMNrFqBHyG/dgrlic5EQiKANCLELYtGlX5auIMDLmTf1inA0eNtv74tyRJ/vg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-svelte": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/@cspell/dict-svelte/-/dict-svelte-1.0.7.tgz", + "integrity": "sha512-hGZsGqP0WdzKkdpeVLBivRuSNzOTvN036EBmpOwxH+FTY2DuUH7ecW+cSaMwOgmq5JFSdTcbTNFlNC8HN8lhaQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-swift": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/@cspell/dict-swift/-/dict-swift-2.0.6.tgz", + "integrity": "sha512-PnpNbrIbex2aqU1kMgwEKvCzgbkHtj3dlFLPMqW1vSniop7YxaDTtvTUO4zA++ugYAEL+UK8vYrBwDPTjjvSnA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-terraform": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@cspell/dict-terraform/-/dict-terraform-1.1.3.tgz", + "integrity": "sha512-gr6wxCydwSFyyBKhBA2xkENXtVFToheqYYGFvlMZXWjviynXmh+NK/JTvTCk/VHk3+lzbO9EEQKee6VjrAUSbA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-typescript": { + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/@cspell/dict-typescript/-/dict-typescript-3.2.3.tgz", + "integrity": "sha512-zXh1wYsNljQZfWWdSPYwQhpwiuW0KPW1dSd8idjMRvSD0aSvWWHoWlrMsmZeRl4qM4QCEAjua8+cjflm41cQBg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-vue": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@cspell/dict-vue/-/dict-vue-3.0.5.tgz", + "integrity": "sha512-Mqutb8jbM+kIcywuPQCCaK5qQHTdaByoEO2J9LKFy3sqAdiBogNkrplqUK0HyyRFgCfbJUgjz3N85iCMcWH0JA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dict-zig": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@cspell/dict-zig/-/dict-zig-1.0.0.tgz", + "integrity": "sha512-XibBIxBlVosU06+M6uHWkFeT0/pW5WajDRYdXG2CgHnq85b0TI/Ks0FuBJykmsgi2CAD3Qtx8UHFEtl/DSFnAQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@cspell/dynamic-import": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/@cspell/dynamic-import/-/dynamic-import-10.0.1.tgz", + "integrity": "sha512-mP1gdq00aIcH8HxNMqnH11X6BKxLcneDtFgl/ecjIKnaGKwi44m8AndP5Kr4ODaYdl8UUw9O3dJh7KaQXnLHZQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspell/url": "10.0.1", + "import-meta-resolve": "^4.2.0" + }, + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/@cspell/filetypes": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/@cspell/filetypes/-/filetypes-10.0.1.tgz", + "integrity": "sha512-Z5S35giU5IW49fBBq6BksUbE8PC4IYPfaKuwl5Nl9jkf/OkAKiBmCowKX45NzRUQInwK/GSqqIUifrNeI6LdLw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/@cspell/rpc": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/@cspell/rpc/-/rpc-10.0.1.tgz", + "integrity": "sha512-axSRKv3zEAmBm66iD/FV/MPmE4/Yf7c3PZiwTW894Yd3iEhtn3KPKeTrqQ2/tDrhB1Z2qTsap/Hue0MK4o5WXg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/@cspell/strong-weak-map": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/@cspell/strong-weak-map/-/strong-weak-map-10.0.1.tgz", + "integrity": "sha512-lenN1DVyPi8nJLSMSJJ670ddTjyiruLueuSZO1qLcxBqUhgxDt/mALu9N/1m6WdOVcg6m/5cLiZVg2KOo2UzRw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/@cspell/url": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/@cspell/url/-/url-10.0.1.tgz", + "integrity": "sha512-abYYgI29wJhWIfWTYrYuzRYDcHQUQ1N5ylnhxYn1NJnIQMqUWGLbDmt12JABtZ+R6h6UNatQrS7rhP86etvJyQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=22.18.0" + } + }, "node_modules/@csstools/color-helpers": { "version": "6.0.2", "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-6.0.2.tgz", @@ -3832,6 +4462,19 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/ansi-regex": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", + "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, "node_modules/ansi-styles": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", @@ -3898,6 +4541,13 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/array-timsort": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/array-timsort/-/array-timsort-1.0.3.tgz", + "integrity": "sha512-/+3GRL7dDAGEfM6TseQk/U+mi18TU2Ms9I3UlLdUMhz2hbvGNTKdj9xniwXfUqgYhHxRx0+8UnKkvlNwVU+cWQ==", + "dev": true, + "license": "MIT" + }, "node_modules/astring": { "version": "1.9.0", "resolved": "https://registry.npmjs.org/astring/-/astring-1.9.0.tgz", @@ -5206,6 +5856,35 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/chalk": { + "version": "5.6.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.6.2.tgz", + "integrity": "sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^12.17.0 || ^14.13 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/chalk-template": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/chalk-template/-/chalk-template-1.1.2.tgz", + "integrity": "sha512-2bxTP2yUH7AJj/VAXfcA+4IcWGdQ87HwBANLt5XxGTeomo8yG0y95N1um9i5StvhT/Bl0/2cARA5v1PpPXUxUA==", + "dev": true, + "license": "MIT", + "dependencies": { + "chalk": "^5.2.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/chalk/chalk-template?sponsor=1" + } + }, "node_modules/character-entities": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/character-entities/-/character-entities-2.0.2.tgz", @@ -5407,6 +6086,20 @@ "node": ">=16" } }, + "node_modules/comment-json": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/comment-json/-/comment-json-5.0.0.tgz", + "integrity": "sha512-uiqLcOiVDJtBP8WGkZHEP+FZIhTzP1dxvn59EfoYUi9gqupjrBWVQkO2atDrbnKPwLeotFYDsuNb26uBMqB+hw==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-timsort": "^1.0.3", + "esprima": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, "node_modules/common-ancestor-path": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/common-ancestor-path/-/common-ancestor-path-2.0.0.tgz", @@ -5468,6 +6161,229 @@ "uncrypto": "^0.1.3" } }, + "node_modules/cspell": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/cspell/-/cspell-10.0.1.tgz", + "integrity": "sha512-Gg6w/flT3fKfl3la62hfTnhtNnDQ+9mU7kUhVqw/axl/Ms4oENw0oJMkWFIoj4f6nL/SDPz7KcPXd2XbkKFNmQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspell/cspell-json-reporter": "10.0.1", + "@cspell/cspell-performance-monitor": "10.0.1", + "@cspell/cspell-pipe": "10.0.1", + "@cspell/cspell-types": "10.0.1", + "@cspell/cspell-worker": "10.0.1", + "@cspell/dynamic-import": "10.0.1", + "@cspell/url": "10.0.1", + "ansi-regex": "^6.2.2", + "chalk": "^5.6.2", + "chalk-template": "^1.1.2", + "commander": "^14.0.3", + "cspell-config-lib": "10.0.1", + "cspell-dictionary": "10.0.1", + "cspell-gitignore": "10.0.1", + "cspell-glob": "10.0.1", + "cspell-io": "10.0.1", + "cspell-lib": "10.0.1", + "fast-json-stable-stringify": "^2.1.0", + "flatted": "^3.4.2", + "semver": "^7.8.1", + "tinyglobby": "^0.2.16" + }, + "bin": { + "cspell": "bin.mjs", + "cspell-esm": "bin.mjs" + }, + "engines": { + "node": ">=22.18.0" + }, + "funding": { + "url": "https://github.com/streetsidesoftware/cspell?sponsor=1" + } + }, + "node_modules/cspell-config-lib": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/cspell-config-lib/-/cspell-config-lib-10.0.1.tgz", + "integrity": "sha512-hMpo/0j6k7pbiqrLDOLJKD2IGP9XwhjKf2miiM6p84Xeo4nyuFZaxxDCQ68R851HSYFrrdltgpoipMbj1h2Tnw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspell/cspell-types": "10.0.1", + "comment-json": "^5.0.0", + "smol-toml": "^1.6.1", + "yaml": "^2.9.0" + }, + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/cspell-dictionary": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/cspell-dictionary/-/cspell-dictionary-10.0.1.tgz", + "integrity": "sha512-3cZ659vgsZWkzGQJR/sNqGDVt/OnvTSieLKI76V++4t1bHJfochb9ZrrwsuMsb1VPGiyqClUP1/O6WrefF/FVg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspell/cspell-performance-monitor": "10.0.1", + "@cspell/cspell-pipe": "10.0.1", + "@cspell/cspell-types": "10.0.1", + "cspell-trie-lib": "10.0.1", + "fast-equals": "^6.0.0" + }, + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/cspell-gitignore": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/cspell-gitignore/-/cspell-gitignore-10.0.1.tgz", + "integrity": "sha512-wN23U61Mx6qPJN3CesOmBU9vnbJ0jQm/ylK0iaVui3CcnO7Zzl5qLu5mPHUzGQGm8yso6qjyxqo16Ho7LpZGOQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspell/url": "10.0.1", + "cspell-glob": "10.0.1", + "cspell-io": "10.0.1" + }, + "bin": { + "cspell-gitignore": "bin.mjs" + }, + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/cspell-glob": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/cspell-glob/-/cspell-glob-10.0.1.tgz", + "integrity": "sha512-7bII9J3aSSpZDwhx7w+zfQXbMxHZQ3be0ilUp5bHrsjz6o07v/NqOHMGcwKdPn1sw2dxDz9sv057xE5pqXnSdw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspell/url": "10.0.1", + "picomatch": "^4.0.4" + }, + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/cspell-glob/node_modules/picomatch": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.4.tgz", + "integrity": "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/cspell-grammar": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/cspell-grammar/-/cspell-grammar-10.0.1.tgz", + "integrity": "sha512-xC9AFYmaI9wsO//a7S5tdDGKGJVD5UEEsTg+Up2fi7lPfXIryisYmV6tePNL1SEg0idYss4ja8LUZ3Mib09BjQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspell/cspell-pipe": "10.0.1", + "@cspell/cspell-types": "10.0.1" + }, + "bin": { + "cspell-grammar": "bin.mjs" + }, + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/cspell-io": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/cspell-io/-/cspell-io-10.0.1.tgz", + "integrity": "sha512-8C2ka07faxflnaqEBO3pektS21XViE/SEHT7F5ZD1ou7FyMR5u3xawTBJSczClfsxLt/WYeztBYrpmGAjmjksw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspell/cspell-service-bus": "10.0.1", + "@cspell/url": "10.0.1" + }, + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/cspell-lib": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/cspell-lib/-/cspell-lib-10.0.1.tgz", + "integrity": "sha512-RpsIPiLzc4/YMW8BMRKpyJ81x439qjYWcqgdKeXnMkbKM88J9PexzutfFf/4v97v96KzfNitEzMpbI0uj8OeUg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspell/cspell-bundled-dicts": "10.0.1", + "@cspell/cspell-performance-monitor": "10.0.1", + "@cspell/cspell-pipe": "10.0.1", + "@cspell/cspell-resolver": "10.0.1", + "@cspell/cspell-types": "10.0.1", + "@cspell/dynamic-import": "10.0.1", + "@cspell/filetypes": "10.0.1", + "@cspell/rpc": "10.0.1", + "@cspell/strong-weak-map": "10.0.1", + "@cspell/url": "10.0.1", + "cspell-config-lib": "10.0.1", + "cspell-dictionary": "10.0.1", + "cspell-glob": "10.0.1", + "cspell-grammar": "10.0.1", + "cspell-io": "10.0.1", + "cspell-trie-lib": "10.0.1", + "env-paths": "^4.0.0", + "gensequence": "^8.0.8", + "import-fresh": "^4.0.0", + "resolve-from": "^5.0.0", + "vscode-languageserver-textdocument": "^1.0.12", + "vscode-uri": "^3.1.0", + "xdg-basedir": "^5.1.0" + }, + "engines": { + "node": ">=22.18.0" + } + }, + "node_modules/cspell-lib/node_modules/env-paths": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/env-paths/-/env-paths-4.0.0.tgz", + "integrity": "sha512-pxP8eL2SwwaTRi/KHYwLYXinDs7gL3jxFcBYmEdYfZmZXbaVDvdppd0XBU8qVz03rDfKZMXg1omHCbsJjZrMsw==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-safe-filename": "^0.1.0" + }, + "engines": { + "node": ">=20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/cspell-trie-lib": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/cspell-trie-lib/-/cspell-trie-lib-10.0.1.tgz", + "integrity": "sha512-BFvhalSkRQFjKrZ//FKK7fRGrZFpifnxB5AwCkzsIsBZqicsfafcQ1xP21qpb0QqyV/IomjNgviG+tRJs+0rMw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=22.18.0" + }, + "peerDependencies": { + "@cspell/cspell-types": "10.0.1" + } + }, + "node_modules/cspell/node_modules/commander": { + "version": "14.0.3", + "resolved": "https://registry.npmjs.org/commander/-/commander-14.0.3.tgz", + "integrity": "sha512-H+y0Jo/T1RZ9qPP4Eh1pkcQcLRglraJaSLoyOtHxu6AapkjWVCy2Sit1QQ4x3Dng8qDlSsZEet7g5Pq06MvTgw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=20" + } + }, "node_modules/css-background-parser": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/css-background-parser/-/css-background-parser-0.1.0.tgz", @@ -6561,6 +7477,20 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "dev": true, + "license": "BSD-2-Clause", + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, "node_modules/estree-util-attach-comments": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/estree-util-attach-comments/-/estree-util-attach-comments-3.0.0.tgz", @@ -6689,6 +7619,16 @@ "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", "license": "MIT" }, + "node_modules/fast-equals": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/fast-equals/-/fast-equals-6.0.0.tgz", + "integrity": "sha512-PFhhIGgdM79r5Uztdj9Zb6Tt1zKafqVfdMGwVca1z5z6fbX7DmsySSuJd8HiP6I1j505DCS83cLxo5rmSNeVEA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, "node_modules/fast-glob": { "version": "3.3.3", "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", @@ -6706,6 +7646,13 @@ "node": ">=8.6.0" } }, + "node_modules/fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "dev": true, + "license": "MIT" + }, "node_modules/fast-uri": { "version": "3.1.2", "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.2.tgz", @@ -6750,6 +7697,13 @@ "node": ">=8" } }, + "node_modules/flatted": { + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.4.2.tgz", + "integrity": "sha512-PjDse7RzhcPkIJwy5t7KPWQSZ9cAbzQXcafsetQoD7sOJRQlGikNbx7yZp2OotDnJyrDcbyRq3Ttb18iYOqkxA==", + "dev": true, + "license": "ISC" + }, "node_modules/flattie": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/flattie/-/flattie-1.1.1.tgz", @@ -6818,6 +7772,16 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/gensequence": { + "version": "8.0.8", + "resolved": "https://registry.npmjs.org/gensequence/-/gensequence-8.0.8.tgz", + "integrity": "sha512-omMVniXEXpdx/vKxGnPRoO2394Otlze28TyxECbFVyoSpZ9H3EO7lemjcB12OpQJzRW4e5tt/dL1rOxry6aMHg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=20" + } + }, "node_modules/get-caller-file": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", @@ -6879,6 +7843,22 @@ "node": ">= 6" } }, + "node_modules/global-directory": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/global-directory/-/global-directory-5.0.0.tgz", + "integrity": "sha512-1pgFdhK3J2LeM+dVf2Pd424yHx2ou338lC0ErNP2hPx4j8eW1Sp0XqSjNxtk6Tc4Kr5wlWtSvz8cn2yb7/SG/w==", + "dev": true, + "license": "MIT", + "dependencies": { + "ini": "6.0.0" + }, + "engines": { + "node": ">=20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/graceful-fs": { "version": "4.2.11", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", @@ -7502,6 +8482,19 @@ "node": ">=0.10.0" } }, + "node_modules/import-fresh": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-4.0.0.tgz", + "integrity": "sha512-Fpi660c7VPDM3fPKYovStd9IP1CPOikf6v/dGxJJMmHPcwYQIMJ4W7kO1avBYEpMqkCh+Dx3Ln6H7VYqgztLjw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=22.15" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/import-meta-resolve": { "version": "4.2.0", "resolved": "https://registry.npmjs.org/import-meta-resolve/-/import-meta-resolve-4.2.0.tgz", @@ -7756,6 +8749,19 @@ "integrity": "sha512-bCYeRA2rVibKZd+s2625gGnGF/t7DSqDs4dP7CrLA1m7jKWz6pps0LpYLJN8Q64HtmPKJ1hrN3nzPNKFEKOUiQ==", "license": "MIT" }, + "node_modules/is-safe-filename": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/is-safe-filename/-/is-safe-filename-0.1.1.tgz", + "integrity": "sha512-4SrR7AdnY11LHfDKTZY1u6Ga3RuxZdl3YKWWShO5iyuG5h8QS4GD2tOb04peBJ5I7pXbR+CGBNEhTcwK+FzN3g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/is-wsl": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-3.1.1.tgz", @@ -10868,6 +11874,16 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/resolve-from": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-5.0.0.tgz", + "integrity": "sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, "node_modules/resolve-pkg-maps": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/resolve-pkg-maps/-/resolve-pkg-maps-1.0.0.tgz", @@ -11309,9 +12325,9 @@ } }, "node_modules/smol-toml": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/smol-toml/-/smol-toml-1.6.0.tgz", - "integrity": "sha512-4zemZi0HvTnYwLfrpk/CF9LOd9Lt87kAt50GnqhMpyF9U3poDAP2+iukq2bZsO/ufegbYehBkqINbsWxj4l4cw==", + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/smol-toml/-/smol-toml-1.7.0.tgz", + "integrity": "sha512-aqVvWoyO21L23mb+drl4RmMXbf6N7FdHjAhTRA9ZBL7apWBgfWC16KjrASI+1p9GAroljyMHj6fK67i0UiTNvQ==", "license": "BSD-3-Clause", "engines": { "node": ">= 18" @@ -13150,6 +14166,19 @@ "node": "^14.17.0 || ^16.13.0 || >=18.0.0" } }, + "node_modules/xdg-basedir": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-5.1.0.tgz", + "integrity": "sha512-GCPAHLvrIH13+c0SuacwvRYj2SxJXQ4kaVTT5xgL3kPrz56XxkF21IGhjSE1+W0aw7gpBWRGXLCPnPby6lSpmQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/xml-name-validator": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/xml-name-validator/-/xml-name-validator-5.0.0.tgz", @@ -13191,9 +14220,9 @@ } }, "node_modules/yaml": { - "version": "2.8.3", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.3.tgz", - "integrity": "sha512-AvbaCLOO2Otw/lW5bmh9d/WEdcDFdQp2Z2ZUH3pX9U2ihyUY0nvLv7J6TrWowklRGPYbB/IuIMfYgxaCPg5Bpg==", + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.9.0.tgz", + "integrity": "sha512-2AvhNX3mb8zd6Zy7INTtSpl1F15HW6Wnqj0srWlkKLcpYl/gMIMJiyuGq2KeI2YFxUPjdlB+3Lc10seMLtL4cA==", "license": "ISC", "bin": { "yaml": "bin.mjs" diff --git a/package.json b/package.json index 29558fb1..bb1a99d6 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,7 @@ "astro": "astro", "format": "prettier --write .", "format:check": "prettier --check .", - "lint:style": "vale --config=.vale.ini src/content/docs; node scripts/lint-component-labels.mjs" + "lint:content": "cspell --config .cspell.yaml \"**\"; vale --config=.vale.ini src/content/docs; node scripts/lint-component-labels.mjs" }, "dependencies": { "@astrojs/check": "^0.9.9", @@ -34,6 +34,7 @@ "@lavamoat/allow-scripts": "^5.1.0", "@types/react": "^19.2.17", "@vvago/vale": "^3.15.1", + "cspell": "^10.0.1", "js-yaml": "^4.1.1", "prettier": "^3.9.1", "prettier-plugin-astro": "^0.14.1", From 1fdeac590709a57541b963c242447d951b7d7d2a Mon Sep 17 00:00:00 2001 From: Tom Arra Date: Thu, 2 Jul 2026 12:17:17 -0500 Subject: [PATCH 5/9] docs: add proper nouns discovered while fixing heading casing MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds Stripe, Fastfile, BuildContext, RenderObject, Apple, 1Password, AOT, GuardSquare, LTS, ExportOptions.plist, Skia, and Impeller to the Headings rule's exceptions list. These surfaced while applying the sentence-case fixes in #583 ā€” without them, this check will flag legitimate proper nouns as false positives once both PRs merge. --- .vale/styles/Shorebird/Headings.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.vale/styles/Shorebird/Headings.yml b/.vale/styles/Shorebird/Headings.yml index 0e91c39b..4e48f188 100644 --- a/.vale/styles/Shorebird/Headings.yml +++ b/.vale/styles/Shorebird/Headings.yml @@ -67,3 +67,15 @@ exceptions: - I'm - I've - I'll + - Stripe + - Fastfile + - BuildContext + - RenderObject + - Apple + - 1Password + - AOT + - GuardSquare + - LTS + - ExportOptions.plist + - Skia + - Impeller From 324ade4d8c962583d63af4cf4913a8a876ccfe38 Mon Sep 17 00:00:00 2001 From: Tom Arra Date: Thu, 2 Jul 2026 13:02:33 -0500 Subject: [PATCH 6/9] docs: silence known-permanent Shorebird.Headings exceptions Adds TokenIgnores for headings intentionally left as Title Case in PR #583: - "vs"/"vs." trips Vale's capitalization rule unconditionally, regardless of surrounding case or the exceptions list. - Compound product/brand names (Azure Key Vault, GCP Cloud KMS, App Store Connect, Firebase Remote Config, Launch Darkly, Hot Reload) where per-word exception matching breaks the phrase apart. - Three numbered-list headings kept as Title Case for visual consistency with their siblings (see #583 for why). Without this, these ~9 headings would show as permanent findings forever, even after all the content PRs merge, making it impossible to ever flip this check to blocking. --- .vale.ini | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.vale.ini b/.vale.ini index 023dc283..44165258 100644 --- a/.vale.ini +++ b/.vale.ini @@ -11,3 +11,13 @@ BasedOnStyles = Shorebird, Vale # built-in Vale style; spell-checking is already handled by cspell. Vale.Spelling = NO Vale.Repetition = NO +# Known, permanent exceptions to Shorebird.Headings, found while fixing every +# heading in the docs (see PR #583). Without these, the check can never go +# clean/blocking: +# - "vs"/"vs." is flagged unconditionally by Vale's capitalization rule, +# regardless of surrounding text or exceptions-list entries. +# - Compound product/brand names where per-word exception matching breaks +# down and partially-casing the phrase reads worse than Title Case. +TokenIgnores = (\bvs\.?\b), (Azure Key Vault), (GCP Cloud KMS), \ + (App Store Connect), (Firebase Remote Config), (Launch Darkly), \ + (Hot Reload), (The Status Enum), (The Single State Class), (The Events) From 2a5aaecb6e54cce3cbcadc13934c521e0cf514b7 Mon Sep 17 00:00:00 2001 From: Tom Arra Date: Thu, 2 Jul 2026 13:57:42 -0500 Subject: [PATCH 7/9] docs: make Shorebird.Headings and Shorebird.Exclamation blocking Bumps both custom rules from warning to error severity and flips fail_on_error to true in CI, so they now actually gate merges instead of just annotating PRs. Vale.Terms (proper-noun capitalization) is explicitly downgraded to warning via `Vale.Terms = warning`, staying non-blocking. It doesn't respect code-fence exclusion the way our custom scope:text rules do, and a TokenIgnores pattern matching one occurrence of a shell command (e.g. `shorebird release android`) intermittently fails to suppress a second, identical occurrence elsewhere in the same file - confirmed with minimal reproductions, not a config mistake. Findings are still reported, just don't block. Shorebird.SecondPerson stays at warning too, since that guideline's content work hasn't happened yet. IMPORTANT: this branch's own CI will fail until #583 (heading sentence-case fixes) merges - this branch still has the original Title Case headings. Do not merge this PR before #583. Verified the full combination (this branch + main + #583 + #584) passes cleanly with fail_on_error: true. --- .github/workflows/main.yaml | 8 ++++--- .vale.ini | 33 +++++++++++++++++++------- .vale/styles/Shorebird/Exclamation.yml | 2 +- .vale/styles/Shorebird/Headings.yml | 2 +- 4 files changed, 32 insertions(+), 13 deletions(-) diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index ed209aa7..2eba7c63 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -50,8 +50,10 @@ jobs: style-check: # Lints every heading in the docs, not just lines touched by the PR. - # Most existing headings predate this check and haven't been migrated - # to sentence case yet, so this is non-blocking for now. + # Shorebird.Headings, Shorebird.Exclamation, and Vale.Terms run at + # error severity and block the build; Shorebird.SecondPerson stays at + # warning severity (non-blocking) until that guideline's content work + # is done. if: ${{ github.event_name == 'pull_request' }} runs-on: ubuntu-latest @@ -70,4 +72,4 @@ jobs: with: reporter: github-pr-check filter_mode: nofilter - fail_on_error: false + fail_on_error: true diff --git a/.vale.ini b/.vale.ini index 44165258..61d739d0 100644 --- a/.vale.ini +++ b/.vale.ini @@ -11,13 +11,30 @@ BasedOnStyles = Shorebird, Vale # built-in Vale style; spell-checking is already handled by cspell. Vale.Spelling = NO Vale.Repetition = NO -# Known, permanent exceptions to Shorebird.Headings, found while fixing every -# heading in the docs (see PR #583). Without these, the check can never go -# clean/blocking: -# - "vs"/"vs." is flagged unconditionally by Vale's capitalization rule, -# regardless of surrounding text or exceptions-list entries. -# - Compound product/brand names where per-word exception matching breaks -# down and partially-casing the phrase reads worse than Title Case. +# Vale.Terms runs at error severity by default. Downgraded to warning +# (non-blocking) because it doesn't respect code-fence exclusion the way +# custom scope:text rules do: it flags literal shell commands inside +# fenced code blocks (e.g. `shorebird release android`), and a TokenIgnores +# pattern matching one occurrence intermittently fails to suppress a +# *second* occurrence of the identical command elsewhere in the same file - +# a genuine Vale bug (verified with minimal repros), not a config mistake. +# Proper-noun capitalization is still reported, just doesn't block CI. +Vale.Terms = warning +# Known, permanent exceptions found while fixing every heading and proper +# noun in the docs (see PRs #579 and #583): +# - Shorebird.Headings: "vs"/"vs." is flagged unconditionally by Vale's +# capitalization rule, regardless of surrounding text or the exceptions +# list. Compound product/brand names (Azure Key Vault, GCP Cloud KMS, App +# Store Connect, Firebase Remote Config, Launch Darkly, Hot Reload) and +# three numbered-list headings kept as Title Case for consistency are +# left as per-word exception matching breaks those phrases apart. +# - Vale.Terms: domains, an email address, a config filename mentioned two +# different ways, a GitHub issue shorthand, and a file path placeholder. +# - Shorebird.Exclamation: a table row documenting the literal "[!]" symbol +# from real `flutter doctor` output. TokenIgnores = (\bvs\.?\b), (Azure Key Vault), (GCP Cloud KMS), \ (App Store Connect), (Firebase Remote Config), (Launch Darkly), \ - (Hot Reload), (The Status Enum), (The Single State Class), (The Events) + (Hot Reload), (The Status Enum), (The Single State Class), (The Events), \ + (contact@shorebird\.dev), (console\.shorebird\.dev), \ + (download\.flutter\.dev), (shorebird\.yaml), (shorebird yaml), \ + (shorebirdtech/shorebird#\d+), (/path/to/flutter), (\[!\]) diff --git a/.vale/styles/Shorebird/Exclamation.yml b/.vale/styles/Shorebird/Exclamation.yml index d87d4bfd..cc1a09f9 100644 --- a/.vale/styles/Shorebird/Exclamation.yml +++ b/.vale/styles/Shorebird/Exclamation.yml @@ -1,7 +1,7 @@ extends: existence message: 'Avoid exclamation points in documentation.' link: https://developers.google.com/style/exclamation-points -level: warning +level: error scope: text nonword: true tokens: diff --git a/.vale/styles/Shorebird/Headings.yml b/.vale/styles/Shorebird/Headings.yml index 4e48f188..4bf2527f 100644 --- a/.vale/styles/Shorebird/Headings.yml +++ b/.vale/styles/Shorebird/Headings.yml @@ -3,7 +3,7 @@ message: "'%s' should use sentence case (capitalize only the first word and proper nouns)" link: https://developers.google.com/style/capitalization -level: warning +level: error scope: heading match: $sentence exceptions: From c8c08575d455e5186cebe92c938b2c37db7725bb Mon Sep 17 00:00:00 2001 From: Tom Arra Date: Thu, 2 Jul 2026 14:10:15 -0500 Subject: [PATCH 8/9] clean up github action --- .github/workflows/main.yaml | 7 ------- 1 file changed, 7 deletions(-) diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index 2eba7c63..836444d1 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -49,13 +49,6 @@ jobs: modified_files_only: false style-check: - # Lints every heading in the docs, not just lines touched by the PR. - # Shorebird.Headings, Shorebird.Exclamation, and Vale.Terms run at - # error severity and block the build; Shorebird.SecondPerson stays at - # warning severity (non-blocking) until that guideline's content work - # is done. - if: ${{ github.event_name == 'pull_request' }} - runs-on: ubuntu-latest permissions: From 5b865097ab4dbc60abd9251622a5140b155eab6f Mon Sep 17 00:00:00 2001 From: Tom Arra Date: Thu, 2 Jul 2026 14:29:20 -0500 Subject: [PATCH 9/9] docs: fix remaining CI failures and scope exceptions correctly Fixes the two Shorebird.Headings failures found when CI ran against the whole repo (not just src/content/docs): - README.md's "# Shorebird Docs" heading - The Framework Search Paths heading in hybrid-apps/ios.mdx, which a review commit deliberately reverted to Title Case as the literal Xcode setting name Also moves Headings-specific exceptions out of .vale.ini's global TokenIgnores and into Headings.yml's own exceptions list, since that scopes them to just the Headings rule instead of blunting every rule for that file. Confirmed the capitalization extension supports exact multi-word phrase exceptions (e.g. "Azure Key Vault"), not just single words. This surfaced two real regressions along the way, both fixed: - Removing "vs" from the global ignore (now scoped correctly) revealed that "Flutter vs. React Native" was never actually resolved - it needed "React Native" recognized as its own proper noun. - Adding common words (Cloud, Reload, Framework) as bare exceptions triggers a bidirectional matching behavior in Vale's capitalization exceptions: it flags any *lowercase* use of that word elsewhere as wrongly-cased, wanting it to match the exception's given casing. Confirmed with minimal repros. Reverted those three to phrase-level exceptions (Framework Search Paths, GCP Cloud KMS) or, for "Flutter Hot Reload" specifically, kept it in .vale.ini's TokenIgnores since even the phrase-level exception collides with ordinary "hot reload" prose used elsewhere and TokenIgnores' literal-text redaction doesn't have this case-insensitive side effect. Verified 0 errors from `vale --config=.vale.ini .` (matching what CI actually scans) after this change. --- .vale.ini | 44 +++++++++++++++++------------ .vale/styles/Shorebird/Headings.yml | 12 ++++++++ README.md | 2 +- 3 files changed, 39 insertions(+), 19 deletions(-) diff --git a/.vale.ini b/.vale.ini index 61d739d0..0089706f 100644 --- a/.vale.ini +++ b/.vale.ini @@ -20,21 +20,29 @@ Vale.Repetition = NO # a genuine Vale bug (verified with minimal repros), not a config mistake. # Proper-noun capitalization is still reported, just doesn't block CI. Vale.Terms = warning -# Known, permanent exceptions found while fixing every heading and proper -# noun in the docs (see PRs #579 and #583): -# - Shorebird.Headings: "vs"/"vs." is flagged unconditionally by Vale's -# capitalization rule, regardless of surrounding text or the exceptions -# list. Compound product/brand names (Azure Key Vault, GCP Cloud KMS, App -# Store Connect, Firebase Remote Config, Launch Darkly, Hot Reload) and -# three numbered-list headings kept as Title Case for consistency are -# left as per-word exception matching breaks those phrases apart. -# - Vale.Terms: domains, an email address, a config filename mentioned two -# different ways, a GitHub issue shorthand, and a file path placeholder. -# - Shorebird.Exclamation: a table row documenting the literal "[!]" symbol -# from real `flutter doctor` output. -TokenIgnores = (\bvs\.?\b), (Azure Key Vault), (GCP Cloud KMS), \ - (App Store Connect), (Firebase Remote Config), (Launch Darkly), \ - (Hot Reload), (The Status Enum), (The Single State Class), (The Events), \ - (contact@shorebird\.dev), (console\.shorebird\.dev), \ - (download\.flutter\.dev), (shorebird\.yaml), (shorebird yaml), \ - (shorebirdtech/shorebird#\d+), (/path/to/flutter), (\[!\]) +# Global, rule-agnostic exceptions found while fixing every heading and +# proper noun in the docs (see PRs #579 and #583). Headings-specific +# exceptions (compound brand names, the numbered-list headings, "vs") live +# in .vale/styles/Shorebird/Headings.yml's own exceptions list instead, +# since that's scoped to just that rule. TokenIgnores is only needed here +# for things with no rule-scoped alternative: +# - Vale.Terms: a built-in, Vocab-driven check with no exceptions list of +# its own. Covers domains, an email address, a config filename mentioned +# two different ways, a GitHub issue shorthand, and a file path +# placeholder. +# - Shorebird.Exclamation: the `existence` extension type doesn't support +# an exceptions list the way `capitalization` does (verified). Covers a +# table row documenting the literal "[!]" symbol from real `flutter +# doctor` output. +# - Shorebird.Headings: "Flutter Hot Reload" can't be a Headings.yml +# exceptions entry (bare "Reload" or the phrase "Hot Reload" both +# collide with ordinary lowercase "hot reload" prose used as headings +# elsewhere - capitalization exceptions match case-insensitively and +# then want the exception's exact case, which misfires there). +# TokenIgnores does plain literal-text redaction with no such +# case-insensitive side effect, so it's the only safe option for this +# one heading. +TokenIgnores = (contact@shorebird\.dev), (console\.shorebird\.dev), \ + (docs\.shorebird\.dev), (download\.flutter\.dev), (shorebird\.yaml), \ + (shorebird yaml), (shorebirdtech/shorebird#\d+), (/path/to/flutter), \ + (\[!\]), (Flutter Hot Reload) diff --git a/.vale/styles/Shorebird/Headings.yml b/.vale/styles/Shorebird/Headings.yml index 4bf2527f..c798e72e 100644 --- a/.vale/styles/Shorebird/Headings.yml +++ b/.vale/styles/Shorebird/Headings.yml @@ -79,3 +79,15 @@ exceptions: - ExportOptions.plist - Skia - Impeller + - vs + - Remote + - Config + - Launch + - Azure Key Vault + - App Store Connect + - The Status Enum + - The Single State Class + - The Events + - Framework Search Paths + - GCP Cloud KMS + - React Native diff --git a/README.md b/README.md index 9bf54eb9..6ef85530 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Shorebird Docs šŸ¦šŸ“š +# Shorebird docs šŸ¦šŸ“š [![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)