Skip to content
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.

Sign up for GitHub

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

Support additional prepublish scripts for release and prerelease #1104

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Support additional prepublish scripts for release and prerelease #1104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 25 additions & 5 deletions src/package.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1845,20 +1845,40 @@ function getDefaultPackageName(manifest: ManifestPackage, options: IPackageOptio
return `${manifest.name}-${version}.vsix`;
}

export async function prepublish(cwd: string, manifest: ManifestPackage, useYarn?: boolean): Promise<void> {
if (!manifest.scripts || !manifest.scripts['vscode:prepublish']) {
export async function prepublish(cwd: string, manifest: ManifestPackage, useYarn?: boolean, additionalScript?: 'preRelease' | 'release'): Promise<void> {
if (!manifest.scripts) {
return;
}

const scripts: string[] = [];
if ('vscode:prepublish' in manifest.scripts) {
scripts.push('vscode:prepublish');
}
if ('vscode:prepublish:release' in manifest.scripts && additionalScript === 'release') {
scripts.push('vscode:prepublish:release');
}
if ('vscode:prepublish:prerelease' in manifest.scripts && additionalScript === 'preRelease') {
scripts.push('vscode:prepublish:prerelease');
}

if (scripts.length === 0) {
return;
}

if (useYarn === undefined) {
useYarn = await detectYarn(cwd);
}

console.log(`Executing prepublish script '${useYarn ? 'yarn' : 'npm'} run vscode:prepublish'...`);
for (const script of scripts) {
await runPrepublishScript(script, cwd, useYarn);
}
}

async function runPrepublishScript(script: string, cwd: string, useYarn: boolean): Promise<void> {
console.log(`Executing prepublish script '${useYarn ? 'yarn' : 'npm'} run ${script}'...`);
await new Promise<void>((c, e) => {
const tool = useYarn ? 'yarn' : 'npm';
const child = cp.spawn(tool, ['run', 'vscode:prepublish'], { cwd, shell: true, stdio: 'inherit' });
const child = cp.spawn(tool, ['run', script], { cwd, shell: true, stdio: 'inherit' });
child.on('exit', code => (code === 0 ? c() : e(`${tool} failed with exit code ${code}`)));
child.on('error', e);
});
Expand Down Expand Up @@ -1947,7 +1967,7 @@ export async function packageCommand(options: IPackageOptions = {}): Promise<any
const manifest = await readManifest(cwd);
util.patchOptionsWithManifest(options, manifest);

await prepublish(cwd, manifest, options.useYarn);
await prepublish(cwd, manifest, options.useYarn, options.preRelease ? 'preRelease' : 'release');
await versionBump(options);

const { packagePath, files } = await pack(options);
Expand Down
2 changes: 1 addition & 1 deletion src/publish.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ export async function publish(options: IPublishOptions = {}): Promise<any> {
// Validate marketplace requirements before prepublish to avoid unnecessary work
validateManifestForPublishing(manifest, options);

await prepublish(cwd, manifest, options.useYarn);
await prepublish(cwd, manifest, options.useYarn, options.preRelease ? 'preRelease' : 'release');
await versionBump(options);

if (options.targets) {
Expand Down