[Feature] Improve yarn npm publish to match other package managers #2
+130
−27
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| import {BaseCommand, WorkspaceRequiredError} from '@yarnpkg/cli'; | ||
| import {Configuration, MessageName, Project, ReportError, StreamReport, scriptUtils, miscUtils} from '@yarnpkg/core'; | ||
| import {ppath} from '@yarnpkg/fslib'; | ||
| import {npmConfigUtils, npmHttpUtils, npmPublishUtils} from '@yarnpkg/plugin-npm'; | ||
| import {packUtils} from '@yarnpkg/plugin-pack'; | ||
| import {Command, Option, Usage, UsageError} from 'clipanion'; | ||
|
|
@@ -46,12 +47,30 @@ export default class NpmPublishCommand extends BaseCommand { | |
| description: `Generate provenance for the package. Only available in GitHub Actions and GitLab CI. Can be set globally through the \`npmPublishProvenance\` setting or the \`YARN_NPM_CONFIG_PROVENANCE\` environment variable, or per-package through the \`publishConfig.provenance\` field in package.json.`, | ||
| }); | ||
|
|
||
| dryRun = Option.Boolean(`--dry-run`, false, { | ||
| description: `Show what would be published without actually publishing`, | ||
| }); | ||
|
|
||
| json = Option.Boolean(`--json`, false, { | ||
| description: `Output the result in JSON format`, | ||
| }); | ||
|
|
||
| registry = Option.String(`--registry`, { | ||
| description: `The registry to publish to`, | ||
| }); | ||
|
|
||
| directory = Option.String({ | ||
| description: `The directory to publish (defaults to current directory)`, | ||
| required: false, | ||
| }); | ||
|
|
||
| async execute() { | ||
| const cwd = this.directory ? ppath.resolve(this.context.cwd, this.directory) : this.context.cwd; | ||
| const configuration = await Configuration.find(cwd, this.context.plugins); | ||
| const {project, workspace} = await Project.find(configuration, cwd); | ||
|
|
||
| if (!workspace) | ||
| throw new WorkspaceRequiredError(project.cwd, cwd); | ||
|
|
||
| if (workspace.manifest.private) | ||
| throw new UsageError(`Private workspaces cannot be published`); | ||
|
|
@@ -64,85 +83,180 @@ export default class NpmPublishCommand extends BaseCommand { | |
| const ident = workspace.manifest.name; | ||
| const version = workspace.manifest.version; | ||
|
|
||
| const registry = this.registry || npmConfigUtils.getPublishRegistry(workspace.manifest, {configuration}); | ||
|
|
||
| // For JSON output, we collect data differently but use the same core logic | ||
| if (this.json) { | ||
| const result = await this.executeWithCollectedOutput(workspace, registry, configuration, ident, version); | ||
| this.context.stdout.write(`${JSON.stringify(result, null, 2)}\n`); | ||
| return 0; | ||
| } | ||
|
|
||
| const report = await StreamReport.start({ | ||
| configuration, | ||
| stdout: this.context.stdout, | ||
| }, async report => { | ||
| await this.executeCore(workspace, registry, configuration, ident, version, report); | ||
| }); | ||
|
|
||
| return report.exitCode(); | ||
| } | ||
Saadnajmi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| private async executeCore(workspace: any, registry: string, configuration: any, ident: any, version: string, report: any) { | ||
|
||
| // Check if we should skip republishing | ||
| const shouldSkip = await this.checkTolerateRepublish(ident, version, configuration, registry); | ||
| if (shouldSkip) { | ||
| report.reportWarning(MessageName.UNNAMED, `Registry already knows about version ${version}; skipping.`); | ||
| return; | ||
| } | ||
|
|
||
| await scriptUtils.maybeExecuteWorkspaceLifecycleScript(workspace, `prepublish`, {report}); | ||
|
|
||
| await packUtils.prepareForPack(workspace, {report}, async () => { | ||
| await this.performPackAndPublish(workspace, registry, configuration, ident, report); | ||
| }); | ||
|
|
||
| const message = this.dryRun | ||
| ? `[DRY RUN] Package publication completed` | ||
| : `Package archive published`; | ||
| report.reportInfo(MessageName.UNNAMED, message); | ||
| } | ||
|
|
||
| private async executeWithCollectedOutput(workspace: any, registry: string, configuration: any, ident: any, version: string) { | ||
| const result: any = { | ||
| name: ident.name, | ||
| version, | ||
| registry, | ||
| dryRun: this.dryRun, | ||
| }; | ||
|
|
||
| try { | ||
| // Check if we should skip republishing | ||
| const shouldSkip = await this.checkTolerateRepublish(ident, version, configuration, registry); | ||
| if (shouldSkip) { | ||
| result.warning = `Registry already knows about version ${version}; skipping.`; | ||
| return result; | ||
| } | ||
|
|
||
| // Create a mock report that collects data instead of logging | ||
| const dataCollector = { | ||
| files: [] as Array<string>, | ||
| reportInfo: (name: any, file: string) => { | ||
| if (file) { | ||
| result.files = result.files || []; | ||
| result.files.push(file); | ||
| } | ||
| }, | ||
| reportWarning: () => {}, | ||
| reportError: () => {}, | ||
| }; | ||
|
|
||
| await packUtils.prepareForPack(workspace, dataCollector, async () => { | ||
| const publishData = await this.performPackAndPublish(workspace, registry, configuration, ident, dataCollector); | ||
| Object.assign(result, publishData); | ||
| }); | ||
|
|
||
| result.message = this.dryRun | ||
| ? `Package publication completed (dry run)` | ||
| : `Package archive published`; | ||
|
|
||
| return result; | ||
| } catch (error) { | ||
| result.error = error.message; | ||
| return result; | ||
| } | ||
| } | ||
|
|
||
| private async checkTolerateRepublish(ident: any, version: string, configuration: any, registry: string): Promise<boolean> { | ||
| if (!this.tolerateRepublish) return false; | ||
|
|
||
| try { | ||
| const registryData = await npmHttpUtils.get(npmHttpUtils.getIdentUrl(ident), { | ||
| configuration, | ||
| registry, | ||
| ident, | ||
| jsonResponse: true, | ||
| }); | ||
|
|
||
| if (!Object.hasOwn(registryData, `versions`)) | ||
| throw new ReportError(MessageName.REMOTE_INVALID, `Registry returned invalid data for - missing "versions" field`); | ||
|
|
||
| return Object.hasOwn(registryData.versions, version); | ||
| } catch (err) { | ||
| if (err.originalError?.response?.statusCode !== 404) | ||
| throw err; | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| private determineProvenance(workspace: any, configuration: any): boolean { | ||
| if (workspace.manifest.publishConfig && `provenance` in workspace.manifest.publishConfig) | ||
| return Boolean(workspace.manifest.publishConfig.provenance); | ||
| if (this.provenance) | ||
| return true; | ||
| if (configuration.get(`npmPublishProvenance`)) | ||
| return true; | ||
| return false; | ||
| } | ||
|
|
||
| private reportProvenanceDecision(provenance: boolean, workspace: any, report: any) { | ||
| if (workspace.manifest.publishConfig && `provenance` in workspace.manifest.publishConfig) { | ||
| const message = provenance | ||
| ? `Generating provenance statement because \`publishConfig.provenance\` field is set.` | ||
| : `Skipping provenance statement because \`publishConfig.provenance\` field is set to false.`; | ||
| report.reportInfo(null, message); | ||
| } else if (this.provenance) { | ||
| report.reportInfo(null, `Generating provenance statement because \`--provenance\` flag is set.`); | ||
| } else if (provenance) { | ||
| report.reportInfo(null, `Generating provenance statement because \`npmPublishProvenance\` setting is set.`); | ||
| } | ||
| } | ||
|
|
||
| private async performPackAndPublish(workspace: any, registry: string, configuration: any, ident: any, report: any) { | ||
| const files = await packUtils.genPackList(workspace); | ||
|
|
||
| // Report files if this is a streaming report | ||
| if (report.reportInfo && typeof report.reportInfo === `function`) { | ||
| for (const file of files) { | ||
| report.reportInfo(null, file); | ||
| } | ||
| } | ||
|
|
||
| const pack = await packUtils.genPackStream(workspace, files); | ||
| const buffer = await miscUtils.bufferStream(pack); | ||
| const gitHead = await npmPublishUtils.getGitHead(workspace.cwd); | ||
| const provenance = this.determineProvenance(workspace, configuration); | ||
|
|
||
| // Report provenance decision if this is a streaming report | ||
| if (report.reportInfo && typeof report.reportInfo === `function`) | ||
Saadnajmi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| this.reportProvenanceDecision(provenance, workspace, report); | ||
|
|
||
| const body = await npmPublishUtils.makePublishBody(workspace, buffer, { | ||
| access: this.access, | ||
| tag: this.tag, | ||
| registry, | ||
| gitHead, | ||
| provenance, | ||
| }); | ||
|
|
||
| if (!this.dryRun) { | ||
| await npmHttpUtils.put(npmHttpUtils.getIdentUrl(ident), body, { | ||
| configuration, | ||
| registry, | ||
| ident, | ||
| otp: this.otp, | ||
| jsonResponse: true, | ||
| }); | ||
| } else if (report.reportInfo && typeof report.reportInfo === `function`) { | ||
| report.reportInfo(MessageName.UNNAMED, `[DRY RUN] Package would be published to ${registry}`); | ||
| } | ||
|
|
||
| // Return data for JSON output | ||
| return { | ||
| files, | ||
| gitHead, | ||
| provenance, | ||
| published: !this.dryRun, | ||
| }; | ||
| } | ||
| } | ||
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.
Uh oh!
There was an error while loading. Please reload this page.