-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CLI: Improve add
command & add tests
#26298
Merged
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
ndelangen
changed the title
fix the bug and add tests to ensure it doesn't fail ever again
CLI: Improve Mar 4, 2024
add
command & add tests
ndelangen
commented
Mar 4, 2024
Comment on lines
+1
to
+19
import type { PostinstallOptions } from './add'; | ||
|
||
export const postinstallAddon = async (addonName: string, options: PostinstallOptions) => { | ||
try { | ||
const modulePath = require.resolve(`${addonName}/postinstall`, { paths: [process.cwd()] }); | ||
|
||
const postinstall = require(modulePath); | ||
|
||
try { | ||
console.log(`Running postinstall script for ${addonName}`); | ||
await postinstall(options); | ||
} catch (e) { | ||
console.error(`Error running postinstall script for ${addonName}`); | ||
console.error(e); | ||
} | ||
} catch (e) { | ||
// no postinstall script | ||
} | ||
}; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I extracted this, to be able to easily mock it in my test.
ndelangen
commented
Mar 4, 2024
ndelangen
commented
Mar 4, 2024
valentinpalkovic
approved these changes
Mar 4, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code-wise LGTM!
17 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.
Closes #25871
What I did
I found that the add command contained a few quicks and bugs that I fixed.
sb add package@1
it would install the latest version insteadI added tests for the functionality of the
add
command.The
getVersionSpecifier
function is tested separately, because regexes can be tricky, and it's faster to iterate on it this way if there is ever another bug with in.I can remove the warning functionality if it isn't desired.
I figured i'd be nice to have because it would prevent it from later becoming an issue the user would have to fix with the doctor command.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
I've tested this manually in a sandbox via running the CLI directly from dist:
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
Make 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/core
team 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>