fix: sfProject types matches schemas repo #1081
Conversation
…rcedotcom/sfdx-core into sm/project-type-consolidation
| (!!packageDir.package && packageDir.package === withId.package) | ||
| ); | ||
| }); | ||
| public addPackageDirectory(packageDir: PackageDir): void { |
There was a problem hiding this comment.
NamedPackageDir is a superset of PackageDir. It includes name and fullPath which aren't in PackageDir and shouldn't be written to the project
That still leaves the method in a weird place where you can pass in anything that satisfies packageDir (including namedPackageDir) and its contents [including excess props] get written to the Project, but at least now the method isn't requiring them.
packagingLib was the only place on public github that this was used.
…d possibly infinite
BREAKING CHANGES: remove re-export of PackageDir/PackageDirDependency
| @@ -0,0 +1,15 @@ | |||
| # Migrating `@salesforce/core` from v7 to v8 | |||
|
|
|||
| v8 uses the types from `@salesforce/schemas`, for SfProject/SfProjectJson. | |||
There was a problem hiding this comment.
SfProject/SfPr... using `
| The schemas types are more accurate about the PackageDir type (what `sfdx-project.json` packageDirectories is an array of). It is a union type of | ||
|
|
||
| 1. simply `path`, with an optional default property | ||
| 1. 1, along with the `package` property and lots of optional properties used for packaging. |
There was a problem hiding this comment.
should be 2?, also "1. 1,"
There was a problem hiding this comment.
doesn't have to be. markdown renders them correctly like this, and the you can change the order without retyping them.
| To support differentiating between the two structures, 2 type guards are now importable: | ||
|
|
||
| 1. isPackagingDirectory | ||
| 1. isNamedPackagingDirectory |
| @@ -53,9 +53,9 @@ | |||
| ], | |||
| "dependencies": { | |||
There was a problem hiding this comment.
is this a major version bump? I don't see it in in commits with ! or in the version here?
There was a problem hiding this comment.
yeah, there's a feat! commit in there with BREAKING CHANGES: etc.
src/sfProject.ts
Outdated
| plugins?: { [k: string]: unknown }; | ||
| packageAliases?: { [k: string]: string }; | ||
| }; | ||
| export type NamedPackagingDir = PackagePackageDir & NamedDirAdditions; |
There was a problem hiding this comment.
What's the difference between "package" and "packaging" - would be nice to have comments here explaining
NIT: NamedDirAdditions also unreasonably iirks me, maybe just NameAndPath so that it becomes PackagePackageDir & NameAndPath?
There was a problem hiding this comment.
in sfdx-project.json they're called packageDirectories even if you're not using them for packaging. Packaging refers to 1gp/2gp packages
I like you idea but will use NameAndFullPath since path is already on the basic one
What does this PR do?
uses the types from salesforce/schemas for sfProject and its PackageDirs.
This might be a breaking change because consumers might have been using looser types
pino 9 (major version bump) drops support for older node version. Shouldn't affect us.
What issues does this PR fix or reference?
@W-10271718@
@W-5571825@