Docs: Add codemod script for docs snippets #30315
Open
+319
−1
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.
3 file(s) reviewed, 3 comment(s)
Edit PR Review Bot Settings | Greptile
scripts/snippets/codemod.ts
Outdated
Comment on lines
107
to
108
| const newSnippet = { ...snippet }; | ||
| newSnippet.attributes.tabTitle = 'CSF 4 (experimental)'; |
There was a problem hiding this comment.
style: redundant assignment of tabTitle - it's set again in the attributes spread below
Comment on lines
+176
to
+205
| export function parseAttributes(attributes: string): Record<string, string> { | ||
| const attributeRegex = /([a-zA-Z0-9.-]+)="([^"]+)"/g; | ||
| const result: Record<string, string> = {}; |
There was a problem hiding this comment.
logic: attributeRegex is too permissive - should escape dots and validate attribute names more strictly
Comment on lines
+226
to
+255
| program | ||
| .name('command') | ||
| .description('A minimal CLI for demonstration') |
There was a problem hiding this comment.
style: CLI name and description are placeholder values that should be updated with actual command details
|
View your CI Pipeline Execution ↗ for commit a7bbc4c.
☁️ Nx Cloud last updated this comment at |
yannbf
force-pushed
the
yann/csf-factories-docs-codemod
branch
2 times, most recently
from
831bf94 to
7d38d73
Compare
yannbf
force-pushed
the
yann/csf-factories-base
branch
from
f75b007 to
80c80ac
Compare
Base automatically changed from
yann/csf-factories-base
to
kasper/csf-factories
January 21, 2025 11:30
yannbf
force-pushed
the
yann/csf-factories-docs-codemod
branch
from
7d38d73 to
a7bbc4c
Compare
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
This PR adds a new command to the scripts directory to be able to run codemods in our own documentation file.
Based on a specified codemod and glob, it will essentially go through all of the files, extract all snippets from that given file, go through some logic to define which target snippets should be migrated, then apply the codemod to those snippets.
You can run it like so in the scripts directory:
for instance:
available codemods:
csf-factory-story (for stories snippets), csf-factory-config (for preview.js/main.js snippets)
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
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 canary-release-pr.yml --field pr=<PR_NUMBER>Greptile Summary
Adds a new codemod script for transforming documentation code snippets to CSF 4 format, with functionality to extract, transform, and append updated snippets while maintaining original content.
scripts/snippets/codemod.tswith snippet extraction and transformation logic using concurrent processingSNIPPETS_DIRECTORYconstant inscripts/utils/constants.tspointing to '_snippets' directorydocs:codemodscript command andglobbydependency inscripts/package.json