feat: make SfProject optional
#638
Merged
+804
−1,734
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
cristiand391
changed the title
SfProject optional
cristiand391
commented
Aug 13, 2024
| this.options.project.getPackageIdFromAlias(this.options.packageAliasOrId) ?? this.options.packageAliasOrId; | ||
| packageId = this.options.project | ||
| ? this.options.project.getPackageIdFromAlias(this.options.packageAliasOrId) ?? this.options.packageAliasOrId | ||
| : this.options.packageAliasOrId; | ||
| if (packageId === this.options.packageAliasOrId) { | ||
| throw messages.createError('packageAliasNotFound', [this.options.packageAliasOrId]); |
There was a problem hiding this comment.
the constructor will fail if you pass an alias without project or an invalid alias with a project instance.
cristiand391
commented
Aug 13, 2024
| options?: PackageVersionListOptions | ||
| ): Promise<PackageVersionListResult[]> { | ||
| // resolve/verify packages | ||
| const packages = options?.packages?.map((pkg) => { | ||
| const id = project.getPackageIdFromAlias(pkg) ?? pkg; | ||
| const id = project ? project.getPackageIdFromAlias(pkg) ?? pkg : pkg; |
There was a problem hiding this comment.
these IDs are validated below
mshanemc
approved these changes
Aug 14, 2024
mshanemc
approved these changes
Aug 15, 2024
|
QA for that last commit: from the plugin using the prerel, ✅ ran with an alias and got the good helpful error message about the missing project |
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.
This PR updates some packaging classes to make
SfProjectoptional.See: salesforcecli/plugin-packaging#771
Most of these classes were taking an
SfProjectinstance along with a possible package ID or alias (defined in sfdx-project.json). By makingSfProjectoptional, consumers of the library can call it without having to create a dummy sfdx-project.Note for review:
there are classes/methods that do need a project b/c they write stuff on it after a package operation, most of these aren't affected by this change (
PackageVersion.updateProjectWithPackageVersionwas updated to throw if there's no project).QA:
Check the plugin-packaging PR linked above, with this branch linked (or the prerelease) you should be able to use the listed commands outside a project.
@W-16286213@