From 231a9b1c8db98c14c50a9f0cba99261d91da8c76 Mon Sep 17 00:00:00 2001 From: Greg Annandale Date: Tue, 31 Mar 2026 16:04:34 +0100 Subject: [PATCH] chore(docs): add Prettier config (and ignore) for docs --- package-lock.json | 33 ++++++++++++++++++--------------- packages/docs/.prettierignore | 14 ++++++++------ packages/docs/.prettierrc.json | 5 +++++ packages/docs/package.json | 7 +++++-- 4 files changed, 36 insertions(+), 23 deletions(-) create mode 100644 packages/docs/.prettierrc.json diff --git a/package-lock.json b/package-lock.json index 9c5bdd1dc..9286ac107 100644 --- a/package-lock.json +++ b/package-lock.json @@ -15607,6 +15607,22 @@ "postcss": "^8.4.31" } }, + "node_modules/prettier": { + "version": "3.8.1", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.8.1.tgz", + "integrity": "sha512-UOnG6LftzbdaHZcKoPFtOcCKztrQ57WkHDeRD9t/PTQtmT0NHSeWWepj6pS0z/N7+08BHFDQVUrfmfMRcZwbMg==", + "dev": true, + "license": "MIT", + "bin": { + "prettier": "bin/prettier.cjs" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/prettier/prettier?sponsor=1" + } + }, "node_modules/pretty-error": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/pretty-error/-/pretty-error-4.0.0.tgz", @@ -25270,20 +25286,6 @@ "node": ">= 0.8.0" } }, - "packages/blockly/node_modules/prettier": { - "version": "3.6.2", - "dev": true, - "license": "MIT", - "bin": { - "prettier": "bin/prettier.cjs" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/prettier/prettier?sponsor=1" - } - }, "packages/blockly/node_modules/prettier-linter-helpers": { "version": "1.0.0", "dev": true, @@ -26889,7 +26891,8 @@ "@docsearch/core": "^4.5.2", "@docusaurus/module-type-aliases": "3.9.2", "@docusaurus/types": "3.9.2", - "gh-pages": "^6.3.0" + "gh-pages": "^6.3.0", + "prettier": "^3.8.1" }, "engines": { "node": ">=20.0.0" diff --git a/packages/docs/.prettierignore b/packages/docs/.prettierignore index 55a939c53..881186813 100644 --- a/packages/docs/.prettierignore +++ b/packages/docs/.prettierignore @@ -1,8 +1,10 @@ -# Docs -# TODO: Format handwritten docs but not api reference docs -docs/* -docs/reference +# Generated API reference docs +docs/reference/ -# misc -node_modules/* +# Build artifacts +build/ +.docusaurus/ +node_modules/ + +# Auto-generated CHANGELOG.md diff --git a/packages/docs/.prettierrc.json b/packages/docs/.prettierrc.json new file mode 100644 index 000000000..0e3ca8413 --- /dev/null +++ b/packages/docs/.prettierrc.json @@ -0,0 +1,5 @@ +{ + "singleQuote": true, + "bracketSameLine": true, + "proseWrap": "preserve" +} diff --git a/packages/docs/package.json b/packages/docs/package.json index a5e51e1a8..bb49c88a4 100644 --- a/packages/docs/package.json +++ b/packages/docs/package.json @@ -12,7 +12,9 @@ "clear": "docusaurus clear", "serve": "docusaurus serve", "write-translations": "docusaurus write-translations", - "write-heading-ids": "docusaurus write-heading-ids" + "write-heading-ids": "docusaurus write-heading-ids", + "format": "prettier --write .", + "format:check": "prettier --check ." }, "dependencies": { "@docusaurus/core": "3.9.2", @@ -30,7 +32,8 @@ "@docsearch/core": "^4.5.2", "@docusaurus/module-type-aliases": "3.9.2", "@docusaurus/types": "3.9.2", - "gh-pages": "^6.3.0" + "gh-pages": "^6.3.0", + "prettier": "^3.8.1" }, "browserslist": { "production": [