Merge pull request #654 from microsoft/sandy081/preReleases

feat: add --pre-release flag and support
microsoft · Nov 24, 2021 · 2c60208 · 2c60208
2 parents 4d571f2 + 376a6a8
commit 2c60208
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 0 deletions.
diff --git a/src/main.ts b/src/main.ts
@@ -102,6 +102,7 @@ module.exports = function (argv: string[]): void {
 		.option('--no-gitHubIssueLinking', 'Disable automatic expansion of GitHub-style issue syntax into links')
 		.option('--no-gitLabIssueLinking', 'Disable automatic expansion of GitLab-style issue syntax into links')
 		.option('--no-dependencies', 'Disable dependency detection via npm or yarn')
+		.option('--pre-release', 'Mark this package as a pre-release')
 		.action(
 			(
 				version,
@@ -121,6 +122,7 @@ module.exports = function (argv: string[]): void {
 					gitHubIssueLinking,
 					gitLabIssueLinking,
 					dependencies,
+					preRelease,
 				}
 			) =>
 				main(
@@ -141,6 +143,7 @@ module.exports = function (argv: string[]): void {
 						gitHubIssueLinking,
 						gitLabIssueLinking,
 						dependencies,
+						preRelease,
 					})
 				)
 		);
@@ -176,6 +179,7 @@ module.exports = function (argv: string[]): void {
 		.option('--noVerify')
 		.option('--ignoreFile <path>', 'Indicate alternative .vscodeignore')
 		.option('--no-dependencies', 'Disable dependency detection via npm or yarn')
+		.option('--pre-release', 'Mark this package as a pre-release')
 		.action(
 			(
 				version,
@@ -194,6 +198,7 @@ module.exports = function (argv: string[]): void {
 					noVerify,
 					ignoreFile,
 					dependencies,
+					preRelease,
 				}
 			) =>
 				main(
@@ -213,6 +218,7 @@ module.exports = function (argv: string[]): void {
 						noVerify,
 						ignoreFile,
 						dependencies,
+						preRelease,
 					})
 				)
 		);

diff --git a/src/package.ts b/src/package.ts
@@ -85,6 +85,7 @@ export interface IPackageOptions {
 	readonly gitHubIssueLinking?: boolean;
 	readonly gitLabIssueLinking?: boolean;
 	readonly dependencies?: boolean;
+	readonly preRelease?: boolean;
 }
 
 export interface IProcessor {
@@ -124,6 +125,7 @@ export interface VSIX {
 	extensionPack: string;
 	extensionKind: string;
 	localizedLanguages: string;
+	preRelease: boolean;
 }
 
 export class BaseProcessor implements IProcessor {
@@ -438,6 +440,7 @@ export class ManifestProcessor extends BaseProcessor {
 							.map(loc => loc.localizedLanguageName ?? loc.languageName ?? loc.languageId)
 							.join(',')
 					: '',
+			preRelease: !!this.options.preRelease,
 		};
 
 		if (isGitHub) {
@@ -1248,6 +1251,7 @@ export async function toVsixManifest(vsix: VSIX): Promise<string> {
 				<Property Id="Microsoft.VisualStudio.Code.ExtensionPack" Value="${escape(vsix.extensionPack)}" />
 				<Property Id="Microsoft.VisualStudio.Code.ExtensionKind" Value="${escape(vsix.extensionKind)}" />
 				<Property Id="Microsoft.VisualStudio.Code.LocalizedLanguages" Value="${escape(vsix.localizedLanguages)}" />
+				${vsix.preRelease ? `<Property Id="Microsoft.VisualStudio.Code.PreRelease" Value="${escape(vsix.preRelease)}" />` : ''}
 				${
 					!vsix.links.repository
 						? ''

diff --git a/src/publish.ts b/src/publish.ts
@@ -30,6 +30,7 @@ export interface IPublishOptions {
 	readonly pat?: string;
 	readonly noVerify?: boolean;
 	readonly dependencies?: boolean;
+	readonly preRelease?: boolean;
 }
 
 export async function publish(options: IPublishOptions = {}): Promise<any> {

diff --git a/src/test/package.test.ts b/src/test/package.test.ts
@@ -1639,6 +1639,24 @@ describe('toVsixManifest', () => {
 
 		throw new Error('Should not reach here');
 	});
+
+	it('should add prerelease property when --pre-release flag is passed', async () => {
+		const manifest = createManifest();
+
+		const raw = await _toVsixManifest(manifest, [], { preRelease: true });
+		const xmlManifest = await parseXmlManifest(raw);
+
+		assertProperty(xmlManifest, 'Microsoft.VisualStudio.Code.PreRelease', 'true');
+	});
+
+	it('should not add prerelease property when --pre-release flag is not passed', async () => {
+		const manifest = createManifest();
+
+		const raw = await _toVsixManifest(manifest, []);
+		const xmlManifest = await parseXmlManifest(raw);
+
+		assertMissingProperty(xmlManifest, 'Microsoft.VisualStudio.Code.PreRelease');
+	});
 });
 
 describe('qna', () => {