Commands and tasks in NX

In NX a command represents something like nx run header:build, whereas build is the target, header is the project and header:build is the task.

Running a single task on a single project

nx mytarget myproject

Running multiple tasks on a single project

Running a single task on all projects

nx run-many --target=mytarget

Running a single task on all projects affected in a PR:

nx affected --target=mytarget

There are some predefined tasks:

1
yarn nx run myapp:serve
2
yarn nx run myapp:lint
3
yarn nx run myapp:test

Tasks can be defined as npm scripts in a project’s package.json file or as targets in a project.json file, so have a look at /apps/myapp/project.json to see all available commands or modify them there. If you installed storybook then that would be the place to change the storybook.options.port.

A target in a project.json might look like this:

1
{
2
  "targets": {
3
    "build": {
4
      "executor": "nx:run-commands",
5
      "options": {
6
        "command": "webpack -c webpack.conf.js"
7
      }
8
    },
9
    "test": {
10
      "executor": "@nrwl/jest:jest",
11
      "options": {
12
        "codeCoverage": true
13
      }
14
    }
15
  }
16
}

Running commands parallelly

We can call the serve command (aka target) for more than just one app/project and have them run parallelly:

1
yarn nx run-many --target=serve --projects=my-api,my-app --parallel=true

Creating custom commands

You can create a custom commands, for example one that cares of serving the app and api together. Edit a project.json of one of your libs or apps:

1
"targets": {
2
//...
3
    "serveCraAndStorybook" : {
4
      "builder" : "@nrwl/workspace:run-commands",
5
      "options": {
6
        "commands" : [
7
          {
8
            "command": "nx run ui:storybook"
9
          },
10
          {
11
            "command": "nx run pr-cra:serve"
12
          }
13
        ]
14
      }
15
    },
16
//...
17
}