Skip to content

A platform for community discussion. Free, open, simple.

DEV: Lint `docs/developer-guides` in the pre-commit hook (#42561)

Sérgio Saquetim9de93f779249
diff --git a/bin/lint b/bin/lint
index 2fa3ad3d431..a95d75082f1 100755
--- a/bin/lint
+++ b/bin/lint
@@ -239,7 +239,26 @@ class LefthookLinter
end
# Check if file extension is lintable
- lintable_extensions = %w[rb rake js gjs cjs mjs ts gts mts cts hbs scss css yml yaml thor]
+ lintable_extensions = %w[
+ rb
+ rake
+ js
+ gjs
+ cjs
+ mjs
+ ts
+ gts
+ mts
+ cts
+ hbs
+ scss
+ css
+ yml
+ yaml
+ thor
+ md
+ json
+ ]
lintable_extensions.include?(ext)
end
diff --git a/lefthook.yml b/lefthook.yml
index 4ad3ffc1b19..648f4e1d0cb 100644
--- a/lefthook.yml
+++ b/lefthook.yml
@@ -35,6 +35,14 @@ pre-commit:
- "plugins/**/*.{js,gjs,ts,gts,mts,cts,scss,css,cjs,mjs}"
- "themes/**/*.{js,gjs,ts,gts,mts,cts,scss,css,cjs,mjs}"
run: pnpm pprettier --list-different {staged_files}
+ # docs/developer-guides is its own pnpm workspace package with its own
+ # prettier config. It needs `root` so prettier runs with that directory as
+ # its cwd: the repo-root .prettierignore ignores **/*.md, so a run from the
+ # root silently checks nothing and exits 0.
+ developer-docs-prettier:
+ root: &developer_docs_root "docs/developer-guides/"
+ glob: &developer_docs_glob "docs/developer-guides/**/*.{md,json,mjs,yml}"
+ run: pnpm prettier --list-different {staged_files}
eslint:
glob: &eslint_glob
- "frontend/**/*.{js,gjs,ts,gts,mts,cts,cjs,mjs}"
@@ -62,6 +70,10 @@ fix-staged:
prettier:
glob: *prettier_glob
run: pnpm pprettier --write {staged_files}
+ developer-docs-prettier:
+ root: *developer_docs_root
+ glob: *developer_docs_glob
+ run: pnpm prettier --write {staged_files}
eslint:
glob: *eslint_glob
run: pnpm eslint --fix --no-warn-ignored {staged_files}
@@ -101,6 +113,11 @@ lint-files:
files: *working_tree_files
glob: *prettier_glob
run: pnpm pprettier --list-different {files}
+ developer-docs-prettier:
+ files: *working_tree_files
+ root: *developer_docs_root
+ glob: *developer_docs_glob
+ run: pnpm prettier --list-different {files}
eslint:
files: *working_tree_files
glob: *eslint_glob
@@ -126,6 +143,11 @@ fix-files:
files: *working_tree_files
glob: *prettier_glob
run: pnpm pprettier --write {files}
+ developer-docs-prettier:
+ files: *working_tree_files
+ root: *developer_docs_root
+ glob: *developer_docs_glob
+ run: pnpm prettier --write {files}
eslint:
files: *working_tree_files
glob: *eslint_glob