From 0632d88dea386975e4935980268c39771bba0eaf Mon Sep 17 00:00:00 2001
From: David LJ <mail@davidlj95.com>
Date: Tue, 12 Nov 2024 22:22:03 +0100
Subject: [PATCH] build: use same pattern for format / lint run scripts (#1033)

---
 .ci/Makefile                                        |  3 ---
 .github/workflows/reusable-style.yml                |  2 +-
 ...ormat__check_all.xml => Format__check__all_.xml} |  6 +++---
 .lintstagedrc.json                                  |  4 ++--
 CONTRIBUTING.md                                     |  8 +++-----
 package.json                                        | 13 +++++++------
 6 files changed, 16 insertions(+), 20 deletions(-)
 rename .idea/runConfigurations/{Format__check_all.xml => Format__check__all_.xml} (64%)

diff --git a/.ci/Makefile b/.ci/Makefile
index 9ca54b61..5df7a1d6 100644
--- a/.ci/Makefile
+++ b/.ci/Makefile
@@ -24,9 +24,6 @@ unit-test-libs:
 unit-test-schematics:
 	cd .. && pnpm run test:unit:schematics:coverage
 
-format-check:
-	cd .. && pnpm run format-check-all
-
 release:
 	cd .. && pnpm semantic-release
 
diff --git a/.github/workflows/reusable-style.yml b/.github/workflows/reusable-style.yml
index 6cee7c96..0053a0b1 100644
--- a/.github/workflows/reusable-style.yml
+++ b/.github/workflows/reusable-style.yml
@@ -13,4 +13,4 @@ jobs:
       - name: Setup
         uses: ./.github/actions/setup
       - name: Format check
-        run: cd .ci && make format-check
+        run: pnpm run format:check
diff --git a/.idea/runConfigurations/Format__check_all.xml b/.idea/runConfigurations/Format__check__all_.xml
similarity index 64%
rename from .idea/runConfigurations/Format__check_all.xml
rename to .idea/runConfigurations/Format__check__all_.xml
index a833c292..dffd3755 100644
--- a/.idea/runConfigurations/Format__check_all.xml
+++ b/.idea/runConfigurations/Format__check__all_.xml
@@ -1,12 +1,12 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Format: check all" type="js.build_tools.npm">
+  <configuration default="false" name="Format: check (all)" type="js.build_tools.npm">
     <package-json value="$PROJECT_DIR$/package.json" />
     <command value="run" />
     <scripts>
-      <script value="format-check-all" />
+      <script value="format:check" />
     </scripts>
     <node-interpreter value="project" />
     <envs />
     <method v="2" />
   </configuration>
-</component>
\ No newline at end of file
+</component>
diff --git a/.lintstagedrc.json b/.lintstagedrc.json
index fe202695..5544fdfc 100644
--- a/.lintstagedrc.json
+++ b/.lintstagedrc.json
@@ -1,5 +1,5 @@
 {
-  "!(*.{json,ts})": ["pnpm run format"],
-  "*.{json,ts}": ["pnpm run lint:code:raw --fix", "pnpm run format"],
+  "!(*.{json,ts})": ["pnpm run format:files"],
+  "*.{json,ts}": ["pnpm run lint:code:files --fix", "pnpm run format:files"],
   ".github/**/*.{yml,yaml}": ["pnpm run lint:gh-actions"]
 }
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 59d1e894..bff4846b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -253,17 +253,15 @@ The global coverage report will be in `lcov`(`.info`) and HTML format.
 You can run
 
 ```sh
-pnpm run format-check-all
+pnpm run format
 ```
 
-To look for formatting errors. And
+To format all files in the repository. Or if just wanting to check if files are properly formatted, run:
 
 ```sh
-pnpm run format-all
+pnpm run format:check
 ```
 
-To fix them all
-
 [Git hooks] are provided to automatically ensure code is formatted before committing it.
 
 ### Lint
diff --git a/package.json b/package.json
index aaa035c9..ae62d77e 100644
--- a/package.json
+++ b/package.json
@@ -9,14 +9,15 @@
     "commitlint-last": "commitlint --last --verbose",
     "coverage:move-to-nyc-output": "rm -rf .nyc_output && mkdir .nyc_output && cp -f $(find coverage -type f -name '*.json') .nyc_output",
     "coverage:report:all": "pnpm run coverage:move-to-nyc-output && nyc report --reporter lcov --report-dir coverage",
-    "format": "prettier --ignore-unknown --write",
-    "format-all": "npm run format -- .",
-    "format-check": "prettier --check",
-    "format-check-all": "npm run format-check -- .",
+    "format": "pnpm run format:files .",
+    "format:check": "pnpm run format:check:files .",
+    "format:check:files": "prettier --check",
+    "format:files": "prettier --ignore-unknown --write",
     "instrument-for-coverage": "./instrument-for-coverage.sh",
     "lint": "pnpm run '/^lint:[\\w-]+$/'",
-    "lint:code": "pnpm run lint:code:raw .",
-    "lint:code:raw": "eslint --max-warnings 0",
+    "lint:code": "pnpm run lint:code:files .",
+    "lint:code:files": "eslint --max-warnings 0",
+    "lint:code:files//": "☝️ lint-staged can't/shouldn't use 'ng lint'",
     "lint:commit-message": "pnpm run commitlint-edit-msg",
     "lint:gh-actions": "./actionlint.sh",
     "ngx-meta:api-documenter": "api-documenter markdown -i ./projects/ngx-meta/api-extractor -o ./projects/ngx-meta/docs/content/api",