Merge pull request #1212 from microsoft/copilot/validate-extension-dependencies-case

Validate extension dependencies use lowercase letters and warn about deprecated github.copilot

Author: benibenj

src/package.ts

@@ -21,6 +21,7 @@ import {
 	validateEngineCompatibility,
 	validateVSCodeTypesCompatibility,
 	validatePublisher,
+	validateExtensionDependencies,
 } from './validation';
 import { detectYarn, getDependencies } from './npm';
 import * as GitHost from 'hosted-git-info';
@@ -1427,6 +1428,10 @@ export function validateManifestForPackaging(manifest: UnverifiedManifest): Mani
 		}
 	}
 
+	// Validate extension dependencies and extension pack use lowercase IDs
+	validateExtensionDependencies(manifest.extensionDependencies, 'extensionDependencies');
+	validateExtensionDependencies(manifest.extensionPack, 'extensionPack');
+
 	return {
 		...manifest,
 		name,

src/test/package.test.ts

@@ -604,6 +604,62 @@ describe('validateManifest', () => {
 		validateManifestForPackaging(createManifest({ sponsor: { url: 'http://www.foo.com' } }));
 	});
 
+	it('should validate extensionDependencies are lowercase', () => {
+		// Valid lowercase dependencies
+		validateManifestForPackaging(createManifest({ extensionDependencies: ['publisher.extension'] }));
+		validateManifestForPackaging(createManifest({ extensionDependencies: ['pub.ext', 'another.dep'] }));
+		validateManifestForPackaging(createManifest({ extensionDependencies: ['pub-name.ext-name'] }));
+		
+		// Invalid uppercase dependencies
+		assert.throws(() => validateManifestForPackaging(createManifest({ extensionDependencies: ['Publisher.extension'] })));
+		assert.throws(() => validateManifestForPackaging(createManifest({ extensionDependencies: ['publisher.Extension'] })));
+		assert.throws(() => validateManifestForPackaging(createManifest({ extensionDependencies: ['PUBLISHER.EXTENSION'] })));
+		assert.throws(() => validateManifestForPackaging(createManifest({ extensionDependencies: ['valid.ext', 'Invalid.Ext'] })));
+	});
+
+	it('should validate extensionPack are lowercase', () => {
+		// Valid lowercase pack
+		validateManifestForPackaging(createManifest({ extensionPack: ['publisher.extension'] }));
+		validateManifestForPackaging(createManifest({ extensionPack: ['pub.ext', 'another.dep'] }));
+		
+		// Invalid uppercase pack
+		assert.throws(() => validateManifestForPackaging(createManifest({ extensionPack: ['Publisher.extension'] })));
+		assert.throws(() => validateManifestForPackaging(createManifest({ extensionPack: ['publisher.Extension'] })));
+		assert.throws(() => validateManifestForPackaging(createManifest({ extensionPack: ['valid.ext', 'Invalid.Ext'] })));
+	});
+
+	it('should warn about deprecated github.copilot dependency', () => {
+		const originalLogWarn = log.warn;
+		const warnings: string[] = [];
+		log.warn = (message: string) => warnings.push(message);
+
+		try {
+			// Test with extensionDependencies
+			validateManifestForPackaging(createManifest({ extensionDependencies: ['github.copilot'] }));
+			assert.strictEqual(warnings.length, 1);
+			assert.ok(warnings[0].includes('github.copilot'));
+			assert.ok(warnings[0].includes('deprecated'));
+			assert.ok(warnings[0].includes('github.copilot-chat'));
+
+			// Reset warnings
+			warnings.length = 0;
+
+			// Test with extensionPack
+			validateManifestForPackaging(createManifest({ extensionPack: ['github.copilot'] }));
+			assert.strictEqual(warnings.length, 1);
+			assert.ok(warnings[0].includes('github.copilot'));
+
+			// Reset warnings
+			warnings.length = 0;
+
+			// Test with no github.copilot dependency
+			validateManifestForPackaging(createManifest({ extensionDependencies: ['other.extension'] }));
+			assert.strictEqual(warnings.length, 0);
+		} finally {
+			log.warn = originalLogWarn;
+		}
+	});
+
 	it('should validate pricing', () => {
 		assert.throws(() => validateManifestForPackaging(createManifest({ pricing: 'Paid' })));
 		validateManifestForPackaging(createManifest({ pricing: 'Trial' }));

src/test/validation.test.ts

@@ -5,6 +5,7 @@ import {
 	validateVersion,
 	validateEngineCompatibility,
 	validateVSCodeTypesCompatibility,
+	validateExtensionDependencies,
 } from '../validation';
 
 describe('validatePublisher', () => {
@@ -135,3 +136,53 @@ describe('validateVSCodeTypesCompatibility', () => {
 		assert.throws(() => validateVSCodeTypesCompatibility('1.5', '1.30'));
 	});
 });
+
+describe('validateExtensionDependencies', () => {
+	it('should allow empty or undefined dependencies', () => {
+		validateExtensionDependencies(undefined, 'extensionDependencies');
+		validateExtensionDependencies([], 'extensionDependencies');
+	});
+
+	it('should allow lowercase extension IDs', () => {
+		validateExtensionDependencies(['publisher.extension'], 'extensionDependencies');
+		validateExtensionDependencies(['publisher.extension-name'], 'extensionDependencies');
+		validateExtensionDependencies(['publisher-name.extension-name'], 'extensionDependencies');
+		validateExtensionDependencies(['pub123.ext456'], 'extensionDependencies');
+		validateExtensionDependencies(
+			['publisher1.extension1', 'publisher2.extension2'],
+			'extensionDependencies'
+		);
+	});
+
+	it('should reject uppercase letters in extension IDs', () => {
+		assert.throws(() => validateExtensionDependencies(['Publisher.extension'], 'extensionDependencies'));
+		assert.throws(() => validateExtensionDependencies(['publisher.Extension'], 'extensionDependencies'));
+		assert.throws(() => validateExtensionDependencies(['Publisher.Extension'], 'extensionDependencies'));
+		assert.throws(() => validateExtensionDependencies(['PUBLISHER.EXTENSION'], 'extensionDependencies'));
+	});
+
+	it('should reject mixed case in extension IDs', () => {
+		assert.throws(() => validateExtensionDependencies(['MyPublisher.my-extension'], 'extensionDependencies'));
+		assert.throws(() => validateExtensionDependencies(['my-publisher.MyExtension'], 'extensionDependencies'));
+	});
+
+	it('should work with extensionPack field', () => {
+		validateExtensionDependencies(['publisher.extension'], 'extensionPack');
+		assert.throws(() => validateExtensionDependencies(['Publisher.Extension'], 'extensionPack'));
+	});
+
+	it('should list all invalid dependencies in error message', () => {
+		try {
+			validateExtensionDependencies(
+				['valid.extension', 'Invalid.Extension', 'another.Invalid', 'Another.Invalid'],
+				'extensionDependencies'
+			);
+			assert.fail('Should have thrown an error');
+		} catch (error: any) {
+			assert.ok(error.message.includes('Invalid.Extension'));
+			assert.ok(error.message.includes('Another.Invalid'));
+			assert.ok(error.message.includes('another.Invalid'));
+			assert.ok(!error.message.includes('valid.extension'));
+		}
+	});
+});

src/validation.ts

@@ -1,5 +1,6 @@
 import * as semver from 'semver';
 import parseSemver from 'parse-semver';
+import { log } from './util';
 
 const nameRegex = /^[a-z0-9][a-z0-9\-]*$/i;
 
@@ -115,3 +116,37 @@ export function validateVSCodeTypesCompatibility(engineVersion: string, typeVers
 		throw error;
 	}
 }
+
+/**
+ * Validates that extension IDs use only lowercase letters.
+ * This validation ensures compliance with VS Code extension marketplace requirements.
+ * 
+ * Note: This only validates the case (lowercase). It does not validate the format 
+ * or structure of extension IDs (e.g., presence of dot separator, valid characters).
+ */
+export function validateExtensionDependencies(dependencies: string[] | undefined, fieldName: string): void {
+	if (!dependencies || dependencies.length === 0) {
+		return;
+	}
+
+	const invalidDependencies: string[] = [];
+
+	for (const dep of dependencies) {
+		// Check if extension ID uses only lowercase letters
+		// Note: This does not validate the format of the extension ID itself
+		if (dep !== dep.toLowerCase()) {
+			invalidDependencies.push(dep);
+		}
+
+		if (dep === 'github.copilot') {
+			log.warn(`The "github.copilot" extension is being deprecated in favor of the "github.copilot-chat" extension. Please use "github.copilot-chat" in ${fieldName} instead.`);
+		}
+	}
+
+	if (invalidDependencies.length > 0) {
+		const depList = invalidDependencies.map(d => `"${d}"`).join(', ');
+		throw new Error(
+			`The extension IDs in "${fieldName}" must use lowercase letters only. Invalid IDs: ${depList}.`
+		);
+	}
+}