CLI: Remove any return type of getAbsolutePath#32977
Conversation
📝 WalkthroughWalkthroughA single function's explicit return type annotation has been removed from a generated code snippet within the baseGenerator, changing the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes ✨ Finishing touches
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used📓 Path-based instructions (4)**/*.{js,jsx,json,html,ts,tsx,mjs}📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Files:
**/*.{ts,tsx,js,jsx,mjs}📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Files:
code/**/*.{ts,tsx,js,jsx,mjs}📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Files:
{code/**,scripts/**}/**/*.{ts,tsx,js,jsx,mjs}📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Files:
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
🔇 Additional comments (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Package BenchmarksCommit: The following packages have significant changes to their size or dependencies:
|
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 156 | 157 | 🚨 +1 🚨 |
| Self size | 31 KB | 31 KB | 🚨 +150 B 🚨 |
| Dependency size | 23.05 MB | 23.11 MB | 🚨 +64 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
What I did
Removes the unnecessary
anyreturn type from the auto-generatedgetAbsolutePathfunction in the.storybook/main.tsfile of monorepo projects.This function always return a string. I also checked past PRs related to this code but found no clear reason why the
anytype was specified. In general, when a project uses linter like ESLint, theanytype would trigger an error, so unnecessaryanytypes should not be used.ref: https://nodejs.org/docs/latest-v20.x/api/path.html#pathdirnamepath
ref: #23458
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
Since I wasn’t sure how to create a monorepo project on the Storybook sandbox, I manually set up the environment.
npx create-turbo@latestyarn add path/to/create-storybookyarn create-storybook.storybook/main.tsDocumentation
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