Contrib note fix and CI/CD pre-commit hook prep (#8314)

Author: chalin

content/en/docs/contributing/pr-checks.md

@@ -82,15 +82,15 @@ This check will verify that all words in your cSpell ignore list are normalized.
 If this check fails, run `npm run fix:dict` locally and push the changes in a
 new commit.
 
-### `FILENAME check` {.notranslate lang=en}
+### `FILE FORMAT` {.notranslate lang=en}
 
-This check verifies that all
-[files are formatted by prettier](../style-guide/#file-format).
+This check verifies that all files conform to
+[Prettier format rules](../style-guide/#file-format).
 
 If this check fails, run `npm run fix:format` locally and push the changes in a
 new commit.
 
-### `FILE FORMAT` {.notranslate lang=en}
+### `FILENAME check` {.notranslate lang=en}
 
 This check verifies that all
 [file names are in kebab-case](../style-guide/#file-names).

content/en/docs/contributing/style-guide.md

@@ -88,8 +88,13 @@ title: registryEntryTitle
 
 ## File format
 
-We enforce file formatting using [Prettier]. Invoke it using
-`npm run fix:format`.
+We use [Prettier] to enforce file formatting. Invoke it using:
+
+- `npm run fix:format` to format all files
+- `npm run fix:format:diff` to format only the files that have changed since the
+  last commit
+- `npm run fix:format:staged` to format only the files that are staged for the
+  next commit
 
 ## File names
 

package.json

@@ -7,7 +7,7 @@
     "__check:links": "make --keep-going check-links",
     "__check:format:nowrap": "npm run _check:format:any -- --prose-wrap preserve",
     "_build": "npm run _hugo -- -e dev --buildDrafts --buildFuture --baseURL \"${DEPLOY_PRIME_URL:-http://localhost}\"",
-    "__check:format": "./scripts/npx-helper.sh prettier",
+    "__check:format": "./scripts/npx-helper.sh prettier --ignore-unknown",
     "_check:format:any": "npm run __check:format -- --check --ignore-path ''",
     "_check:format:nowrap": "npm run __check:format:nowrap -- content/ja content/uk content/zh",
     "_check:format": "npm run __check:format -- --check .",
@@ -24,7 +24,7 @@
     "_fail": "exit 1",
     "_filename-error": "echo 'ERROR: the following files violate naming conventions; fix using: `npm run fix:filenames`'; echo; npm run -s _ls-bad-filenames; exit 1",
     "_fix:trailing-spaces": "find content -name '*.md' -exec perl -i -pe 's/[ \t]+$//g' {} +",
-    "_fix:format:diff": "npm run __check:format -- --write $(npm -s run _list:diff)",
+    "_fix:format:diff": "npm run __check:format -- --write",
     "_get:no": "echo SKIPPING get operation",
     "_get:submodule": "set -x && git submodule update --init ${DEPTH:- --depth 999}",
     "_hugo": "hugo --cleanDestinationDir",
@@ -33,7 +33,8 @@
     "_list:check:*": "npm run --loglevel=warn | grep -Ee '^\\s*check:[^:]+$'",
     "_list:check:for-test-and-fix": "npm -s run _list:check:* | grep -Ev \"i18n|${CMD_SKIP:-noop}\"",
     "_list:dict": "grep '^\\s*\"@cspell' package.json | awk -F: '{print $1}'  | tr -d '\"'",
-    "_list:diff": "git diff --name-only --diff-filter=AM",
+    "_list:diff-never-empty": "echo README.md && npm run _list:diff",
+    "_list:diff": "git diff --name-only --diff-filter=AMR",
     "_list:fix:*": "npm run --loglevel=warn | grep -Ee '^\\s*fix:[^:]+$' | grep -v 'fix:all'",
     "_list:fix:for-test-and-fix": "npm -s run _list:fix:* | grep -Ev \"i18n|refcache|submodule|${CMD_SKIP:-noop}\"",
     "_ls-bad-filenames": "find assets content static -name '*_*' ! -name '[_.]*'",
@@ -72,6 +73,8 @@
     "fix:dict": "find content layouts -name \"*.md\" -print0 | xargs -0 scripts/normalize-cspell-front-matter.pl",
     "fix:expired": "npm run -s check:expired -- -q | xargs -r -I {} sh -c 'echo \"Deleting expired file: {}\" && rm {}'",
     "fix:filenames": "npm run _rename-to-kebab-case",
+    "fix:format:diff": "npm run _fix:format:diff -- $(npm -s run _list:diff-never-empty)",
+    "fix:format:staged": "npm run _fix:format:diff -- $(npm -s run _list:diff-never-empty -- --cached)",
     "fix:format": "npm run format; npm run _fix:trailing-spaces",
     "fix:htmltest-config": "scripts/htmltest-config.sh",
     "fix:i18n:status": "scripts/check-i18n.sh -D",

scripts/git/pre-commit.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+#
+# Pre-commit hook that runs formatting on staged files
+#
+
+exec npm run fix:format:staged
+