Vue3: Specify a specific version for non-dev dependency#34794
Conversation
|
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 ignored due to path filters (1)
📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe Vue 3 renderer's ChangesVue 3 Renderer Dependencies
🎯 1 (Trivial) | ⏱️ ~2 minutes 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 |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
code/renderers/vue3/package.json (1)
61-61: ⚡ Quick winConsider pinning
vue-tscto a specific version for consistency.While this PR correctly addresses the non-dev dependency issue,
vue-tscin devDependencies still uses"latest". Although devDependencies may have different version management requirements, using"latest"can still causenpm cifailures when the lockfile becomes outdated.For consistency with the approach taken on line 54, consider pinning this to a specific semver range in a future update.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@code/renderers/vue3/package.json` at line 61, Replace the devDependency entry "vue-tsc": "latest" with a pinned semver range (not "latest") to ensure reproducible installs; update the devDependencies in package.json by changing the "vue-tsc" value to a specific semver range (e.g., ^X.Y.Z) consistent with the pinning strategy used for the other tool on line 54 so the lockfile and npm ci remain stable.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@code/renderers/vue3/package.json`:
- Line 61: Replace the devDependency entry "vue-tsc": "latest" with a pinned
semver range (not "latest") to ensure reproducible installs; update the
devDependencies in package.json by changing the "vue-tsc" value to a specific
semver range (e.g., ^X.Y.Z) consistent with the pinning strategy used for the
other tool on line 54 so the lockfile and npm ci remain stable.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 3e51c526-2d7a-4f2c-8b62-89ed4bcb969e
📒 Files selected for processing (1)
code/renderers/vue3/package.json
|
Note right now we've added an override to our package.json to resolve this: Using overrides feels like a bit of a hack. |
Vue3: Specify a specific version for non-dev dependency (cherry picked from commit 5d01984)
What I did
When Storybook is part of your CI pipeline, you may decide to use
npm cifor this purpose as it ensures your dependencies are a known set. This is the intended use ofnpm ci. Unfortunately, the "latest" dependency forces the latest version, andnpm ciwill break as the lock file is out of date. This commit just sets the latest version as the listed dependencyChecklist for Contributors
Testing
N/A
Although you can
npm ciaftervue-component-type-helpersreleases a version (they did so recently) and see the existing problem.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