Manager: Add tags property to ComponentEntry objects #29343
Merged
Conversation
This file contains 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
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
5 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile
| @@ -0,0 +1,14 @@ | |||
| export default <T>(a: T[], b: T[]): T[] => { | |||
| // no point in intersecting if one of the input is ill-defined | |||
| if (!a || !b) { | |||
There was a problem hiding this comment.
style: Consider using Array.isArray() for more robust type checking
| } | ||
|
|
||
| return a.reduce((acc: T[], aValue) => { | ||
| if (b.includes(aValue)) { |
There was a problem hiding this comment.
style: For large arrays, consider using a Set for better performance
☁️ Nx Cloud ReportCI is running/has finished running commands for commit d60a9d7. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
5 tasks
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.
What I did
I added a piece of logic to the code converting the story index to story hashes for use in the manager (
transformStoryIndexToStoriesHash).This extra code computes a
tagsproperty for Component entries, which is the intersection of all their stories' hashes. This enables me to display hashes in the sidebar, and this gist from a third party shows that others have sought to achieve the same thing in the past.Having a definition of tags for component entries allows us to separate story-specific tags from component-specific tags and imo gives a clearer meaning to the
tagsadded to a CSF meta.Below are screenshots of what can be achieved with tags with and without this PR.
Without this PR
With this PR
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
code/core/src/manager/components/panel/Panel.stories.tsxto havetags: ['myCustomTag'],renderLabelfunction of your choice to be able to inspect the entry, or console log incode/core/src/manager/components/sidebar/Tree.tsx'sNodectorDocumentation
MIGRATION.MD
Caution
I am not sure what the most appropriate documentation format is for this. Guidance is welcome.
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/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 canary-release-pr.yml --field pr=<PR_NUMBER>Greptile Summary
This PR adds a new
tagsproperty to ComponentEntry objects, computed as the intersection of all their stories' tags, enhancing tag organization and display in the Storybook sidebar.intersectfunction incode/core/src/manager-api/lib/intersect.tsfor efficient array intersectiontransformStoryIndexToStoriesHashincode/core/src/manager-api/lib/stories.tsto compute component tagsintersectfunction incode/core/src/manager-api/tests/intersect.test.tsAPI_ComponentEntryinterface incode/core/src/types/modules/api-stories.tsto includetagspropertycode/core/src/manager-api/tests/stories.test.tsto verify component tag computation