tooling: update pre-commit hook to stop failure propagation of no-import rule of missing dependencies #5430
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| '@spectrum-web-components/icon': minor | ||
| --- | ||
|
|
||
| fix: added missing reactive controller dependency for IconBase which was importing SystemContextResolution for context switching | ||
| Moved all linting, formatting, and static analysis logic (ESLint, Stylelint, Prettier, Lit Analyzer) into a centralized lint-staged configuration. Simplifies the pre-commit hook by delegating to `yarn lint-staged`, improving maintainability and consistency across contributors. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,4 @@ | ||
| #!/bin/bash | ||
| set -e | ||
| echo "Running pre-commit hook via lint-staged..." | ||
| yarn lint-staged --allow-empty | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,46 @@ | ||||||||||||||||||
| /* eslint-disable no-console */ | ||||||||||||||||||
| /* | ||||||||||||||||||
| 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. | ||||||||||||||||||
| */ | ||||||||||||||||||
| import { execSync } from 'child_process'; | ||||||||||||||||||
|
|
||||||||||||||||||
| export default { | ||||||||||||||||||
| // Runs ESLint with fix on all staged JS/TS files | ||||||||||||||||||
| '*.{js,ts}': (files) => { | ||||||||||||||||||
|
There was a problem hiding this comment. So lint-staged is great because it actually shows you the files it's running against so you don't need to echo the file list. It also enables parallelization so unless the command requires it, you don't have to pass the files in manually. For example: |
||||||||||||||||||
| console.log('Running ESLint on:', files.join(' ')); | ||||||||||||||||||
| return [`eslint --fix ${files.join(' ')}`]; | ||||||||||||||||||
| }, | ||||||||||||||||||
|
|
||||||||||||||||||
| // Runs lit-analyzer only on relevant .ts files inside src (excluding .css) | ||||||||||||||||||
| '{packages,tools}/*/src/**/!(*.css).ts': (files) => { | ||||||||||||||||||
| console.log('Running lit-analyzer on:', files.join(' ')); | ||||||||||||||||||
| return [`lit-analyzer ${files.join(' ')}`]; | ||||||||||||||||||
| }, | ||||||||||||||||||
|
|
||||||||||||||||||
| // Runs stylelint with fix on all staged CSS files | ||||||||||||||||||
| '{packages,tools}/**/*.css': (files) => { | ||||||||||||||||||
| console.log('Running stylelint on:', files.join(' ')); | ||||||||||||||||||
| return [`stylelint --fix ${files.join(' ')}`]; | ||||||||||||||||||
| }, | ||||||||||||||||||
|
Comment on lines
+29
to
+32
There was a problem hiding this comment.
Suggested change
Since stylelint has rules about which css files it will run against, we can pass any css file from the list and it will only run if it matches the rules. This lets us manage the CSS rules from the stylelint config instead of having to replicate it here too. |
||||||||||||||||||
|
|
||||||||||||||||||
| // Formats selected staged files with Prettier | ||||||||||||||||||
| '!(*.css|*.ts)': [ | ||||||||||||||||||
| 'prettier --cache --no-error-on-unmatched-pattern --ignore-unknown --log-level silent --write', | ||||||||||||||||||
| ], | ||||||||||||||||||
|
|
||||||||||||||||||
| // Generates and add version file | ||||||||||||||||||
| // This will always re-run and stage version.js | ||||||||||||||||||
| 'tools/base/src/version.js': () => { | ||||||||||||||||||
| console.log('Generating version file...'); | ||||||||||||||||||
| execSync('yarn genversion --es6 --semi tools/base/src/version.js'); | ||||||||||||||||||
| return 'git add tools/base/src/version.js'; | ||||||||||||||||||
|
Comment on lines
+41
to
+44
There was a problem hiding this comment.
Suggested change
This approach will still run them in parallel but it avoids using the exec function which is really problematic in scripts due to it's inconsistent way of returning warnings and information from the console. |
||||||||||||||||||
| }, | ||||||||||||||||||
| }; | ||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I've noticed this issue as well, however here's the documentation around why we added the bash wrapper: https://typicode.github.io/husky/how-to.html#bash
We're not currently supporting Windows so it seemed a fine compromise. The if syntax however is Bash syntax so removing that would be a potential issue. What do you suggest?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was thinking we could migrate all these rules into a lint-staged config and just run the
yarn lint-stagedcommand here instead of all this logic. What are your thoughts? Was playing around with that here: #5393There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the idea of migrate these in a module in a lint-staged config. More scalable. Let me update this here and test. Please feel free to add your thoughts too!