Build: Simplify lint-staged formatting with '*' glob#34605
Closed
kasperpeulen wants to merge 3 commits into
Closed
Build: Simplify lint-staged formatting with '*' glob#34605kasperpeulen wants to merge 3 commits into
kasperpeulen wants to merge 3 commits into
Conversation
Align pre-commit with CI, which runs yarn fmt:check (oxfmt) on the whole repo.
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughUpdated lint-staged to run Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
✨ Finishing Touches📝 Generate docstrings
Comment |
- Format .lintstagedrc.mjs (CI fmt:check) - Match root files that oxfmt formats but sit outside code/scripts/docs_snippets
- oxfmt respects .oxfmtrc.json ignorePatterns and skips unknown extensions when given explicit file paths, so a single '*' entry keeps pre-commit aligned with CI (yarn fmt:check) without enumerating every root config path. - Pass --concurrent=false to lint-staged to avoid races when multiple globs match the same file (e.g. oxfmt from '*' vs eslint --fix from 'code/**').
Member
Author
|
Closing — going to handle this via Cursor hooks instead of lint-staged changes. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #
What I did
CI enforces
yarn fmt:check(rootoxfmt --check .) on the whole repo, but pre-commit only ranoxfmtforcode/**anddocs/_snippets/**. Files like.lintstagedrc.mjs,nx.json, or anything underscripts/**could drift until CI failed.Instead of enumerating every covered path, take advantage of oxfmt already:
.oxfmtrc.jsonignorePatternswhen given explicit file paths, andThat makes a single
'*'glob safe and keeps pre-commit aligned with CI automatically, even for new files at the repo root or in new directories.Also switch
yarn lint-stagedto--concurrent=falseso overlapping globs (e.g.oxfmtfrom'*'andeslint --fixfromcode/**) don't race on the same file.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
Caution
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Verified locally:
yarn fmt:checkpasses on the whole repo..lintstagedrc.mjstriggersoxfmtvia the*group and fixes it (withFIX_ON_COMMIT=1) / fails the commit (without), matching CI..husky/pre-commit) are still picked up by the*group and either skipped (unknown extension) or formatted as appropriate.Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>Summary by CodeRabbit