feat: add run --global option

jdanil · jdanil · commit 21333d8bd6fb · 2022-05-29T17:09:01.000+10:00
diff --git a/.github/actions/prepare/action.yml b/.github/actions/prepare/action.yml
@@ -16,7 +16,7 @@ runs:
     - name: 'Build the standard bundle'
       if: steps.cache-build.outputs.cache-hit != 'true'
       run: |
-        node ./scripts/run-yarn.js build:cli
+        node ./scripts/run-yarn.js run --global build:cli
       shell: bash
     #endregion
 
diff --git a/.github/workflows/integration-workflow.yml b/.github/workflows/integration-workflow.yml
@@ -159,10 +159,10 @@ jobs:
     - name: 'Build bundle & plugins'
       run: |
         node --version
-        node ./scripts/run-yarn.js build:pnp:hook
-        node ./scripts/run-yarn.js build:cli
+        node ./scripts/run-yarn.js run --global build:pnp:hook
+        node ./scripts/run-yarn.js run --global build:cli
         mv ./packages/yarnpkg-cli/bundles/yarn.js ./packages/yarnpkg-cli/bundles/yarn-min.js
-        node ./scripts/run-yarn.js build:cli --no-minify
+        node ./scripts/run-yarn.js run --global build:cli --no-minify
       shell: bash
 
     - uses: actions/upload-artifact@v2
@@ -174,7 +174,7 @@ jobs:
 
     - name: 'Build vscode-zipfs'
       run: |
-        node ./scripts/run-yarn.js package:vscode-zipfs
+        node ./scripts/run-yarn.js run --global package:vscode-zipfs
       if: |
         success() || failure()
 
@@ -218,7 +218,7 @@ jobs:
 
     - name: 'Run the integration tests'
       run: |
-        node ./scripts/run-yarn.js test:integration --runInBand
+        node ./scripts/run-yarn.js run --global test:integration --runInBand
       shell: bash
 
     - name: 'Run the unit tests'
diff --git a/.github/workflows/package-workflow.yml b/.github/workflows/package-workflow.yml
@@ -27,7 +27,7 @@ jobs:
     - name: 'Build the standard bundle'
       run: |
         set -ex
-        node ./scripts/run-yarn.js build:cli
+        node ./scripts/run-yarn.js run --global build:cli
 
     - name: 'Build the dist directory'
       run: |
diff --git a/.github/workflows/plugin-compat-workflow.yml b/.github/workflows/plugin-compat-workflow.yml
@@ -23,4 +23,4 @@ jobs:
 
     - name: 'Run the plugin-compat tests'
       run: |
-        node ./scripts/run-yarn.js test:plugin-compat
+        node ./scripts/run-yarn.js run --global test:plugin-compat
diff --git a/.yarn/versions/c5422023.yml b/.yarn/versions/c5422023.yml
@@ -0,0 +1,12 @@
+releases:
+  "@yarnpkg/plugin-essentials": major
+  "@yarnpkg/plugin-workspace-tools": major
+
+declined:
+  - "@yarnpkg/plugin-compat"
+  - "@yarnpkg/plugin-github"
+  - "@yarnpkg/fslib"
+  - "@yarnpkg/nm"
+  - "@yarnpkg/parsers"
+  - "@yarnpkg/pnpify"
+  - "@yarnpkg/shell"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@ Yarn now accepts sponsorships! Please give a look at our [OpenCollective](https:
 - Some legacy layers have been sunset:
   - Plugins cannot access the Clipanion 2 APIs anymore (upgrade to [Clipanion 3](https://github.com/arcanis/clipanion))
   - Plugins cannot access the internal copy of Yup anymore (use [Typanion](https://github.com/arcanis/typanion) instead)
+- Scripts containing a colon are no longer implicitly global. The `--global` option should be used instead.
 
 ### **API Changes**
 
diff --git a/constraints.pro b/constraints.pro
@@ -69,7 +69,7 @@ gen_enforced_field(WorkspaceCwd, 'scripts.update-local', '<any value>') :-
 inline_compile('@yarnpkg/eslint-config').
 inline_compile('@yarnpkg/libui').
 
-gen_enforced_field(WorkspaceCwd, 'scripts.prepack', 'run build:compile "$(pwd)"') :-
+gen_enforced_field(WorkspaceCwd, 'scripts.prepack', 'run --global build:compile "$(pwd)"') :-
   workspace(WorkspaceCwd),
   % This package is built using Rollup, so we allow it to configure its build scripts itself
     \+ workspace_ident(WorkspaceCwd, '@yarnpkg/pnp'),
diff --git a/packages/acceptance-tests/package.json b/packages/acceptance-tests/package.json
@@ -13,7 +13,7 @@
     "pkg-tests-core": "workspace:^"
   },
   "scripts": {
-    "test:integration": "run test:unit --config \"$(pwd)/jest.config.js\""
+    "test:integration": "run --global test:unit --config \"$(pwd)/jest.config.js\""
   },
   "repository": {
     "type": "git",
diff --git a/packages/esbuild-plugin-pnp/package.json b/packages/esbuild-plugin-pnp/package.json
@@ -15,7 +15,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\"",
+    "prepack": "run --global build:compile \"$(pwd)\"",
     "release": "yarn npm publish"
   },
   "publishConfig": {
diff --git a/packages/plugin-compat/package.json b/packages/plugin-compat/package.json
@@ -29,8 +29,8 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\"",
-    "test:plugin-compat": "run test:unit --config \"$(pwd)/jest.config.js\"",
+    "prepack": "run --global build:compile \"$(pwd)\"",
+    "test:plugin-compat": "run --global test:unit --config \"$(pwd)/jest.config.js\"",
     "debug:patch": "node -r @yarnpkg/monorepo/scripts/setup-ts-execution extra/debugPatch \"$INIT_CWD\""
   },
   "publishConfig": {
diff --git a/packages/plugin-constraints/package.json b/packages/plugin-constraints/package.json
@@ -27,7 +27,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/plugin-dlx/package.json b/packages/plugin-dlx/package.json
@@ -23,7 +23,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/plugin-essentials/package.json b/packages/plugin-essentials/package.json
@@ -35,7 +35,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/plugin-essentials/sources/commands/run.ts b/packages/plugin-essentials/sources/commands/run.ts
@@ -56,6 +56,10 @@ export default class RunCommand extends BaseCommand {
     description: `Forwarded to the underlying Node process when executing a binary`,
   });
 
+  global = Option.Boolean(`--global`, false, {
+    description: `Check all workspaces for ones that declare the script uniquely`,
+  });
+
   // The v1 used to print the Yarn version header when using "yarn run", which
   // was messing with the output of things like `--version` & co. We don't do
   // this anymore, but many workflows use `yarn run --silent` to make sure that
@@ -123,13 +127,13 @@ export default class RunCommand extends BaseCommand {
 
     // When it fails, we try to check whether it's a global script (ie we look
     // into all the workspaces to find one that exports this script). We only do
-    // this if the script name contains a colon character (":"), and we skip
+    // this if the `--global` option is passed, and we skip
     // this logic if multiple workspaces share the same script name.
     //
     // We also disable this logic for packages coming from third-parties (ie
     // not workspaces). No particular reason except maybe security concerns.
 
-    if (!this.topLevel && !this.binariesOnly && workspace && this.scriptName.includes(`:`)) {
+    if (!this.topLevel && !this.binariesOnly && workspace && this.global) {
       const candidateWorkspaces = await Promise.all(project.workspaces.map(async workspace => {
         return workspace.manifest.scripts.has(this.scriptName) ? workspace : null;
       }));
diff --git a/packages/plugin-exec/package.json b/packages/plugin-exec/package.json
@@ -16,7 +16,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "repository": {
     "type": "git",
diff --git a/packages/plugin-file/package.json b/packages/plugin-file/package.json
@@ -20,7 +20,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/plugin-git/package.json b/packages/plugin-git/package.json
@@ -27,7 +27,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/plugin-github/package.json b/packages/plugin-github/package.json
@@ -16,9 +16,9 @@
     "@yarnpkg/plugin-git": "workspace:^"
   },
   "scripts": {
-    "test": "run test:unit packages/plugin-github",
+    "test": "run --global test:unit packages/plugin-github",
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "repository": {
     "type": "git",
diff --git a/packages/plugin-http/package.json b/packages/plugin-http/package.json
@@ -19,7 +19,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/plugin-init/package.json b/packages/plugin-init/package.json
@@ -25,7 +25,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/plugin-interactive-tools/package.json b/packages/plugin-interactive-tools/package.json
@@ -35,7 +35,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/plugin-link/package.json b/packages/plugin-link/package.json
@@ -20,7 +20,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/plugin-nm/package.json b/packages/plugin-nm/package.json
@@ -33,7 +33,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/plugin-npm-cli/package.json b/packages/plugin-npm-cli/package.json
@@ -34,7 +34,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/plugin-npm/package.json b/packages/plugin-npm/package.json
@@ -27,7 +27,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/plugin-pack/package.json b/packages/plugin-pack/package.json
@@ -28,7 +28,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/plugin-patch/package.json b/packages/plugin-patch/package.json
@@ -24,7 +24,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/plugin-pnp/package.json b/packages/plugin-pnp/package.json
@@ -29,7 +29,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/plugin-pnpm/package.json b/packages/plugin-pnpm/package.json
@@ -26,7 +26,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/plugin-stage/package.json b/packages/plugin-stage/package.json
@@ -19,7 +19,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "repository": {
     "type": "git",
diff --git a/packages/plugin-typescript/package.json b/packages/plugin-typescript/package.json
@@ -25,7 +25,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "repository": {
     "type": "git",
diff --git a/packages/plugin-version/package.json b/packages/plugin-version/package.json
@@ -30,7 +30,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "repository": {
     "type": "git",
diff --git a/packages/plugin-workspace-tools/package.json b/packages/plugin-workspace-tools/package.json
@@ -25,7 +25,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "repository": {
     "type": "git",
diff --git a/packages/plugin-workspace-tools/sources/commands/foreach.ts b/packages/plugin-workspace-tools/sources/commands/foreach.ts
@@ -112,6 +112,10 @@ export default class WorkspacesForeachCommand extends BaseCommand {
     tolerateBoolean: true,
   });
 
+  global = Option.Boolean(`--global`, false, {
+    description: `Check all workspaces for ones that declare the script uniquely`,
+  });
+
   commandName = Option.String();
   args = Option.Proxy();
 
@@ -155,9 +159,9 @@ export default class WorkspacesForeachCommand extends BaseCommand {
 
     const workspaces: Array<Workspace> = [];
 
-    // A script containing `:` becomes global if it exists in only one workspace.
+    // A script becomes global if run with `--global` and it exists in only one workspace.
     let isGlobalScript = false;
-    if (scriptName?.includes(`:`)) {
+    if (this.global && scriptName) {
       for (const workspace of project.workspaces) {
         if (workspace.manifest.scripts.has(scriptName)) {
           isGlobalScript = !isGlobalScript;
diff --git a/packages/yarnpkg-builder/package.json b/packages/yarnpkg-builder/package.json
@@ -21,7 +21,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\"",
+    "prepack": "run --global build:compile \"$(pwd)\"",
     "release": "yarn npm publish"
   },
   "publishConfig": {
diff --git a/packages/yarnpkg-cli/package.json b/packages/yarnpkg-cli/package.json
@@ -50,7 +50,7 @@
   },
   "scripts": {
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\"",
+    "prepack": "run --global build:compile \"$(pwd)\"",
     "build:cli+hook": "run build:pnp:hook && builder build bundle",
     "build:cli": "builder build bundle",
     "run:cli": "builder run",
diff --git a/packages/yarnpkg-core/package.json b/packages/yarnpkg-core/package.json
@@ -54,7 +54,7 @@
     "build:zip:worker": "rollup -c",
     "update:zip:worker": "run build:zip:worker",
     "postpack": "rm -rf lib",
-    "prepack": "run build:compile \"$(pwd)\""
+    "prepack": "run --global build:compile \"$(pwd)\""
   },
   "publishConfig": {
     "main": "./lib/index.js",
diff --git a/packages/yarnpkg-doctor/package.json b/packages/yarnpkg-doctor/package.json
diff --git a/packages/yarnpkg-extensions/package.json b/packages/yarnpkg-extensions/package.json
diff --git a/packages/yarnpkg-fslib/package.json b/packages/yarnpkg-fslib/package.json
diff --git a/packages/yarnpkg-json-proxy/package.json b/packages/yarnpkg-json-proxy/package.json
diff --git a/packages/yarnpkg-libzip/package.json b/packages/yarnpkg-libzip/package.json
diff --git a/packages/yarnpkg-nm/package.json b/packages/yarnpkg-nm/package.json
diff --git a/packages/yarnpkg-parsers/package.json b/packages/yarnpkg-parsers/package.json
diff --git a/packages/yarnpkg-pnpify/package.json b/packages/yarnpkg-pnpify/package.json
diff --git a/packages/yarnpkg-sdks/package.json b/packages/yarnpkg-sdks/package.json
diff --git a/packages/yarnpkg-shell/package.json b/packages/yarnpkg-shell/package.json
