feat: add support for packaging and publishing without license file (#887)

Author: bandantonio

Diff for: src/main.ts

@@ -113,6 +113,7 @@ module.exports = function (argv: string[]): void {
 		.option('--pre-release', 'Mark this package as a pre-release')
 		.option('--allow-star-activation', 'Allow using * in activation events')
 		.option('--allow-missing-repository', 'Allow missing a repository URL in package.json')
+		.option('--skip-license', 'Allow packaging without license file')
 		.action(
 			(
 				version,
@@ -135,6 +136,7 @@ module.exports = function (argv: string[]): void {
 					preRelease,
 					allowStarActivation,
 					allowMissingRepository,
+					skipLicense,
 				}
 			) =>
 				main(
@@ -158,6 +160,7 @@ module.exports = function (argv: string[]): void {
 						preRelease,
 						allowStarActivation,
 						allowMissingRepository,
+						skipLicense,
 					})
 				)
 		);
@@ -199,6 +202,7 @@ module.exports = function (argv: string[]): void {
 		.option('--allow-star-activation', 'Allow using * in activation events')
 		.option('--allow-missing-repository', 'Allow missing a repository URL in package.json')
 		.option('--skip-duplicate', 'Fail silently if version already exists on the marketplace')
+		.option('--skip-license', 'Allow publishing without license file')
 		.action(
 			(
 				version,
@@ -221,6 +225,7 @@ module.exports = function (argv: string[]): void {
 					allowStarActivation,
 					allowMissingRepository,
 					skipDuplicate,
+					skipLicense,
 				}
 			) =>
 				main(
@@ -244,6 +249,7 @@ module.exports = function (argv: string[]): void {
 						allowStarActivation,
 						allowMissingRepository,
 						skipDuplicate,
+						skipLicense,
 					})
 				)
 		);

Diff for: src/package.ts

@@ -136,6 +136,7 @@ export interface IPackageOptions {
 	readonly preRelease?: boolean;
 	readonly allowStarActivation?: boolean;
 	readonly allowMissingRepository?: boolean;
+	readonly skipLicense?: boolean;
 }
 
 export interface IProcessor {
@@ -919,12 +920,12 @@ export class ChangelogProcessor extends MarkdownProcessor {
 	}
 }
 
-class LicenseProcessor extends BaseProcessor {
+export class LicenseProcessor extends BaseProcessor {
 	private didFindLicense = false;
 	private expectedLicenseName: string;
 	filter: (name: string) => boolean;
 
-	constructor(manifest: Manifest) {
+	constructor(manifest: Manifest, private readonly options: IPackageOptions = {}) {
 		super(manifest);
 
 		const match = /^SEE LICENSE IN (.*)$/.exec(manifest.license || '');
@@ -961,7 +962,7 @@ class LicenseProcessor extends BaseProcessor {
 	}
 
 	async onEnd(): Promise<void> {
-		if (!this.didFindLicense) {
+		if (!this.didFindLicense && !this.options.skipLicense) {
 			util.log.warn(`${this.expectedLicenseName} not found`);
 
 			if (!/^y$/i.test(await util.read('Do you want to continue? [y/N] '))) {
@@ -1628,7 +1629,7 @@ export function createDefaultProcessors(manifest: Manifest, options: IPackageOpt
 		new ReadmeProcessor(manifest, options),
 		new ChangelogProcessor(manifest, options),
 		new LaunchEntryPointProcessor(manifest),
-		new LicenseProcessor(manifest),
+		new LicenseProcessor(manifest, options),
 		new IconProcessor(manifest),
 		new NLSProcessor(manifest),
 		new ValidationProcessor(manifest),

Diff for: src/publish.ts

@@ -62,6 +62,7 @@ export interface IPublishOptions {
 	readonly allowStarActivation?: boolean;
 	readonly allowMissingRepository?: boolean;
 	readonly skipDuplicate?: boolean;
+	readonly skipLicense?: boolean;
 }
 
 export async function publish(options: IPublishOptions = {}): Promise<any> {

Diff for: src/test/package.test.ts

@@ -13,6 +13,7 @@ import {
 	ManifestProcessor,
 	versionBump,
 	VSIX,
+	LicenseProcessor,
 } from '../package';
 import { Manifest } from '../manifest';
 import * as path from 'path';
@@ -21,7 +22,7 @@ import * as assert from 'assert';
 import * as tmp from 'tmp';
 import { spawnSync } from 'child_process';
 import { XMLManifest, parseXmlManifest, parseContentTypes } from '../xml';
-import { flatten } from '../util';
+import { flatten, log } from '../util';
 import { validatePublisher } from '../validation';
 import * as jsonc from 'jsonc-parser';
 
@@ -2817,6 +2818,43 @@ describe('MarkdownProcessor', () => {
 	});
 });
 
+describe('LicenseProcessor', () => {
+	it('should fail if license file not specified', async () => {
+		const originalUtilWarn = log.warn;
+		const logs: string[] = [];
+
+		log.warn = (message) => {
+			logs.push(message);
+		};
+
+		const message = 'LICENSE, LICENSE.md, or LICENSE.txt not found';
+
+		const processor = new LicenseProcessor(createManifest(), {});
+		await processor.onEnd();
+
+		log.warn = originalUtilWarn;
+
+		assert.strictEqual(logs.length, 1);
+		assert.strictEqual(logs[0], message);
+	});
+
+	it('should pass if no license specified and --skip-license flag is passed', async () => {
+		const originalUtilWarn = log.warn;
+		const logs: string[] = [];
+
+		log.warn = (message) => {
+			logs.push(message);
+		};
+
+		const processor = new LicenseProcessor(createManifest(), { skipLicense: true });
+		await processor.onEnd();
+
+		log.warn = originalUtilWarn;
+
+		assert.strictEqual(logs.length, 0);
+	});
+});
+
 describe('version', function () {
 	this.timeout(5000);