Merge pull request #85 from ianwremmel/fix-arbitrary-run

Fix running of arbitrary commands without definition in .clarkrc
ianwremmel · Apr 12, 2018 · 603e390 · 603e390
2 parents 5f67f43 + 34450dc
commit 603e390
Show file tree

Hide file tree

Showing 5 changed files with 68 additions and 36 deletions.
diff --git a/src/commands/run.ts b/src/commands/run.ts
@@ -2,10 +2,10 @@ import {CommandModule} from 'yargs';
 import {Run} from '../lib/handlers/run';
 
 const RunCommand: CommandModule = {
-  command: 'run',
+  command: 'run [script]',
 
   describe:
-    'Runs a script in each package directory. This is different from `exec` in that scripts must be defined in .clarkrc and may be overridden on a per-package basis via npm scripts.',
+    'Runs a script in each package directory. This is different from `exec` in that scripts should be defined in .clarkrc and may be overridden on a per-package basis via npm scripts. npm scripts defined only in subpackage package.jsons can be run this way, but only scripts named in .clarkrc will populate the help output.',
 
   builder: Run.builder,
 

diff --git a/src/lib/handlers/run.ts b/src/lib/handlers/run.ts
@@ -14,7 +14,7 @@ export namespace Run {
     const config = load();
 
     if (config.scripts && config.scripts) {
-      return Object.entries(config.scripts).reduce(
+      yargs = Object.entries(config.scripts).reduce(
         (y, [command, script]: [string, string]): Argv =>
           y.command({
             command,
@@ -27,41 +27,17 @@ export namespace Run {
                 type: 'string',
               }),
             handler: async (argv: apply.InvocationOptions): Promise<void> => {
-              await apply(
-                {
-                  before: (packages) =>
-                    f`Running ${command} against ${packages.length} packages`,
-                  beforeEach: (packageName) =>
-                    f`Running ${command} against ${packageName}`,
-                  afterEach: (packageName, error) => {
-                    if (error) {
-                      return `${command} failed against ${packageName}`;
-                    }
-                    return `Ran ${command} against ${packageName}`;
-                  },
-                  after: (packages, errors) => {
-                    if (errors.length) {
-                      return f`clark run failed to execute the following command against ${
-                        errors.length
-                      } packages\n> ${command}\n`;
-                    }
-
-                    return `Ran ${command} successfully against ${
-                      packages.length
-                    }`;
-                  },
-                },
-                async (packageName) => {
-                  await execScript(command, packageName, script);
-                },
-                argv,
-              );
+              await handle(command, script, argv);
             },
           }),
         yargs,
       );
     }
     return yargs
+      .positional('script', {
+        describe: 'npm run script to execute in each package that defines it. ',
+        type: 'string',
+      })
       .options({
         'fail-fast': {
           alias: 'ff',
@@ -80,11 +56,49 @@ export namespace Run {
       .strict();
   }
 
+  /**
+   * Helper
+   */
+  async function handle(
+    command: string,
+    script: string,
+    argv: apply.InvocationOptions,
+  ) {
+    await apply(
+      {
+        before: (packages) =>
+          f`Running ${command} against ${packages.length} packages`,
+        beforeEach: (packageName) =>
+          f`Running ${command} against ${packageName}`,
+        afterEach: (packageName, error) => {
+          if (error) {
+            return `${command} failed against ${packageName}`;
+          }
+          return `Ran ${command} against ${packageName}`;
+        },
+        after: (packages, errors) => {
+          if (errors.length) {
+            return f`clark run failed to execute the following command against ${
+              errors.length
+            } packages\n> ${command}\n`;
+          }
+
+          return `Ran ${command} successfully against ${packages.length}`;
+        },
+      },
+      async (packageName) => {
+        await execScript(command, packageName, script);
+      },
+      argv,
+    );
+  }
   /**
    * Implementation of the run command
    * @param options
    */
-  export async function handler(): Promise<void> {
-    // noop
+  export async function handler(
+    argv: apply.InvocationOptions & {script: string},
+  ): Promise<void> {
+    await handle(argv.script, '', argv);
   }
 }
diff --git a/...on/fixtures/monorepo/packages/node_modules/@example/scoped-package-the-first/package.json b/...on/fixtures/monorepo/packages/node_modules/@example/scoped-package-the-first/package.json
diff --git a/...n/fixtures/monorepo/packages/node_modules/@example/scoped-package-the-second/package.json b/...n/fixtures/monorepo/packages/node_modules/@example/scoped-package-the-second/package.json
diff --git a/test/integration/spec/run.ts b/test/integration/spec/run.ts
@@ -62,4 +62,18 @@ describe('run', () => {
       assert.equal(result, 'this is an override');
     });
   });
+
+  describe('when invoked with a script not in .clarkrc', () => {
+    it('runs that script in any package that defines it', async () => {
+      const result = await run('clark run --silent not-in-clarkrc');
+      assert.equal(result, '1\n2');
+    });
+
+    it('supports --package', async () => {
+      const result = await run(
+        'clark run --silent --package @example/scoped-package-the-first not-in-clarkrc',
+      );
+      assert.equal(result, '1');
+    });
+  });
 });