@vscode/vsce 2.29.1-0 → 2.29.1-2

package/out/main.js

@@ -64,7 +64,7 @@ function main(task) {
     }
     task.catch(fatal).then(() => {
         if (latestVersion && semver.gt(latestVersion, pkg.version)) {
-            util_1.log.info(`\nThe latest version of ${pkg.name} is ${latestVersion} and you have ${pkg.version}.\nUpdate it now: npm install -g ${pkg.name}`);
+            util_1.log.info(`The latest version of ${pkg.name} is ${latestVersion} and you have ${pkg.version}.\nUpdate it now: npm install -g ${pkg.name}`);
         }
         else {
             token.cancel();

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.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.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;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const util_1 = require("util");
@@ -42,6 +42,7 @@ const url = __importStar(require("url"));
 const mime_1 = __importDefault(require("mime"));
 const semver = __importStar(require("semver"));
 const url_join_1 = __importDefault(require("url-join"));
+const chalk_1 = __importDefault(require("chalk"));
 const validation_1 = require("./validation");
 const npm_1 = require("./npm");
 const GitHost = __importStar(require("hosted-git-info"));
@@ -388,7 +389,11 @@ class ManifestProcessor extends BaseProcessor {
             }
         }
         if (!this.options.allowStarActivation && this.manifest.activationEvents?.some(e => e === '*')) {
-            util.log.warn(`Using '*' activation is usually a bad idea as it impacts performance.\nMore info: https://code.visualstudio.com/api/references/activation-events#Start-up\nUse --allow-star-activation to bypass.`);
+            let message = '';
+            message += `Using '*' activation is usually a bad idea as it impacts performance.\n`;
+            message += `More info: https://code.visualstudio.com/api/references/activation-events#Start-up\n`;
+            message += `Use --allow-star-activation to bypass.`;
+            util.log.warn(message);
             if (!/^y$/i.test(await util.read('Do you want to continue? [y/N] '))) {
                 throw new Error('Aborted');
             }
@@ -889,6 +894,7 @@ 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');
     }
@@ -1340,10 +1346,7 @@ async function pack(options = {}) {
     const cwd = options.cwd || process.cwd();
     const manifest = await readManifest(cwd);
     const files = await collect(manifest, options);
-    const jsFiles = files.filter(f => /\.js$/i.test(f.path));
-    if (files.length > 5000 || jsFiles.length > 100) {
-        console.log(`This extension consists of ${files.length} files, out of which ${jsFiles.length} are JavaScript files. For performance reasons, you should bundle your extension: https://aka.ms/vscode-bundle-extension . You should also exclude unnecessary files by adding them to your .vscodeignore: https://aka.ms/vscode-vscodeignore`);
-    }
+    printPackagedFiles(files, cwd, manifest, options);
     if (options.version && !(options.updatePackageJson ?? true)) {
         manifest.version = options.version;
     }
@@ -1425,4 +1428,40 @@ async function ls(options = {}) {
     }
 }
 exports.ls = ls;
+/**
+ * Prints the packaged files of an extension.
+ */
+function printPackagedFiles(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) {
+        let message = '\n';
+        message += `This extension consists of ${chalk_1.default.bold(String(files.length))} files, out of which ${chalk_1.default.bold(String(jsFiles.length))} are JavaScript files. `;
+        message += `For performance reasons, you should bundle your extension: ${chalk_1.default.underline('https://aka.ms/vscode-bundle-extension')}. `;
+        message += `You should also exclude unnecessary files by adding them to your .vscodeignore: ${chalk_1.default.underline('https://aka.ms/vscode-vscodeignore')}.\n`;
+        console.log(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) {
+            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 package, `;
+            message += `add a .vscodeignore file or specify the "files" property in package.json. More info: ${chalk_1.default.underline('https://aka.ms/vscode-vscodeignore')}`;
+            util.log.warn(message);
+        }
+    }
+    // Print the files included in the package
+    const printableFileStructure = util.generateFileStructureTree(getDefaultPackageName(manifest, options), files.map(f => f.path), 35);
+    let message = '';
+    message += chalk_1.default.bold.blue(`Files included in the VSIX:\n`);
+    message += printableFileStructure.join('\n');
+    if (files.length + 1 > printableFileStructure.length) {
+        // If not all files have been printed, mention how all files can be printed
+        message += `\n\n=> Run ${chalk_1.default.bold('vsce ls')} to see a list of all included files.\n`;
+    }
+    util.log.info(message);
+}
+exports.printPackagedFiles = printPackagedFiles;
 //# sourceMappingURL=package.js.map

package/out/util.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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.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 read_1 = __importDefault(require("read"));
 const WebApi_1 = require("azure-devops-node-api/WebApi");
@@ -166,4 +166,82 @@ function patchOptionsWithManifest(options, manifest) {
     }
 }
 exports.patchOptionsWithManifest = patchOptionsWithManifest;
+function generateFileStructureTree(rootFolder, filePaths, maxPrint = Number.MAX_VALUE) {
+    const folderTree = {};
+    const depthCounts = [];
+    // Build a tree structure from the file paths
+    filePaths.forEach(filePath => {
+        const parts = filePath.split('/');
+        let currentLevel = folderTree;
+        parts.forEach((part, depth) => {
+            if (!currentLevel[part]) {
+                currentLevel[part] = depth === parts.length - 1 ? null : {};
+                if (depthCounts.length <= depth) {
+                    depthCounts.push(0);
+                }
+                depthCounts[depth]++;
+            }
+            currentLevel = currentLevel[part];
+        });
+    });
+    // Get max depth
+    let currentDepth = 0;
+    let countUpToCurrentDepth = depthCounts[0];
+    for (let i = 1; i < depthCounts.length; i++) {
+        if (countUpToCurrentDepth + depthCounts[i] > maxPrint) {
+            break;
+        }
+        currentDepth++;
+        countUpToCurrentDepth += depthCounts[i];
+    }
+    const maxDepth = currentDepth;
+    let message = [];
+    // Helper function to print the tree
+    const printTree = (tree, depth, prefix) => {
+        // Print all files before folders
+        const sortedFolderKeys = Object.keys(tree).filter(key => tree[key] !== null).sort();
+        const sortedFileKeys = Object.keys(tree).filter(key => tree[key] === null).sort();
+        const sortedKeys = [...sortedFileKeys, ...sortedFolderKeys];
+        for (let i = 0; i < sortedKeys.length; i++) {
+            const key = sortedKeys[i];
+            const isLast = i === sortedKeys.length - 1;
+            const localPrefix = prefix + (isLast ? '└─ ' : '├─ ');
+            const childPrefix = prefix + (isLast ? '   ' : '│  ');
+            if (tree[key] === null) {
+                // It's a file
+                message.push(localPrefix + key);
+            }
+            else {
+                // It's a folder
+                if (depth < maxDepth) {
+                    // maxdepth is not reached, print the folder and its children
+                    message.push(localPrefix + chalk_1.default.bold(`${key}/`));
+                    printTree(tree[key], depth + 1, childPrefix);
+                }
+                else {
+                    // max depth is reached, print the folder but not its children
+                    const filesCount = countFiles(tree[key]);
+                    message.push(localPrefix + chalk_1.default.bold(`${key}/`) + chalk_1.default.green(` (${filesCount} ${filesCount === 1 ? 'file' : 'files'})`));
+                }
+            }
+        }
+    };
+    // Helper function to count the number of files in a tree
+    const countFiles = (tree) => {
+        let filesCount = 0;
+        for (const key in tree) {
+            if (tree[key] === null) {
+                filesCount++;
+            }
+            else {
+                filesCount += countFiles(tree[key]);
+            }
+        }
+        return filesCount;
+    };
+    message.push(chalk_1.default.bold(rootFolder));
+    printTree(folderTree, 0, '');
+    return message;
+}
+exports.generateFileStructureTree = generateFileStructureTree;
 //# sourceMappingURL=util.js.map

package/out/validation.js

@@ -35,7 +35,7 @@ function validatePublisher(publisher) {
         throw new Error(`Missing publisher name. Learn more: https://code.visualstudio.com/api/working-with-extensions/publishing-extension#publishing-extensions`);
     }
     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`);
+        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`);
     }
 }
 exports.validatePublisher = validatePublisher;

package/package.json

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