@vscode/vsce 2.30.1-0 → 2.30.1-1

package/dist/vsce.d.ts

@@ -117,6 +117,7 @@ export declare interface IPackageOptions {
     readonly preRelease?: boolean;
     readonly allowStarActivation?: boolean;
     readonly allowMissingRepository?: boolean;
+    readonly allowUnusedFilesPattern?: boolean;
     readonly skipLicense?: boolean;
     readonly signTool?: string;
 }
@@ -172,6 +173,7 @@ export declare interface IPublishOptions {
     readonly preRelease?: boolean;
     readonly allowStarActivation?: boolean;
     readonly allowMissingRepository?: boolean;
+    readonly allowUnusedFilesPattern?: boolean;
     readonly skipDuplicate?: boolean;
     readonly skipLicense?: boolean;
     readonly sigzipPath?: string[];

package/out/main.js

@@ -114,9 +114,10 @@ module.exports = function (argv) {
         .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('--allow-unused-files-pattern', 'Allow include patterns for the files field in package.json that does not match any file')
         .option('--skip-license', 'Allow packaging without license file')
         .option('--sign-tool <path>', 'Path to the VSIX signing tool. Will be invoked with two arguments: `SIGNTOOL <path/to/extension.signature.manifest> <path/to/extension.signature.p7s>`.')
-        .action((version, { out, target, ignoreOtherTargetFolders, readmePath, changelogPath, message, gitTagVersion, updatePackageJson, githubBranch, gitlabBranch, rewriteRelativeLinks, baseContentUrl, baseImagesUrl, yarn, ignoreFile, gitHubIssueLinking, gitLabIssueLinking, dependencies, preRelease, allowStarActivation, allowMissingRepository, skipLicense, signTool, }) => main((0, package_1.packageCommand)({
+        .action((version, { out, target, ignoreOtherTargetFolders, readmePath, changelogPath, message, gitTagVersion, updatePackageJson, githubBranch, gitlabBranch, rewriteRelativeLinks, baseContentUrl, baseImagesUrl, yarn, ignoreFile, gitHubIssueLinking, gitLabIssueLinking, dependencies, preRelease, allowStarActivation, allowMissingRepository, allowUnusedFilesPattern, skipLicense, signTool, }) => main((0, package_1.packageCommand)({
         packagePath: out,
         version,
         target,
@@ -139,6 +140,7 @@ module.exports = function (argv) {
         preRelease,
         allowStarActivation,
         allowMissingRepository,
+        allowUnusedFilesPattern,
         skipLicense,
         signTool,
     })));
@@ -175,9 +177,10 @@ module.exports = function (argv) {
         .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('--allow-unused-files-pattern', 'Allow include patterns for the files field in package.json that does not match any file')
         .option('--skip-duplicate', 'Fail silently if version already exists on the marketplace')
         .option('--skip-license', 'Allow publishing without license file')
-        .action((version, { pat, azureCredential, target, ignoreOtherTargetFolders, readmePath, changelogPath, message, gitTagVersion, updatePackageJson, packagePath, manifestPath, signaturePath, sigzipPath, githubBranch, gitlabBranch, baseContentUrl, baseImagesUrl, yarn, noVerify, allowProposedApis, allowAllProposedApis, ignoreFile, dependencies, preRelease, allowStarActivation, allowMissingRepository, skipDuplicate, skipLicense, signTool, }) => main((0, publish_1.publish)({
+        .action((version, { pat, azureCredential, target, ignoreOtherTargetFolders, readmePath, changelogPath, message, gitTagVersion, updatePackageJson, packagePath, manifestPath, signaturePath, sigzipPath, githubBranch, gitlabBranch, baseContentUrl, baseImagesUrl, yarn, noVerify, allowProposedApis, allowAllProposedApis, ignoreFile, dependencies, preRelease, allowStarActivation, allowMissingRepository, allowUnusedFilesPattern, skipDuplicate, skipLicense, signTool, }) => main((0, publish_1.publish)({
         pat,
         azureCredential,
         version,
@@ -205,6 +208,7 @@ module.exports = function (argv) {
         preRelease,
         allowStarActivation,
         allowMissingRepository,
+        allowUnusedFilesPattern,
         skipDuplicate,
         skipLicense,
         signTool

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.printPackagedFiles = 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.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;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const util_1 = require("util");
@@ -500,7 +500,7 @@ class MarkdownProcessor extends BaseProcessor {
         super(manifest);
         this.name = name;
         this.assetType = assetType;
-        this.regexp = new RegExp(`^extension/${filePath}$`, 'i');
+        this.regexp = new RegExp(`^${util.filePathToVsixPath(filePath)}$`, 'i');
         const guess = this.guessBaseUrls(options.githubBranch || options.gitlabBranch);
         this.baseContentUrl = options.baseContentUrl || (guess && guess.content);
         this.baseImagesUrl = options.baseImagesUrl || options.baseContentUrl || (guess && guess.images);
@@ -682,7 +682,7 @@ class LicenseProcessor extends BaseProcessor {
         }
         else {
             this.expectedLicenseName = match[1];
-            const regexp = new RegExp('^extension/' + match[1] + '$');
+            const regexp = new RegExp(`^${util.filePathToVsixPath(match[1])}$`);
             this.filter = regexp.test.bind(regexp);
         }
         delete this.vsix.license;
@@ -744,7 +744,7 @@ class IconProcessor extends BaseProcessor {
     constructor(manifest) {
         super(manifest);
         this.didFindIcon = false;
-        this.icon = manifest.icon && path.posix.normalize(`extension/${manifest.icon}`);
+        this.icon = manifest.icon && path.posix.normalize(util.filePathToVsixPath(manifest.icon));
         delete this.vsix.icon;
     }
     onFile(file) {
@@ -839,7 +839,7 @@ class NLSProcessor extends BaseProcessor {
             for (const translation of localization.translations) {
                 if (translation.id === 'vscode' && !!translation.path) {
                     const translationPath = util.normalize(translation.path.replace(/^\.[\/\\]/, ''));
-                    translations[localization.languageId.toUpperCase()] = `extension/${translationPath}`;
+                    translations[localization.languageId.toUpperCase()] = util.filePathToVsixPath(translationPath);
                 }
             }
         }
@@ -1110,7 +1110,7 @@ async function toVsixManifest(vsix) {
 		</Installation>
 		<Dependencies/>
 		<Assets>
-			<Asset Type="Microsoft.VisualStudio.Code.Manifest" Path="extension/package.json" Addressable="true" />
+			<Asset Type="Microsoft.VisualStudio.Code.Manifest" Path="${util.filePathToVsixPath('package.json')}" Addressable="true" />
 			${vsix.assets
         .map(asset => `<Asset Type="${escape(asset.type)}" Path="${escape(asset.path)}" Addressable="true" />`)
         .join('\n')}
@@ -1275,7 +1275,7 @@ function collect(manifest, options = {}) {
     const ignoreFile = options.ignoreFile || undefined;
     const processors = createDefaultProcessors(manifest, options);
     return collectFiles(cwd, getDependenciesOption(options), packagedDependencies, ignoreFile, manifest.files).then(fileNames => {
-        const files = fileNames.map(f => ({ path: `extension/${f}`, localPath: path.join(cwd, f) }));
+        const files = fileNames.map(f => ({ path: util.filePathToVsixPath(f), localPath: path.join(cwd, f) }));
         return processFiles(processors, files);
     });
 }
@@ -1346,7 +1346,7 @@ async function pack(options = {}) {
     const cwd = options.cwd || process.cwd();
     const manifest = await readManifest(cwd);
     const files = await collect(manifest, options);
-    await printPackagedFiles(files, cwd, manifest, options);
+    await printAndValidatePackagedFiles(files, cwd, manifest, options);
     if (options.version && !(options.updatePackageJson ?? true)) {
         manifest.version = options.version;
     }
@@ -1428,7 +1428,7 @@ exports.ls = ls;
 /**
  * Prints the packaged files of an extension.
  */
-async function printPackagedFiles(files, cwd, manifest, options) {
+async function printAndValidatePackagedFiles(files, cwd, manifest, options) {
     // Warn if the extension contains a lot of files
     const jsFiles = files.filter(f => /\.js$/i.test(f.path));
     if (files.length > 5000 || jsFiles.length > 100) {
@@ -1439,20 +1439,49 @@ async function printPackagedFiles(files, cwd, manifest, options) {
         util.log.warn(message);
     }
     // Warn if the extension does not have a .vscodeignore file or a files property in package.json
-    if (!options.ignoreFile && !manifest.files) {
-        const hasDeaultIgnore = fs.existsSync(path.join(cwd, '.vscodeignore'));
-        if (!hasDeaultIgnore) {
+    const hasIgnoreFile = fs.existsSync(options.ignoreFile ?? path.join(cwd, '.vscodeignore'));
+    if (!hasIgnoreFile && !manifest.files) {
+        let message = '';
+        message += `Neither a ${chalk_1.default.bold('.vscodeignore')} file nor a ${chalk_1.default.bold('"files"')} property in package.json was found. `;
+        message += `To ensure only necessary files are included in your extension, `;
+        message += `add a .vscodeignore file or specify the "files" property in package.json. More info: ${chalk_1.default.underline('https://aka.ms/vscode-vscodeignore')}\n`;
+        util.log.warn(message);
+    }
+    // Throw an error if the extension uses both a .vscodeignore file and the files property in package.json
+    else if (hasIgnoreFile && manifest.files !== undefined && manifest.files.length > 0) {
+        let message = '';
+        message += `Both a ${chalk_1.default.bold('.vscodeignore')} file and a ${chalk_1.default.bold('"files"')} property in package.json were found. `;
+        message += `VSCE does not support combining both strategies. `;
+        message += `Either remove the ${chalk_1.default.bold('.vscodeignore')} file or the ${chalk_1.default.bold('"files"')} property in package.json.`;
+        util.log.error(message);
+        process.exit(1);
+    }
+    // Throw an error if the extension uses the files property in package.json and 
+    // the package does not include at least one file for each include pattern
+    else if (manifest.files !== undefined && manifest.files.length > 0 && !options.allowUnusedFilesPattern) {
+        const originalFilePaths = files.map(f => util.vsixPathToFilePath(f.path));
+        const unusedIncludePatterns = [];
+        for (const includePattern of manifest.files) {
+            const hasMatchingFile = originalFilePaths.some(file => (0, minimatch_1.default)(file, includePattern, MinimatchOptions));
+            if (!hasMatchingFile) {
+                unusedIncludePatterns.push(includePattern);
+            }
+        }
+        if (unusedIncludePatterns.length > 0) {
             let message = '';
-            message += `Neither a ${chalk_1.default.bold('.vscodeignore')} file nor a ${chalk_1.default.bold('"files"')} property in package.json was found. `;
-            message += `To ensure only necessary files are included in your extension, `;
-            message += `add a .vscodeignore file or specify the "files" property in package.json. More info: ${chalk_1.default.underline('https://aka.ms/vscode-vscodeignore')}\n`;
-            util.log.warn(message);
+            message += `The following include patterns in the ${chalk_1.default.bold('"files"')} property in package.json do not match any files packaged in the extension:\n`;
+            message += unusedIncludePatterns.map(p => `  - ${p}`).join('\n');
+            message += '\nRemove any include pattern which is not needed.\n';
+            message += `\n=> Run ${chalk_1.default.bold('vsce ls --tree')} to see all included files.\n`;
+            message += `=> Use ${chalk_1.default.bold('--allow-unused-files-patterns')} to skip this check`;
+            util.log.error(message);
+            process.exit(1);
         }
     }
     // Print the files included in the package
     const printableFileStructure = await util.generateFileStructureTree(getDefaultPackageName(manifest, options), files.map(f => ({
         // File path relative to the extension root
-        origin: f.path.startsWith('extension/') ? f.path.substring(10) : f.path,
+        origin: util.vsixPathToFilePath(f.path),
         // File path in the VSIX
         tree: f.path
     })), 35 // Print up to 35 files/folders
@@ -1467,5 +1496,5 @@ async function printPackagedFiles(files, cwd, manifest, options) {
     message += '\n';
     util.log.info(message);
 }
-exports.printPackagedFiles = printPackagedFiles;
+exports.printAndValidatePackagedFiles = printAndValidatePackagedFiles;
 //# sourceMappingURL=package.js.map

package/out/util.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.generateFileStructureTree = exports.bytesToString = exports.patchOptionsWithManifest = exports.log = exports.sequence = exports.CancellationToken = exports.isCancelledError = exports.nonnull = exports.flatten = exports.chain = exports.normalize = exports.getPublicGalleryAPI = exports.getSecurityRolesAPI = exports.getGalleryAPI = exports.getHubUrl = exports.getMarketplaceUrl = exports.getPublishedUrl = exports.read = void 0;
+exports.generateFileStructureTree = exports.vsixPathToFilePath = exports.filePathToVsixPath = exports.bytesToString = exports.patchOptionsWithManifest = exports.log = exports.sequence = exports.CancellationToken = exports.isCancelledError = exports.nonnull = exports.flatten = exports.chain = exports.normalize = exports.getPublicGalleryAPI = exports.getSecurityRolesAPI = exports.getGalleryAPI = exports.getHubUrl = exports.getMarketplaceUrl = exports.getPublishedUrl = exports.read = void 0;
 const util_1 = require("util");
 const fs = __importStar(require("fs"));
 const read_1 = __importDefault(require("read"));
@@ -204,6 +204,14 @@ function bytesToString(bytes) {
     return `${size} ${unit}`;
 }
 exports.bytesToString = bytesToString;
+function filePathToVsixPath(originalFilePath) {
+    return `extension/${originalFilePath}`;
+}
+exports.filePathToVsixPath = filePathToVsixPath;
+function vsixPathToFilePath(extensionFilePath) {
+    return extensionFilePath.startsWith('extension/') ? extensionFilePath.substring('extension/'.length) : extensionFilePath;
+}
+exports.vsixPathToFilePath = vsixPathToFilePath;
 const FOLDER_SIZE_KEY = "/__FOlDER_SIZE__\\";
 const FOLDER_FILES_TOTAL_KEY = "/__FOLDER_CHILDREN__\\";
 const FILE_SIZE_WARNING_THRESHOLD = 0.85;

package/out/zip.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.readVSIXPackage = exports.readZip = void 0;
 const yauzl_1 = require("yauzl");
 const xml_1 = require("./xml");
+const util_1 = require("./util");
 async function bufferStream(stream) {
     return await new Promise((c, e) => {
         const buffers = [];
@@ -40,7 +41,7 @@ async function readZip(packagePath, filter) {
 exports.readZip = readZip;
 async function readVSIXPackage(packagePath) {
     const map = await readZip(packagePath, name => /^extension\/package\.json$|^extension\.vsixmanifest$/i.test(name));
-    const rawManifest = map.get('extension/package.json');
+    const rawManifest = map.get((0, util_1.filePathToVsixPath)('package.json'));
     if (!rawManifest) {
         throw new Error('Manifest not found');
     }

package/package.json

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