feat(core): add an option to run-many by tags

`nx run-many --target=deploy --tags=foo` runs the given target for all projects that have a tag `foo` configured in nx.json. Closes nrwl#2675.
Schibum · Jan 18, 2021 · d8915d3 · d8915d3
1 parent a1c4d94
commit d8915d3
Show file tree

Hide file tree

Showing 64 changed files with 34,977 additions and 6 deletions.
diff --git a/docs/angular/cli/run-many.md b/docs/angular/cli/run-many.md
@@ -36,6 +36,12 @@ Build proj1 and proj2 and all their dependencies.:
 nx run-many --target=test --projects=proj1,proj2 --with-deps
 ```
 
+Test all projects that are tagged with foo or bar.:
+
+```bash
+nx run-many --target=test --tags=foo,bar
+```
+
 ## Options
 
 ### all
@@ -78,6 +84,10 @@ Default: `false`
 
 Rerun the tasks even when the results are available in the cache
 
+### tags
+
+Run projects having any of the given tags (comma delimited)
+
 ### target
 
 Task to run for affected projects

diff --git a/docs/node/cli/run-many.md b/docs/node/cli/run-many.md
@@ -36,6 +36,12 @@ Build proj1 and proj2 and all their dependencies.:
 nx run-many --target=test --projects=proj1,proj2 --with-deps
 ```
 
+Test all projects that are tagged with foo or bar.:
+
+```bash
+nx run-many --target=test --tags=foo,bar
+```
+
 ## Options
 
 ### all
@@ -78,6 +84,10 @@ Default: `false`
 
 Rerun the tasks even when the results are available in the cache
 
+### tags
+
+Run projects having any of the given tags (comma delimited)
+
 ### target
 
 Task to run for affected projects

diff --git a/docs/react/cli/run-many.md b/docs/react/cli/run-many.md
@@ -36,6 +36,12 @@ Build proj1 and proj2 and all their dependencies.:
 nx run-many --target=test --projects=proj1,proj2 --with-deps
 ```
 
+Test all projects that are tagged with foo or bar.:
+
+```bash
+nx run-many --target=test --tags=foo,bar
+```
+
 ## Options
 
 ### all
@@ -78,6 +84,10 @@ Default: `false`
 
 Rerun the tasks even when the results are available in the cache
 
+### tags
+
+Run projects having any of the given tags (comma delimited)
+
 ### target
 
 Task to run for affected projects

diff --git a/e2e/workspace/src/workspace.test.ts b/e2e/workspace/src/workspace.test.ts
@@ -66,13 +66,20 @@ describe('run-many', () => {
     const libB = uniq('libb-rand');
     const libC = uniq('libc-rand');
     const libD = uniq('libd-rand');
+    const tagA = uniq('taga-rand');
 
     runCLI(`generate @nrwl/angular:app ${appA}`);
     runCLI(`generate @nrwl/angular:lib ${libA} --buildable --defaults`);
     runCLI(`generate @nrwl/angular:lib ${libB} --buildable --defaults`);
     runCLI(`generate @nrwl/angular:lib ${libC} --buildable --defaults`);
     runCLI(`generate @nrwl/angular:lib ${libD} --defaults`);
 
+    // Add tagA to appA and libC
+    const nxJson: NxJson = readJson('nx.json');
+    nxJson.projects[appA].tags = [tagA];
+    nxJson.projects[libC].tags = [tagA];
+    updateFile('nx.json', JSON.stringify(nxJson));
+
     // libA depends on libC
     updateFile(
       `libs/${libA}/src/lib/${libA}.module.spec.ts`,
@@ -97,6 +104,15 @@ describe('run-many', () => {
     expect(buildParallel).not.toContain(`- ${libD}`);
     expect(buildParallel).toContain('Running target "build" succeeded');
 
+    // testing run many tags starting
+    const buildTags = runCLI(`run-many --target=build --tags="${tagA}"`);
+    expect(buildTags).toContain(`Running target build for projects:`);
+    expect(buildTags).toContain(`- ${libA}`);
+    expect(buildTags).not.toContain(`- ${libB}`);
+    expect(buildTags).toContain(`- ${libC}`);
+    expect(buildTags).not.toContain(`- ${libD}`);
+    expect(buildTags).toContain('Running target "build" succeeded');
+
     // testing run many --all starting
     const buildAllParallel = runCLI(`run-many --target=build --all`);
     expect(buildAllParallel).toContain(`Running target build for projects:`);

diff --git a/packages/workspace/src/command-line/nx-commands.ts b/packages/workspace/src/command-line/nx-commands.ts
@@ -315,14 +315,25 @@ function withRunManyOptions(yargs: yargs.Argv): yargs.Argv {
       describe: 'Projects to run (comma delimited)',
       type: 'string',
     })
+    .option('tags', {
+      describe: 'Run projects having any of the given tags (comma delimited)',
+      type: 'string',
+    })
     .option('all', {
       describe: 'Run the target on all projects in the workspace',
       type: 'boolean',
       default: undefined,
     })
-    .check(({ all, projects }) => {
-      if ((all && projects) || (!all && !projects))
-        throw new Error('You must provide either --all or --projects');
+    .check(({ all, projects, tags }) => {
+      if (
+        (all && projects) ||
+        (projects && tags) ||
+        (all && tags) ||
+        (!all && !projects && !tags)
+      )
+        throw new Error(
+          'You must provide either --all or --projects or --tags'
+        );
       return true;
     })
     .options('runner', {

diff --git a/packages/workspace/src/command-line/run-many.ts b/packages/workspace/src/command-line/run-many.ts
@@ -9,7 +9,7 @@ import {
   ProjectGraphNode,
   withDeps,
 } from '../core/project-graph';
-import { readEnvironment } from '../core/file-utils';
+import { readEnvironment, readNxJson } from '../core/file-utils';
 import { DefaultReporter } from '../tasks-runner/default-reporter';
 import { projectHasTarget } from '../utils/project-graph-utils';
 import { output } from '../utils/output';
@@ -44,14 +44,28 @@ export async function runMany(parsedArgs: yargs.Arguments) {
   );
 }
 
+function selectProjectsFromTags(tags: string[]): string[] {
+  let nxJson = readNxJson();
+  return Object.entries(nxJson.projects)
+    .filter(([name, project]) => {
+      let projectTags = project.tags || [];
+      return tags.some((tag) => projectTags.includes(tag));
+    })
+    .map(([name]) => name);
+}
+
 function projectsToRun(nxArgs: NxArgs, projectGraph: ProjectGraph) {
   const allProjects = Object.values(projectGraph.nodes);
   if (nxArgs.all) {
     return runnableForTarget(allProjects, nxArgs.target);
   } else {
+    let projects = nxArgs.projects;
+    if (projects.length === 0) {
+      projects = selectProjectsFromTags(nxArgs.tags);
+    }
     checkForInvalidProjects(nxArgs, allProjects);
     let selectedProjects = allProjects.filter(
-      (p) => nxArgs.projects.indexOf(p.name) > -1
+      (p) => projects.indexOf(p.name) > -1
     );
     if (nxArgs.withDeps) {
       selectedProjects = Object.values(

diff --git a/packages/workspace/src/command-line/utils.ts b/packages/workspace/src/command-line/utils.ts
@@ -21,7 +21,7 @@ const runOne = [
   'scan',
 ];
 
-const runMany = [...runOne, 'projects', 'quiet', 'all', 'verbose'];
+const runMany = [...runOne, 'projects', 'tags', 'quiet', 'all', 'verbose'];
 
 const runAffected = [
   ...runOne,
@@ -65,6 +65,7 @@ export interface NxArgs {
   withDeps?: boolean;
   'with-deps'?: boolean;
   projects?: string[];
+  tags?: string[];
   select?: string;
   skipNxCache?: boolean;
   'skip-nx-cache'?: boolean;
@@ -102,6 +103,13 @@ export function splitArgsIntoNxArgsAndOverrides(
         .split(',')
         .map((p: string) => p.trim());
     }
+    if (!nxArgs.tags) {
+      nxArgs.tags = [];
+    } else {
+      nxArgs.tags = (args.tags as string)
+        .split(',')
+        .map((p: string) => p.trim());
+    }
   }
 
   if (nxArgs.prod) {

diff --git a/play/play/.editorconfig b/play/play/.editorconfig
@@ -0,0 +1,13 @@
+# Editor configuration, see http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false
diff --git a/play/play/.eslintrc.json b/play/play/.eslintrc.json
@@ -0,0 +1,33 @@
+{
+  "root": true,
+  "ignorePatterns": ["**/*"],
+  "plugins": ["@nrwl/nx"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {
+        "@nrwl/nx/enforce-module-boundaries": [
+          "error",
+          {
+            "enforceBuildableLibDependency": true,
+            "allow": [],
+            "depConstraints": [
+              { "sourceTag": "*", "onlyDependOnLibsWithTags": ["*"] }
+            ]
+          }
+        ]
+      }
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "extends": ["plugin:@nrwl/nx/typescript"],
+      "parserOptions": { "project": "./tsconfig.*?.json" },
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "extends": ["plugin:@nrwl/nx/javascript"],
+      "rules": {}
+    }
+  ]
+}
diff --git a/play/play/.gitignore b/play/play/.gitignore
@@ -0,0 +1,39 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist
+/tmp
+/out-tsc
+
+# dependencies
+/node_modules
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# misc
+/.sass-cache
+/connect.lock
+/coverage
+/libpeerconnection.log
+npm-debug.log
+yarn-error.log
+testem.log
+/typings
+
+# System Files
+.DS_Store
+Thumbs.db
diff --git a/play/play/.prettierignore b/play/play/.prettierignore
@@ -0,0 +1,4 @@
+# Add files here to ignore them from prettier formatting
+
+/dist
+/coverage
diff --git a/play/play/.prettierrc b/play/play/.prettierrc
@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}
diff --git a/play/play/.vscode/extensions.json b/play/play/.vscode/extensions.json
@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "ms-vscode.vscode-typescript-tslint-plugin",
+    "esbenp.prettier-vscode",
+    "firsttris.vscode-jest-runner"
+  ]
+}