Don't try to run scripts that aren't defined.

Author: peterlebrun

CHANGELOG.md

@@ -3,6 +3,7 @@
 Please add one entry in this file for each change in Yarn's behavior. Use the same format for all entries, including the third-person verb. Make sure you don't add more than one line of text to keep it clean. Thanks!
 
 ## Master
+- Stop `yarn workspaces run` error if command not defined in workspace
 
 ## 1.13.0
 

__tests__/commands/workspaces.js

@@ -48,7 +48,7 @@ test('workspaces info should list the workspaces', (): Promise<void> => {
   });
 });
 
-test('workspaces run should spawn command for each workspace', (): Promise<void> => {
+test('workspaces run should spawn command for each workspace with that script defined', (): Promise<void> => {
   const originalArgs = ['run', 'script', 'arg1', '--flag1'];
   return runWorkspaces({originalArgs}, ['run', 'script', 'arg1', '--flag1'], 'run-basic', config => {
     expect(spawn).toHaveBeenCalledWith(NODE_BIN_PATH, [YARN_BIN_PATH, 'script', 'arg1', '--flag1'], {
@@ -61,3 +61,13 @@ test('workspaces run should spawn command for each workspace', (): Promise<void>
     });
   });
 });
+
+test('workspaces run should not report error if command is not defined for a workspace', (): Promise<void> => {
+  const originalArgs = ['run', 'workspace-1-only-script', 'arg1', '--flag1'];
+  return runWorkspaces({originalArgs}, ['run', 'workspace-1-only-script', 'arg1', '--flag1'], 'run-basic', config => {
+    expect(spawn).toHaveBeenCalledWith(NODE_BIN_PATH, [YARN_BIN_PATH, 'workspace-1-only-script', 'arg1', '--flag1'], {
+      stdio: 'inherit',
+      cwd: path.join(fixturesLoc, 'run-basic', 'packages', 'workspace-child-1'),
+    });
+  });
+});

__tests__/fixtures/workspace/run-basic/packages/workspace-child-1/package.json

@@ -4,6 +4,7 @@
   "scripts": {
     "prescript": "echo workspace-1 prescript",
     "script": "echo workspace-1 script",
-    "postscript": "echo workspace-1 postscript"
+    "postscript": "echo workspace-1 postscript",
+    "workspace-1-only-script": "echo workspace-1-only script"
   }
 }

packages/pkg-tests/pkg-tests-core/package.json

@@ -10,5 +10,8 @@
         "super-resolve": "^1.0.0",
         "tar-fs": "^1.16.0",
         "tmp": "^0.0.33"
+    },
+    "scripts": {
+        "script": "echo pkg-tests-core script"
     }
 }

src/cli/commands/workspaces.js

@@ -77,8 +77,30 @@ export async function runScript(config: Config, reporter: Reporter, flags: Objec
   try {
     const [_, ...rest] = flags.originalArgs || [];
 
+    // first arg not prefixed by `-` is the script that will be run
+    let scriptName = '';
+    for (const arg of rest) {
+      if (arg.startsWith('-')) {
+        continue;
+      }
+      scriptName = arg;
+      break;
+    }
+
     for (const workspaceName of Object.keys(workspaces)) {
-      const {loc} = workspaces[workspaceName];
+      const {loc, manifest} = workspaces[workspaceName];
+
+      // Let the user know what workspace we're running in...
+      reporter.identifyWorkspace(workspaceName);
+
+      // ...and whether the script doesn't exist
+      if (!manifest.scripts) {
+        reporter.warn(`No scripts defined.`);
+        continue;
+      } else if (!manifest.scripts[scriptName]) {
+        reporter.warn(`${scriptName} not defined.`);
+        continue;
+      }
 
       await child.spawn(NODE_BIN_PATH, [YARN_BIN_PATH, ...rest], {
         stdio: 'inherit',

src/reporters/base-reporter.js

@@ -228,6 +228,9 @@ export default class BaseReporter {
   // a table structure
   table(head: Array<string>, body: Array<Array<string>>) {}
 
+  // identify which workspace we're in
+  identifyWorkspace(msg: string) {}
+
   // security audit action to resolve advisories
   auditAction(recommendation: AuditActionRecommendation) {}
 

src/reporters/console/console-reporter.js

@@ -159,6 +159,10 @@ export default class ConsoleReporter extends BaseReporter {
     }
   }
 
+  identifyWorkspace(msg: string) {
+    this.log(this.format.bold(`\n${msg}`));
+  }
+
   header(command: string, pkg: Package) {
     this.log(this.format.bold(`${pkg.name} ${command} v${pkg.version}`));
   }