@vscode/vsce 3.0.0 → 3.0.1-0

package/out/package.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.printAndValidatePackagedFiles = exports.ls = exports.listFiles = exports.packageCommand = exports.createSignatureArchive = exports.generateManifest = exports.signPackage = exports.pack = exports.prepublish = exports.collect = exports.createDefaultProcessors = exports.processFiles = exports.toContentTypes = exports.toVsixManifest = exports.readManifest = exports.validateManifest = exports.ValidationProcessor = exports.NLSProcessor = exports.isWebKind = exports.LicenseProcessor = exports.ChangelogProcessor = exports.ReadmeProcessor = exports.MarkdownProcessor = exports.TagsProcessor = exports.ManifestProcessor = exports.Targets = exports.versionBump = exports.BaseProcessor = exports.read = void 0;
+exports.printAndValidatePackagedFiles = exports.ls = exports.listFiles = exports.packageCommand = exports.createSignatureArchive = exports.generateManifest = exports.signPackage = exports.pack = exports.prepublish = exports.collect = exports.createDefaultProcessors = exports.processFiles = exports.toContentTypes = exports.toVsixManifest = exports.readManifest = exports.validateManifestForPackaging = exports.ValidationProcessor = exports.NLSProcessor = exports.isWebKind = exports.LicenseProcessor = exports.ChangelogProcessor = exports.ReadmeProcessor = exports.MarkdownProcessor = exports.TagsProcessor = exports.ManifestProcessor = exports.Targets = exports.versionBump = exports.BaseProcessor = exports.read = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const util_1 = require("util");
@@ -302,7 +302,7 @@ class ManifestProcessor extends BaseProcessor {
         if (target || preRelease) {
             let engineVersion;
             try {
-                const engineSemver = (0, parse_semver_1.default)(`vscode@${manifest.engines['vscode']}`);
+                const engineSemver = (0, parse_semver_1.default)(`vscode@${manifest.engines.vscode}`);
                 engineVersion = engineSemver.version;
             }
             catch (err) {
@@ -310,7 +310,7 @@ class ManifestProcessor extends BaseProcessor {
             }
             if (target) {
                 if (engineVersion !== 'latest' && !semver.satisfies(engineVersion, '>=1.61', { includePrerelease: true })) {
-                    throw new Error(`Platform specific extension is supported by VS Code >=1.61. Current 'engines.vscode' is '${manifest.engines['vscode']}'.`);
+                    throw new Error(`Platform specific extension is supported by VS Code >=1.61. Current 'engines.vscode' is '${manifest.engines.vscode}'.`);
                 }
                 if (!exports.Targets.has(target)) {
                     throw new Error(`'${target}' is not a valid VS Code target. Valid targets: ${[...exports.Targets].join(', ')}`);
@@ -318,7 +318,7 @@ class ManifestProcessor extends BaseProcessor {
             }
             if (preRelease) {
                 if (engineVersion !== 'latest' && !semver.satisfies(engineVersion, '>=1.63', { includePrerelease: true })) {
-                    throw new Error(`Pre-release versions are supported by VS Code >=1.63. Current 'engines.vscode' is '${manifest.engines['vscode']}'.`);
+                    throw new Error(`Pre-release versions are supported by VS Code >=1.63. Current 'engines.vscode' is '${manifest.engines.vscode}'.`);
                 }
             }
         }
@@ -329,7 +329,7 @@ class ManifestProcessor extends BaseProcessor {
             version: options.version && !(options.updatePackageJson ?? true) ? options.version : manifest.version,
             publisher: manifest.publisher,
             target,
-            engine: manifest.engines['vscode'],
+            engine: manifest.engines.vscode,
             description: manifest.description ?? '',
             pricing: manifest.pricing ?? 'Free',
             categories: (manifest.categories ?? []).join(','),
@@ -908,24 +908,18 @@ class ValidationProcessor extends BaseProcessor {
     }
 }
 exports.ValidationProcessor = ValidationProcessor;
-function validateManifest(manifest) {
-    (0, validation_1.validateExtensionName)(manifest.name);
-    (0, validation_1.validatePublisher)(manifest.publisher);
-    if (!manifest.version) {
-        throw new Error('Manifest missing field: version');
-    }
-    if (manifest.pricing && !['Free', 'Trial'].includes(manifest.pricing)) {
-        throw new Error('Pricing can only be "Free" or "Trial"');
-    }
-    (0, validation_1.validateVersion)(manifest.version);
+function validateManifestForPackaging(manifest) {
     if (!manifest.engines) {
         throw new Error('Manifest missing field: engines');
     }
-    if (!manifest.engines['vscode']) {
-        throw new Error('Manifest missing field: engines.vscode');
+    const engines = { ...manifest.engines, vscode: (0, validation_1.validateEngineCompatibility)(manifest.engines.vscode) };
+    const name = (0, validation_1.validateExtensionName)(manifest.name);
+    const version = (0, validation_1.validateVersion)(manifest.version);
+    // allow users to package an extension without a publisher for testing reasons
+    const publisher = manifest.publisher ? (0, validation_1.validatePublisher)(manifest.publisher) : undefined;
+    if (manifest.pricing && !['Free', 'Trial'].includes(manifest.pricing)) {
+        throw new Error('Pricing can only be "Free" or "Trial"');
     }
-    const engineVersion = manifest.engines['vscode'];
-    (0, validation_1.validateEngineCompatibility)(engineVersion);
     const hasActivationEvents = !!manifest.activationEvents;
     const hasImplicitLanguageActivationEvents = manifest.contributes?.languages;
     const hasOtherImplicitActivationEvents = manifest.contributes?.commands ||
@@ -937,14 +931,14 @@ function validateManifest(manifest) {
     const hasBrowser = !!manifest.browser;
     let parsedEngineVersion;
     try {
-        const engineSemver = (0, parse_semver_1.default)(`vscode@${engineVersion}`);
+        const engineSemver = (0, parse_semver_1.default)(`vscode@${engines.vscode}`);
         parsedEngineVersion = engineSemver.version;
     }
     catch (err) {
         throw new Error('Failed to parse semver of engines.vscode');
     }
     if (hasActivationEvents ||
-        ((engineVersion === '*' || semver.satisfies(parsedEngineVersion, '>=1.74', { includePrerelease: true })) &&
+        ((engines.vscode === '*' || semver.satisfies(parsedEngineVersion, '>=1.74', { includePrerelease: true })) &&
             hasImplicitActivationEvents)) {
         if (!hasMain && !hasBrowser && (hasActivationEvents || !hasImplicitLanguageActivationEvents)) {
             throw new Error("Manifest needs either a 'main' or 'browser' property, given it has a 'activationEvents' property.");
@@ -957,7 +951,7 @@ function validateManifest(manifest) {
         throw new Error("Manifest needs the 'activationEvents' property, given it has a 'browser' property.");
     }
     if (manifest.devDependencies && manifest.devDependencies['@types/vscode']) {
-        (0, validation_1.validateVSCodeTypesCompatibility)(manifest.engines['vscode'], manifest.devDependencies['@types/vscode']);
+        (0, validation_1.validateVSCodeTypesCompatibility)(engines.vscode, manifest.devDependencies['@types/vscode']);
     }
     if (/\.svg$/i.test(manifest.icon || '')) {
         throw new Error(`SVGs can't be used as icons: ${manifest.icon}`);
@@ -1008,9 +1002,15 @@ function validateManifest(manifest) {
             throw new Error(`Manifest contains invalid value '${manifest.sponsor.url}' in the 'sponsor' property. It must be a valid URL with a HTTP or HTTPS protocol.`);
         }
     }
-    return manifest;
+    return {
+        ...manifest,
+        name,
+        version,
+        engines,
+        publisher,
+    };
 }
-exports.validateManifest = validateManifest;
+exports.validateManifestForPackaging = validateManifestForPackaging;
 function readManifest(cwd = process.cwd(), nls = true) {
     const manifestPath = path.join(cwd, 'package.json');
     const manifestNLSPath = path.join(cwd, 'package.nls.json');
@@ -1026,7 +1026,7 @@ function readManifest(cwd = process.cwd(), nls = true) {
             throw e;
         }
     })
-        .then(validateManifest);
+        .then(validateManifestForPackaging);
     if (!nls) {
         return manifest;
     }

package/out/publish.js

@@ -77,7 +77,7 @@ async function publish(options = {}) {
                     throw new Error(`Cannot use '--pre-release' flag with a package that was not packaged as pre-release. Please package it using the '--pre-release' flag and publish again.`);
                 }
             }
-            validateMarketplaceRequirements(vsix.manifest, options);
+            const manifestValidated = validateManifestForPublishing(vsix.manifest, options);
             let sigzipPath;
             if (options.manifestPath?.[index] && options.signaturePath?.[index]) {
                 sigzipPath = await (0, package_1.createSignatureArchive)(options.manifestPath[index], options.signaturePath[index]);
@@ -88,7 +88,7 @@ async function publish(options = {}) {
             if (!sigzipPath && options.signTool) {
                 sigzipPath = await (0, package_1.signPackage)(packagePath, options.signTool);
             }
-            await _publish(packagePath, sigzipPath, vsix.manifest, { ...options, target });
+            await _publish(packagePath, sigzipPath, manifestValidated, { ...options, target });
         }
     }
     else {
@@ -96,22 +96,24 @@ async function publish(options = {}) {
         const manifest = await (0, package_1.readManifest)(cwd);
         (0, util_2.patchOptionsWithManifest)(options, manifest);
         // Validate marketplace requirements before prepublish to avoid unnecessary work
-        validateMarketplaceRequirements(manifest, options);
+        validateManifestForPublishing(manifest, options);
         await (0, package_1.prepublish)(cwd, manifest, options.useYarn);
         await (0, package_1.versionBump)(options);
         if (options.targets) {
             for (const target of options.targets) {
                 const packagePath = await tmpName();
                 const packageResult = await (0, package_1.pack)({ ...options, target, packagePath });
+                const manifestValidated = validateManifestForPublishing(packageResult.manifest, options);
                 const sigzipPath = options.signTool ? await (0, package_1.signPackage)(packagePath, options.signTool) : undefined;
-                await _publish(packagePath, sigzipPath, packageResult.manifest, { ...options, target });
+                await _publish(packagePath, sigzipPath, manifestValidated, { ...options, target });
             }
         }
         else {
             const packagePath = await tmpName();
             const packageResult = await (0, package_1.pack)({ ...options, packagePath });
+            const manifestValidated = validateManifestForPublishing(packageResult.manifest, options);
             const sigzipPath = options.signTool ? await (0, package_1.signPackage)(packagePath, options.signTool) : undefined;
-            await _publish(packagePath, sigzipPath, packageResult.manifest, options);
+            await _publish(packagePath, sigzipPath, manifestValidated, options);
         }
     }
 }
@@ -219,7 +221,7 @@ async function unpublish(options = {}) {
     }
     else {
         const manifest = await (0, package_1.readManifest)(options.cwd);
-        publisher = manifest.publisher;
+        publisher = (0, validation_1.validatePublisher)(manifest.publisher);
         name = manifest.name;
     }
     const fullName = `${publisher}.${name}`;
@@ -235,8 +237,7 @@ async function unpublish(options = {}) {
     util_2.log.done(`Deleted extension: ${fullName}!`);
 }
 exports.unpublish = unpublish;
-function validateMarketplaceRequirements(manifest, options) {
-    (0, validation_1.validatePublisher)(manifest.publisher);
+function validateManifestForPublishing(manifest, options) {
     if (manifest.enableProposedApi && !options.allowAllProposedApis && !options.noVerify) {
         throw new Error("Extensions using proposed API (enableProposedApi: true) can't be published to the Marketplace. Use --allow-all-proposed-apis to bypass. https://code.visualstudio.com/api/advanced-topics/using-proposed-api");
     }
@@ -246,6 +247,7 @@ function validateMarketplaceRequirements(manifest, options) {
     if (semver.prerelease(manifest.version)) {
         throw new Error(`The VS Marketplace doesn't support prerelease versions: '${manifest.version}'. Checkout our pre-release versioning recommendation here: https://code.visualstudio.com/api/working-with-extensions/publishing-extension#prerelease-extensions`);
     }
+    return { ...manifest, publisher: (0, validation_1.validatePublisher)(manifest.publisher) };
 }
 async function getPAT(publisher, options) {
     if (options.pat) {

package/out/store.js

@@ -113,7 +113,7 @@ class KeytarStore {
 }
 exports.KeytarStore = KeytarStore;
 async function verifyPat(options) {
-    const publisherName = options.publisherName ?? (await (0, package_1.readManifest)()).publisher;
+    const publisherName = options.publisherName ?? (0, validation_1.validatePublisher)((await (0, package_1.readManifest)()).publisher);
     const pat = await (0, publish_1.getPAT)(publisherName, options);
     try {
         // If the caller of the `getRoleAssignments` API has any of the roles

package/out/validation.js

@@ -37,6 +37,7 @@ function validatePublisher(publisher) {
     if (!nameRegex.test(publisher)) {
         throw new Error(`Invalid publisher name '${publisher}'. Expected the identifier of a publisher, not its human-friendly name. Learn more: https://code.visualstudio.com/api/working-with-extensions/publishing-extension#publishing-extensions`);
     }
+    return publisher;
 }
 exports.validatePublisher = validatePublisher;
 function validateExtensionName(name) {
@@ -46,6 +47,7 @@ function validateExtensionName(name) {
     if (!nameRegex.test(name)) {
         throw new Error(`Invalid extension name '${name}'`);
     }
+    return name;
 }
 exports.validateExtensionName = validateExtensionName;
 function validateVersion(version) {
@@ -55,6 +57,7 @@ function validateVersion(version) {
     if (!semver.valid(version)) {
         throw new Error(`Invalid extension version '${version}'`);
     }
+    return version;
 }
 exports.validateVersion = validateVersion;
 function validateEngineCompatibility(version) {
@@ -64,6 +67,7 @@ function validateEngineCompatibility(version) {
     if (!/^\*$|^(\^|>=)?((\d+)|x)\.((\d+)|x)\.((\d+)|x)(\-.*)?$/.test(version)) {
         throw new Error(`Invalid vscode engine compatibility version '${version}'`);
     }
+    return version;
 }
 exports.validateEngineCompatibility = validateEngineCompatibility;
 /**

package/out/zip.js

@@ -4,6 +4,7 @@ exports.readVSIXPackage = exports.readZip = void 0;
 const yauzl_1 = require("yauzl");
 const xml_1 = require("./xml");
 const util_1 = require("./util");
+const package_1 = require("./package");
 async function bufferStream(stream) {
     return await new Promise((c, e) => {
         const buffers = [];
@@ -49,8 +50,16 @@ async function readVSIXPackage(packagePath) {
     if (!rawXmlManifest) {
         throw new Error('VSIX manifest not found');
     }
+    const manifest = JSON.parse(rawManifest.toString('utf8'));
+    let manifestValidated;
+    try {
+        manifestValidated = (0, package_1.validateManifestForPackaging)(manifest);
+    }
+    catch (error) {
+        throw new Error(`Invalid extension VSIX manifest: ${error}`);
+    }
     return {
-        manifest: JSON.parse(rawManifest.toString('utf8')),
+        manifest: manifestValidated,
         xmlManifest: await (0, xml_1.parseXmlManifest)(rawXmlManifest.toString('utf8')),
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@vscode/vsce",
-	"version": "3.0.0",
+	"version": "3.0.1-0",
 	"description": "VS Code Extensions Manager",
 	"repository": {
 		"type": "git",