@yarnpkg/plugin-essentials 4.0.0-rc.25 → 4.0.0-rc.27

package/lib/commands/add.js

@@ -239,7 +239,7 @@ AddCommand.usage = clipanion_1.Command.Usage({
 
       If the \`--mode=<mode>\` option is set, Yarn will change which artifacts are generated. The modes currently supported are:
 
-      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the later will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
+      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the latter will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
 
       - \`update-lockfile\` will skip the link step altogether, and only fetch packages that are missing from the lockfile (or that have no associated checksums). This mode is typically used by tools like Renovate or Dependabot to keep a lockfile up-to-date without incurring the full install cost.
 

package/lib/commands/dedupe.js

@@ -91,7 +91,7 @@ DedupeCommand.usage = clipanion_1.Command.Usage({
 
       If the \`--mode=<mode>\` option is set, Yarn will change which artifacts are generated. The modes currently supported are:
 
-      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the later will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
+      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the latter will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
 
       - \`update-lockfile\` will skip the link step altogether, and only fetch packages that are missing from the lockfile (or that have no associated checksums). This mode is typically used by tools like Renovate or Dependabot to keep a lockfile up-to-date without incurring the full install cost.
 

package/lib/commands/install.js

@@ -288,7 +288,7 @@ YarnCommand.usage = clipanion_1.Command.Usage({
 
       If the \`--mode=<mode>\` option is set, Yarn will change which artifacts are generated. The modes currently supported are:
 
-      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the later will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
+      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the latter will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
 
       - \`update-lockfile\` will skip the link step altogether, and only fetch packages that are missing from the lockfile (or that have no associated checksums). This mode is typically used by tools like Renovate or Dependabot to keep a lockfile up-to-date without incurring the full install cost.
     `,

package/lib/commands/plugin/check.d.ts

@@ -0,0 +1,8 @@
+import { BaseCommand } from '@yarnpkg/cli';
+import { Usage } from 'clipanion';
+export default class PluginCheckCommand extends BaseCommand {
+    static paths: string[][];
+    static usage: Usage;
+    json: boolean;
+    execute(): Promise<1 | 0>;
+}

package/lib/commands/plugin/check.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_1 = require("@yarnpkg/cli");
+const core_1 = require("@yarnpkg/core");
+const clipanion_1 = require("clipanion");
+// eslint-disable-next-line arca/no-default-export
+class PluginCheckCommand extends cli_1.BaseCommand {
+    constructor() {
+        super(...arguments);
+        this.json = clipanion_1.Option.Boolean(`--json`, false, {
+            description: `Format the output as an NDJSON stream`,
+        });
+    }
+    async execute() {
+        const configuration = await core_1.Configuration.find(this.context.cwd, this.context.plugins);
+        const rcFiles = await core_1.Configuration.findRcFiles(this.context.cwd);
+        const report = await core_1.StreamReport.start({
+            configuration,
+            json: this.json,
+            stdout: this.context.stdout,
+        }, async (report) => {
+            var _a;
+            for (const rcFile of rcFiles) {
+                if (!((_a = rcFile.data) === null || _a === void 0 ? void 0 : _a.plugins))
+                    continue;
+                for (const plugin of rcFile.data.plugins) {
+                    if (!plugin.checksum)
+                        continue;
+                    if (!plugin.spec.match(/^https?:/))
+                        continue;
+                    const newBuffer = await core_1.httpUtils.get(plugin.spec, { configuration });
+                    const newChecksum = core_1.hashUtils.makeHash(newBuffer);
+                    if (plugin.checksum === newChecksum)
+                        continue;
+                    const prettyPath = core_1.formatUtils.pretty(configuration, plugin.path, core_1.formatUtils.Type.PATH);
+                    const prettySpec = core_1.formatUtils.pretty(configuration, plugin.spec, core_1.formatUtils.Type.URL);
+                    const prettyMessage = `${prettyPath} is different from the file provided by ${prettySpec}`;
+                    report.reportJson({ ...plugin, newChecksum });
+                    report.reportError(core_1.MessageName.UNNAMED, prettyMessage);
+                }
+            }
+        });
+        return report.exitCode();
+    }
+}
+exports.default = PluginCheckCommand;
+PluginCheckCommand.paths = [
+    [`plugin`, `check`],
+];
+PluginCheckCommand.usage = clipanion_1.Command.Usage({
+    category: `Plugin-related commands`,
+    description: `find all third-party plugins that differ from their own spec`,
+    details: `
+      Check only the plugins from https.
+
+      If this command detects any plugin differences in the CI environment, it will throw an error.
+    `,
+    examples: [[
+            `find all third-party plugins that differ from their own spec`,
+            `$0 plugin check`,
+        ]],
+});

package/lib/commands/plugin/import.d.ts

@@ -6,9 +6,11 @@ export default class PluginImportCommand extends BaseCommand {
     static paths: string[][];
     static usage: Usage;
     name: string;
+    checksum: boolean;
     execute(): Promise<1 | 0>;
 }
-export declare function savePlugin(pluginSpec: string, pluginBuffer: Buffer, { project, report }: {
+export declare function savePlugin(pluginSpec: string, pluginBuffer: Buffer, { checksum, project, report }: {
+    checksum?: boolean;
     project: Project;
     report: Report;
 }): Promise<void>;

package/lib/commands/plugin/import.js

@@ -16,6 +16,9 @@ class PluginImportCommand extends cli_1.BaseCommand {
     constructor() {
         super(...arguments);
         this.name = clipanion_1.Option.String();
+        this.checksum = clipanion_1.Option.Boolean(`--checksum`, true, {
+            description: `Whether to care if this plugin is modified`,
+        });
     }
     async execute() {
         const configuration = await core_1.Configuration.find(this.context.cwd, this.context.plugins);
@@ -70,7 +73,7 @@ class PluginImportCommand extends cli_1.BaseCommand {
                 report.reportInfo(core_1.MessageName.UNNAMED, `Downloading ${core_2.formatUtils.pretty(configuration, pluginUrl, `green`)}`);
                 pluginBuffer = await core_2.httpUtils.get(pluginUrl, { configuration });
             }
-            await savePlugin(pluginSpec, pluginBuffer, { project, report });
+            await savePlugin(pluginSpec, pluginBuffer, { checksum: this.checksum, project, report });
         });
         return report.exitCode();
     }
@@ -91,6 +94,8 @@ PluginImportCommand.usage = clipanion_1.Command.Usage({
       - Third-party plugins can be referenced directly through their public urls.
       - Local plugins can be referenced by their path on the disk.
 
+      If the \`--no-checksum\` option is set, Yarn will no longer care if the plugin is modified.
+
       Plugins cannot be downloaded from the npm registry, and aren't allowed to have dependencies (they need to be bundled into a single file, possibly thanks to the \`@yarnpkg/builder\` package).
     `,
     examples: [[
@@ -107,7 +112,7 @@ PluginImportCommand.usage = clipanion_1.Command.Usage({
             `$0 plugin import ./path/to/plugin.js`,
         ]],
 });
-async function savePlugin(pluginSpec, pluginBuffer, { project, report }) {
+async function savePlugin(pluginSpec, pluginBuffer, { checksum = true, project, report }) {
     const { configuration } = project;
     const vmExports = {};
     const vmModule = { exports: vmExports };
@@ -125,26 +130,8 @@ async function savePlugin(pluginSpec, pluginBuffer, { project, report }) {
         path: relativePath,
         spec: pluginSpec,
     };
-    await core_1.Configuration.updateConfiguration(project.cwd, (current) => {
-        const plugins = [];
-        let hasBeenReplaced = false;
-        for (const entry of current.plugins || []) {
-            const userProvidedPath = typeof entry !== `string`
-                ? entry.path
-                : entry;
-            const pluginPath = fslib_1.ppath.resolve(project.cwd, fslib_1.npath.toPortablePath(userProvidedPath));
-            const { name } = core_1.miscUtils.dynamicRequire(pluginPath);
-            if (name !== pluginName) {
-                plugins.push(entry);
-            }
-            else {
-                plugins.push(pluginMeta);
-                hasBeenReplaced = true;
-            }
-        }
-        if (!hasBeenReplaced)
-            plugins.push(pluginMeta);
-        return { ...current, plugins };
-    });
+    if (checksum)
+        pluginMeta.checksum = core_2.hashUtils.makeHash(pluginBuffer);
+    await core_1.Configuration.addPlugin(project.cwd, [pluginMeta]);
 }
 exports.savePlugin = savePlugin;

package/lib/commands/remove.js

@@ -114,7 +114,7 @@ RemoveCommand.usage = clipanion_1.Command.Usage({
 
       If the \`--mode=<mode>\` option is set, Yarn will change which artifacts are generated. The modes currently supported are:
 
-      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the later will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
+      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the latter will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
 
       - \`update-lockfile\` will skip the link step altogether, and only fetch packages that are missing from the lockfile (or that have no associated checksums). This mode is typically used by tools like Renovate or Dependabot to keep a lockfile up-to-date without incurring the full install cost.
 

package/lib/commands/up.js

@@ -257,7 +257,7 @@ UpCommand.usage = clipanion_1.Command.Usage({
 
       If the \`--mode=<mode>\` option is set, Yarn will change which artifacts are generated. The modes currently supported are:
 
-      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the later will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
+      - \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the latter will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.
 
       - \`update-lockfile\` will skip the link step altogether, and only fetch packages that are missing from the lockfile (or that have no associated checksums). This mode is typically used by tools like Renovate or Dependabot to keep a lockfile up-to-date without incurring the full install cost.
 

package/lib/index.d.ts

@@ -19,6 +19,7 @@ import InfoCommand from './commands/info';
 import YarnCommand from './commands/install';
 import LinkCommand from './commands/link';
 import NodeCommand from './commands/node';
+import PluginCheckCommand from './commands/plugin/check';
 import PluginImportSourcesCommand from './commands/plugin/import/sources';
 import PluginImportCommand from './commands/plugin/import';
 import PluginListCommand from './commands/plugin/list';
@@ -58,6 +59,7 @@ export { YarnCommand };
 export { LinkCommand };
 export { NodeCommand };
 export { PluginImportSourcesCommand };
+export { PluginCheckCommand };
 export { PluginImportCommand };
 export { PluginListCommand };
 export { PluginRemoveCommand };

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.suggestUtils = exports.dedupeUtils = exports.WorkspaceCommand = exports.WorkspacesListCommand = exports.WhyCommand = exports.UpCommand = exports.UnlinkCommand = exports.SetVersionCommand = exports.SetVersionSourcesCommand = exports.SetResolutionCommand = exports.RunCommand = exports.RunIndexCommand = exports.RemoveCommand = exports.RebuildCommand = exports.PluginRuntimeCommand = exports.PluginRemoveCommand = exports.PluginListCommand = exports.PluginImportCommand = exports.PluginImportSourcesCommand = exports.NodeCommand = exports.LinkCommand = exports.YarnCommand = exports.InfoCommand = exports.ExplainCommand = exports.ExplainPeerRequirementsCommand = exports.ExecCommand = exports.VersionCommand = exports.EntryCommand = exports.HelpCommand = exports.ClipanionCommand = exports.DedupeCommand = exports.ConfigCommand = exports.ConfigUnsetCommand = exports.ConfigSetCommand = exports.ConfigGetCommand = exports.CacheCleanCommand = exports.BinCommand = exports.AddCommand = void 0;
+exports.suggestUtils = exports.dedupeUtils = exports.WorkspaceCommand = exports.WorkspacesListCommand = exports.WhyCommand = exports.UpCommand = exports.UnlinkCommand = exports.SetVersionCommand = exports.SetVersionSourcesCommand = exports.SetResolutionCommand = exports.RunCommand = exports.RunIndexCommand = exports.RemoveCommand = exports.RebuildCommand = exports.PluginRuntimeCommand = exports.PluginRemoveCommand = exports.PluginListCommand = exports.PluginImportCommand = exports.PluginCheckCommand = exports.PluginImportSourcesCommand = exports.NodeCommand = exports.LinkCommand = exports.YarnCommand = exports.InfoCommand = exports.ExplainCommand = exports.ExplainPeerRequirementsCommand = exports.ExecCommand = exports.VersionCommand = exports.EntryCommand = exports.HelpCommand = exports.ClipanionCommand = exports.DedupeCommand = exports.ConfigCommand = exports.ConfigUnsetCommand = exports.ConfigSetCommand = exports.ConfigGetCommand = exports.CacheCleanCommand = exports.BinCommand = exports.AddCommand = void 0;
 const tslib_1 = require("tslib");
 const core_1 = require("@yarnpkg/core");
 const ci_info_1 = require("ci-info");
@@ -42,6 +42,8 @@ const link_1 = tslib_1.__importDefault(require("./commands/link"));
 exports.LinkCommand = link_1.default;
 const node_1 = tslib_1.__importDefault(require("./commands/node"));
 exports.NodeCommand = node_1.default;
+const check_1 = tslib_1.__importDefault(require("./commands/plugin/check"));
+exports.PluginCheckCommand = check_1.default;
 const sources_1 = tslib_1.__importDefault(require("./commands/plugin/import/sources"));
 exports.PluginImportSourcesCommand = sources_1.default;
 const import_1 = tslib_1.__importDefault(require("./commands/plugin/import"));
@@ -124,6 +126,7 @@ const plugin = {
         link_1.default,
         unlink_1.default,
         node_1.default,
+        check_1.default,
         sources_1.default,
         import_1.default,
         remove_1.default,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yarnpkg/plugin-essentials",
-  "version": "4.0.0-rc.25",
+  "version": "4.0.0-rc.27",
   "stableVersion": "3.2.3",
   "license": "BSD-2-Clause",
   "main": "./lib/index.js",
@@ -9,8 +9,8 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@yarnpkg/fslib": "^3.0.0-rc.25",
-    "@yarnpkg/parsers": "^3.0.0-rc.25",
+    "@yarnpkg/fslib": "^3.0.0-rc.27",
+    "@yarnpkg/parsers": "^3.0.0-rc.27",
     "ci-info": "^3.2.0",
     "clipanion": "^3.2.0-rc.10",
     "enquirer": "^2.3.6",
@@ -21,17 +21,17 @@
     "typanion": "^3.3.0"
   },
   "peerDependencies": {
-    "@yarnpkg/cli": "^4.0.0-rc.25",
-    "@yarnpkg/core": "^4.0.0-rc.25",
-    "@yarnpkg/plugin-git": "^3.0.0-rc.25"
+    "@yarnpkg/cli": "^4.0.0-rc.27",
+    "@yarnpkg/core": "^4.0.0-rc.27",
+    "@yarnpkg/plugin-git": "^3.0.0-rc.27"
   },
   "devDependencies": {
     "@types/lodash": "^4.14.136",
     "@types/micromatch": "^4.0.1",
     "@types/semver": "^7.1.0",
-    "@yarnpkg/cli": "^4.0.0-rc.25",
-    "@yarnpkg/core": "^4.0.0-rc.25",
-    "@yarnpkg/plugin-git": "^3.0.0-rc.25"
+    "@yarnpkg/cli": "^4.0.0-rc.27",
+    "@yarnpkg/core": "^4.0.0-rc.27",
+    "@yarnpkg/plugin-git": "^3.0.0-rc.27"
   },
   "repository": {
     "type": "git",