Build: Fix linting & docs#33601
Conversation
ndelangen
added
build
📝 WalkthroughWalkthroughTwo files modified: whitespace and CSS selector formatting adjustments in the preview head HTML file, and a simplified description update for the ESLint plugin's default-exports rule in documentation. No functional or logic changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Comment |
| | [`storybook/await-interactions`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/await-interactions.md) | Interactions should be awaited | ✅ | <ul><li>addon-interactions</li><li>flat/addon-interactions</li><li>recommended</li><li>flat/recommended</li></ul> | | ||
| | [`storybook/context-in-play-function`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/context-in-play-function.md) | Pass a context when invoking play function of another story | | <ul><li>recommended</li><li>flat/recommended</li><li>addon-interactions</li><li>flat/addon-interactions</li></ul> | | ||
| | [`storybook/csf-component`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/csf-component.md) | The component property should be set | | <ul><li>csf</li><li>flat/csf</li><li>csf-strict</li><li>flat/csf-strict</li></ul> | | ||
| | [`storybook/default-exports`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/default-exports.md) | Story files (unless using [CSF Next](../../api/csf/csf-next.mdx)) should have a default export | ✅ | <ul><li>csf</li><li>flat/csf</li><li>recommended</li><li>flat/recommended</li><li>csf-strict</li><li>flat/csf-strict</li></ul> | |
There was a problem hiding this comment.
@ndelangen — I'd prefer the detail about CSF Next stay in, if possible.
The error appears to be a versioning one, not a formatting one.
There was a problem hiding this comment.
Strange @kylegach I reset my branch, and ran the build and lint steps, and this change came back.
The error during publishing had this:
error: Your local changes to the following files would be overwritten by checkout:
docs/configure/integration/eslint-plugin.mdx
I'll try some more on my end.
Update: yes it keep getting removed by something in our toolset!
There was a problem hiding this comment.
It's maybe generated by something, based on this:
There was a problem hiding this comment.
Alright. I'll deal with it later. Thanks for the sleuthing!
…ent for story files
…irement for story files
|
As discussed with @kylegach, I'll merge this change as the automation is set up to create. |
2 participants
What I did
Address these:
https://github.com/storybookjs/storybook/actions/runs/21178964765/job/60915649042
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
None required, these are3 only files getting linted and running a compile.
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
Style
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.