chore: swap out pretty-quick and manual linting for lint-staged

castastrophe · castastrophe · commit 2c54cb8c1758 · 2025-05-06T11:03:47.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -62,8 +62,9 @@ tools/**/*.test-vrt.ts
 !tools/base/src/version.js
 !tools/base/src/version.d.ts
 
-
+# cache directories
 .wireit
+.eslintcache
 
 stats.html
 
@@ -111,4 +112,4 @@ chromatic.config.json
 !.yarn/plugins
 !.yarn/releases
 !.yarn/sdks
-!.yarn/versio;/
+!.yarn/version
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,16 +1,8 @@
 #!/usr/bin/env bash
 bash << EOF
-    STAGED_FILES_TO_LINT=$(git diff --name-only --cached --diff-filter=d -- "*.ts" "*.js")
-    STAGED_FILES_TO_ANALYZE=$(git diff --name-only --cached --diff-filter=d -- "{packages,tools}/*/src/**/!(*.css).ts")
-    STAGED_CSS_FILES=$(git diff --name-only --cached --diff-filter=d -- "{packages,tools}/**/*.css")
-    VERSION_FILE=$(dirname "$0")/../tools/base/src/version.js
-
-    [ -z "$STAGED_FILES_TO_LINT" ] || yarn eslint -f pretty $STAGED_FILES_TO_LINT
-    [ -z "$STAGED_FILES_TO_ANALYZE" ] || yarn lit-analyzer $STAGED_FILES_TO_ANALYZE
-    [ -z "$STAGED_CSS_FILES" ] || yarn stylelint $STAGED_CSS_FILES
-
-    yarn pretty-quick --staged
+    yarn lint-staged
 
+    VERSION_FILE=$(dirname "$0")/../tools/base/src/version.js
     yarn genversion --es6 --semi $VERSION_FILE
     git add $VERSION_FILE
 EOF
diff --git a/lint-staged.config.js b/lint-staged.config.js
@@ -0,0 +1,29 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+export default {
+    '*': [
+        'prettier --cache --no-error-on-unmatched-pattern --ignore-unknown --log-level silent --write',
+    ],
+    '*.css': [
+        'stylelint --fix --cache --allow-empty-input --report-descriptionless-disables --report-invalid-scope-disables --report-needless-disables',
+    ],
+    '{packages,tools}/**/*.ts': [
+        'eslint --fix --format pretty --cache --no-error-on-unmatched-pattern --quiet',
+    ],
+    '{packages,tools}/*/src/**/!(*.css).ts': ['yarn lit-analyzer'],
+    'package.json': () => [
+        'yarn constraints --fix',
+        'yarn install --refresh-lockfile',
+        'git add yarn.lock',
+    ],
+};
diff --git a/package.json b/package.json
@@ -36,17 +36,12 @@
         "docs:review": "alex packages/**/*.md",
         "docs:start": "yarn workspace documentation serve --watch",
         "find": "test -f custom-elements.json",
-        "format:css": "yarn lint:css --fix && pretty-quick --pattern \"{packages,tools}/**/*.css\"",
+        "format:css": "stylelint --fix --cache --allow-empty-input --report-descriptionless-disables --report-invalid-scope-disables --report-needless-disables {packages,tools}/**/*.css && prettier --no-error-on-unmatched-pattern --ignore-unknown --log-level silent --write --config .prettierrc {packages,tools}/**/*.css",
         "gen-react-wrapper": "node ./tasks/gen-react-wrapper.js",
         "icons": "wireit",
         "icons:ui": "wireit",
         "icons:workflow": "wireit",
-        "lint": "run-p lint:js lint:docs lint:ts lint:css lint:packagejson",
-        "lint:css": "stylelint \"packages/**/*.css\" \"tools/**/*.css\"",
-        "lint:docs": "eslint -f pretty \"projects/documentation/**/*.ts\"",
-        "lint:js": "pretty-quick --pattern \"tasks/**/*.js\" && pretty-quick --pattern \"scripts/**/*.js\"",
-        "lint:packagejson": "pretty-quick --pattern package.json --pattern \"packages/*/package.json\" --pattern \"projects/*/package.json\" --pattern \"tools/*/package.json\" --pattern \"react/*/package.json\"",
-        "lint:ts": "pretty-quick --pattern \"packages/**/*.ts\" && eslint -f pretty \"packages/**/*.ts\" && pretty-quick --pattern \"tools/**/*.ts\" && eslint -f pretty \"tools/**/*.ts\"",
+        "lint": "git status --porcelain && git add . && yarn lint-staged",
         "lint:versions": "node ./scripts/lint-versions.js",
         "new-package": "cd projects/templates && plop",
         "postcustom-element-json": "node ./tasks/run-check-cem.js",
@@ -90,7 +85,7 @@
         "test:watch:flags:focus": "yarn build && run-p build:watch \"test:start --watch --group {1} --config web-test-runner.config.ci-chromium-flags.js\" --",
         "test:watch:focus": "yarn build && run-p build:watch \"test:start --watch --group {1}\" --",
         "update:spectrum-css": "node ./scripts/update-spectrum-css.js --latest || yarn update:spectrum-css:cleanup",
-        "update:spectrum-css:cleanup": "yarn lint:packagejson && yarn --ignore-scripts && yarn process-spectrum",
+        "update:spectrum-css:cleanup": "yarn lint-staged && yarn --ignore-scripts && yarn process-spectrum",
         "update:spectrum-css:nonbreaking": "node ./scripts/update-spectrum-css.js || yarn update:spectrum-css:cleanup",
         "verify-build-artifacts": "node ./scripts/verify-build-artifacts.js",
         "vrt:preview": "yarn wds --config test/visual/wds-vrt.config.js",
@@ -175,6 +170,7 @@
         "husky": "^9.0.10",
         "latest-version": "^9.0.0",
         "lightningcss": "1.19.0",
+        "lint-staged": "^15.5.1",
         "lit": "^2.5.0 || ^3.1.3",
         "lit-analyzer": "^2.0.3",
         "lit-html": "^2.4.0 || ^3.1.3",
@@ -185,10 +181,9 @@
         "npm-run-all2": "^6.0.0",
         "patch-package": "^8.0.0",
         "pinst": "^3.0.0",
-        "prettier": "^3.0.0",
+        "prettier": "^3.5.3",
         "prettier-plugin-package": "^1.3.0",
         "pretty-bytes": "^6.1.1",
-        "pretty-quick": "^4.1.1",
         "re-template-tag": "^2.0.1",
         "rimraf": "^5.0.1",
         "rollup": "^4.12.0",
@@ -321,7 +316,7 @@
             ]
         },
         "icons": {
-            "command": "node ./scripts/process-icons.js && pretty-quick --pattern \"packages/**/*.svg.ts\" && eslint -f pretty --fix \"packages/**/*.svg.ts\"",
+            "command": "node ./scripts/process-icons.js && git status --porcelain && git add . && yarn lint-staged",
             "files": [
                 "scripts/process-icons.js"
             ],
diff --git a/yarn.lock b/yarn.lock
@@ -284,6 +284,7 @@ __metadata:
     husky: "npm:^9.0.10"
     latest-version: "npm:^9.0.0"
     lightningcss: "npm:1.19.0"
+    lint-staged: "npm:^15.5.1"
     lit: "npm:^2.5.0 || ^3.1.3"
     lit-analyzer: "npm:^2.0.3"
     lit-html: "npm:^2.4.0 || ^3.1.3"
@@ -294,10 +295,9 @@ __metadata:
     npm-run-all2: "npm:^6.0.0"
     patch-package: "npm:^8.0.0"
     pinst: "npm:^3.0.0"
-    prettier: "npm:^3.0.0"
+    prettier: "npm:^3.5.3"
     prettier-plugin-package: "npm:^1.3.0"
     pretty-bytes: "npm:^6.1.1"
-    pretty-quick: "npm:^4.1.1"
     re-template-tag: "npm:^2.0.1"
     rimraf: "npm:^5.0.1"
     rollup: "npm:^4.12.0"
@@ -13689,6 +13689,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"chalk@npm:^5.4.1":
+  version: 5.4.1
+  resolution: "chalk@npm:5.4.1"
+  checksum: 10c0/b23e88132c702f4855ca6d25cb5538b1114343e41472d5263ee8a37cccfccd9c4216d111e1097c6a27830407a1dc81fecdf2a56f2c63033d4dbbd88c10b0dcef
+  languageName: node
+  linkType: hard
+
 "change-case@npm:^4.1.2":
   version: 4.1.2
   resolution: "change-case@npm:4.1.2"
@@ -14413,6 +14420,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"commander@npm:^13.1.0":
+  version: 13.1.0
+  resolution: "commander@npm:13.1.0"
+  checksum: 10c0/7b8c5544bba704fbe84b7cab2e043df8586d5c114a4c5b607f83ae5060708940ed0b5bd5838cf8ce27539cde265c1cbd59ce3c8c6b017ed3eec8943e3a415164
+  languageName: node
+  linkType: hard
+
 "commander@npm:^2.19.0, commander@npm:^2.20.0, commander@npm:^2.20.3, commander@npm:^2.8.1":
   version: 2.20.3
   resolution: "commander@npm:2.20.3"
@@ -23350,6 +23364,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"lilconfig@npm:^3.1.3":
+  version: 3.1.3
+  resolution: "lilconfig@npm:3.1.3"
+  checksum: 10c0/f5604e7240c5c275743561442fbc5abf2a84ad94da0f5adc71d25e31fa8483048de3dcedcb7a44112a942fed305fd75841cdf6c9681c7f640c63f1049e9a5dcc
+  languageName: node
+  linkType: hard
+
 "limit-spawn@npm:0.0.3":
   version: 0.0.3
   resolution: "limit-spawn@npm:0.0.3"
@@ -23380,6 +23401,26 @@ __metadata:
   languageName: node
   linkType: hard
 
+"lint-staged@npm:^15.5.1":
+  version: 15.5.1
+  resolution: "lint-staged@npm:15.5.1"
+  dependencies:
+    chalk: "npm:^5.4.1"
+    commander: "npm:^13.1.0"
+    debug: "npm:^4.4.0"
+    execa: "npm:^8.0.1"
+    lilconfig: "npm:^3.1.3"
+    listr2: "npm:^8.2.5"
+    micromatch: "npm:^4.0.8"
+    pidtree: "npm:^0.6.0"
+    string-argv: "npm:^0.3.2"
+    yaml: "npm:^2.7.0"
+  bin:
+    lint-staged: bin/lint-staged.js
+  checksum: 10c0/86deddb08bf10428f2eb96c02326a9ee403360729225f0b12afb0c0f13c287a75daa01e179d86f64e3432576446d8643d204a47417296f9ef0aa56f1340ff2af
+  languageName: node
+  linkType: hard
+
 "liquidjs@npm:^10.17.0":
   version: 10.18.0
   resolution: "liquidjs@npm:10.18.0"
@@ -23442,6 +23483,20 @@ __metadata:
   languageName: node
   linkType: hard
 
+"listr2@npm:^8.2.5":
+  version: 8.3.2
+  resolution: "listr2@npm:8.3.2"
+  dependencies:
+    cli-truncate: "npm:^4.0.0"
+    colorette: "npm:^2.0.20"
+    eventemitter3: "npm:^5.0.1"
+    log-update: "npm:^6.1.0"
+    rfdc: "npm:^1.4.1"
+    wrap-ansi: "npm:^9.0.0"
+  checksum: 10c0/6b6378e28debda863d31f03ffe880a76b45c07388c74e8e0676fc957de7f2aff24fdea7f48b17d12808440f64680215c36df388c79d2b367c7866dd66f75fb09
+  languageName: node
+  linkType: hard
+
 "lit-analyzer@npm:^2.0.3":
   version: 2.0.3
   resolution: "lit-analyzer@npm:2.0.3"
@@ -27751,13 +27806,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"picomatch@npm:^4.0.2":
-  version: 4.0.2
-  resolution: "picomatch@npm:4.0.2"
-  checksum: 10c0/7c51f3ad2bb42c776f49ebf964c644958158be30d0a510efd5a395e8d49cb5acfed5b82c0c5b365523ce18e6ab85013c9ebe574f60305892ec3fa8eee8304ccc
-  languageName: node
-  linkType: hard
-
 "pidtree@npm:^0.6.0":
   version: 0.6.0
   resolution: "pidtree@npm:0.6.0"
@@ -28977,6 +29025,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"prettier@npm:^3.5.3":
+  version: 3.5.3
+  resolution: "prettier@npm:3.5.3"
+  bin:
+    prettier: bin/prettier.cjs
+  checksum: 10c0/3880cb90b9dc0635819ab52ff571518c35bd7f15a6e80a2054c05dbc8a3aa6e74f135519e91197de63705bcb38388ded7e7230e2178432a1468005406238b877
+  languageName: node
+  linkType: hard
+
 "pretty-bytes@npm:^5.3.0, pretty-bytes@npm:^5.5.0":
   version: 5.6.0
   resolution: "pretty-bytes@npm:5.6.0"
@@ -29028,25 +29085,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"pretty-quick@npm:^4.1.1":
-  version: 4.1.1
-  resolution: "pretty-quick@npm:4.1.1"
-  dependencies:
-    find-up: "npm:^5.0.0"
-    ignore: "npm:^7.0.3"
-    mri: "npm:^1.2.0"
-    picocolors: "npm:^1.1.1"
-    picomatch: "npm:^4.0.2"
-    tinyexec: "npm:^0.3.2"
-    tslib: "npm:^2.8.1"
-  peerDependencies:
-    prettier: ^3.0.0
-  bin:
-    pretty-quick: lib/cli.mjs
-  checksum: 10c0/c0362aff7d7679f58c044891047e7bbb03d461543aa30b1c57fef9400fa8c4d1daef4aa2b146a9c9072ce050c60860a88eb64b3fd722826dc56616f7cd1d6011
-  languageName: node
-  linkType: hard
-
 "prettyjson@npm:1.2.5":
   version: 1.2.5
   resolution: "prettyjson@npm:1.2.5"
@@ -31987,6 +32025,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"string-argv@npm:^0.3.2":
+  version: 0.3.2
+  resolution: "string-argv@npm:0.3.2"
+  checksum: 10c0/75c02a83759ad1722e040b86823909d9a2fc75d15dd71ec4b537c3560746e33b5f5a07f7332d1e3f88319909f82190843aa2f0a0d8c8d591ec08e93d5b8dec82
+  languageName: node
+  linkType: hard
+
 "string-similarity@npm:^4.0.4":
   version: 4.0.4
   resolution: "string-similarity@npm:4.0.4"
@@ -33170,7 +33215,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"tinyexec@npm:^0.3.0, tinyexec@npm:^0.3.2":
+"tinyexec@npm:^0.3.0":
   version: 0.3.2
   resolution: "tinyexec@npm:0.3.2"
   checksum: 10c0/3efbf791a911be0bf0821eab37a3445c2ba07acc1522b1fa84ae1e55f10425076f1290f680286345ed919549ad67527d07281f1c19d584df3b74326909eb1f90
@@ -33476,7 +33521,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"tslib@npm:2, tslib@npm:^2.0.0, tslib@npm:^2.0.1, tslib@npm:^2.0.3, tslib@npm:^2.1.0, tslib@npm:^2.3.1, tslib@npm:^2.4.0, tslib@npm:^2.6.2, tslib@npm:^2.8.1":
+"tslib@npm:2, tslib@npm:^2.0.0, tslib@npm:^2.0.1, tslib@npm:^2.0.3, tslib@npm:^2.1.0, tslib@npm:^2.3.1, tslib@npm:^2.4.0, tslib@npm:^2.6.2":
   version: 2.8.1
   resolution: "tslib@npm:2.8.1"
   checksum: 10c0/9c4759110a19c53f992d9aae23aac5ced636e99887b51b9e61def52611732872ff7668757d4e4c61f19691e36f4da981cd9485e869b4a7408d689f6bf1f14e62
@@ -35938,6 +35983,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"yaml@npm:^2.7.0":
+  version: 2.7.1
+  resolution: "yaml@npm:2.7.1"
+  bin:
+    yaml: bin.mjs
+  checksum: 10c0/ee2126398ab7d1fdde566b4013b68e36930b9e6d8e68b6db356875c99614c10d678b6f45597a145ff6d63814961221fc305bf9242af8bf7450177f8a68537590
+  languageName: node
+  linkType: hard
+
 "yargs-parser@npm:^21.1.1":
   version: 21.1.1
   resolution: "yargs-parser@npm:21.1.1"
