The Workspace plugin contains executors and generators that are useful for any Nx workspace. It should be present in every Nx workspace and other plugins build on it.

The workspace plugin contains executors and generators that are useful for any Nx workspace. It should be present in every Nx workspace and other plugins build on it.

## Creating Local Generators

Codifying your organization's best practices into local generators is a great way to ensure that the best practices are easy to follow and implement. Running `nx g @nrwl/nx-plugin:plugin feature` will create a local plugin with a generator which is written the same way generators are written for Nx plugins.

> See more about [local generators](/recipe/local-generators)

## Reorganizing Projects

After some time of working within a workspace, projects might need to be moved or sometimes even removed.
The workspace plugin provides the [`@nrwl/workspace:move`](/packages/workspace/generators/move) and [`@nrwl/workspace:remove`](/packages/workspace/generators/remove) generators to help aid with this.

### Moving Projects

Running `nx g @nrwl/workspace:move --projectName my-lib --destination new/location/my-lib` will move the `my-lib` library to `libs/new/location/my-lib`.

Moving the files manually can be done easily but a lot of steps are often missed when projects are moved. This generator will also handle the following:

1. The project's files will be moved
2. The project will be renamed to `new-location-my-lib`
3. The path mapping in `tsconfig.base.json` will be changed to `@npmScope/new/location/my-lib`
4. Imports in other projects will be changed to `@npmScope/new/location/my-lib`
5. Paths in target options such as output path will be changed
6. Other configuration will be updated too, such as `extends` in `tsconfig.json`, the name of the project in `jest.config.js`, and the extends in `.eslintrc.json`

> See more about [`@nrwl/workspace:move`](/packages/workspace/generators/move)

### Removing Projects

Running `nx g @nrwl/workspace:remove my-lib` will remove the `my-lib` from the workspace. It is important to note that sometimes, projects cannot be removed if they are still depended on by other projects.

Like when moving projects, some steps are often missed when removing projects. This generator will also handle the following:

1. Checks if other projects depend on the project being removed. This can be ignored via the `--forceRemove` flag.
2. The project's files will be deleted.
3. The project's configuration will be removed.
4. The path mapping in `tsconfig.base.json` will be removed.

> See more about [`@nrwl/workspace:remove`](/packages/workspace/generators/remove)

## Running custom commands

Executors provide an optimized way of running targets but unfortunately, not every target has an executor written for it. The [`nx:run-commands`](/packages/nx/executors/run-commands) executor is an executor that runs any command or multiple commands in the shell. This can be useful when integrating with other tools which do not have an executor provided. There is also a generator to help configure this executor.

Running `nx g @nrwl/workspace:run-commands printhello --project my-feature-lib --command 'echo hello'` will create a `my-feature-lib:printhello` target that executes `echo hello` in the shell.

> See more about [`nx:run-commands`](/packages/nx/executors/run-commands)


Overview

# Nx, NodeJS and TypeScript Compatibility Matrix

Below is a reference table that matches versions the latest major versions of Nx to the version TypeScript that it uses and the version of NodeJS that we tested it against.

> _Note: Other versions of NodeJS **may** still work without issue for these versions of Nx. This table outlines the version of NodeJS that we used when building and testing each particular version of Nx._

| Nx Version | Node Version | Typescript Version |
| ---------- | ------------ | ------------------ |
| 10.4.15    | ^12.18       | 4.0.3              |
| 11.6.3     | ^12.20       | 4.0.5              |
| 12.10.1    | ^14.17       | ~4.3.5             |
| 13.10.6    | ^16.5.0      | ~4.6.2             |
| 14.5.4     | ^16.16.0     | ~4.7.2             |
| latest     | ^16.16.0     | ~4.7.2             |


Nx, NodeJS and Typescript Versions

run-commands

Arguments forwarding

Custom done conditions

Setting the cwd

Extra arguments. You can pass them as follows: nx run project:target --args='--wait=100'. You can then use {args.wait} syntax to interpolate them in the workspace config file. See example [above](#chaining-commands-interpolating-args-and-setting-the-cwd)

Use colors when showing output of command.

Current working directory of the commands. If it's not specified the commands will run in the workspace root, if a relative path is specified the commands will run in that path relative to the workspace root and if it's an absolute path the commands will run in that path.

Allows you to specify where the build artifacts are stored. This allows Nx Cloud to pick them up correctly, in the case that the build artifacts are placed somewhere other than the top level dist folder.

String to appear in `stdout` or `stderr` that indicates that the task is done. When running multiple commands, this option can only be used when `parallel` is set to `true`. If not specified, the task is done when all the child processes complete.

Run Commands

counter

Counter

run-script

Run any NPM script of a project in the project's root directory.

An npm script name in the `package.json` file of the project (e.g., `build`).

Run Script

workspace

CLI used for generating code and running tasks

The directory name to create the workspace in.

The package manager used to install dependencies.

Create an empty workspace

Create application in an empty workspace.

preset

Split the project configurations into `<projectRoot>/project.json` rather than including it inside `workspace.json`.

Creates applications in a new workspace

Move an application or library to another folder.

move

Move a project to another folder in the workspace.

Move `libs/my-feature-lib` to `libs/shared/my-feature-lib`

The new import path to use in the `tsconfig.base.json`.

Should the generator update the import path to reflect the new location?

Nx Move

remove

Remove `my-feature-lib` from the workspace

Force removal of `my-feature-lib` from the workspace

When `true`, forces removal even if the project is still in use.

Nx Remove

CLI used for generating code and running tasks.

Connect the workspace to the free tier of the distributed cache provided by Nx Cloud.

library

The library name used to import it, like `@myorg/my-awesome-lib`.

Generate JavaScript files rather than TypeScript files.

Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.

Do not generate `.babelrc` file. Useful for Node libraries that are not compiled by Babel.

Do not update `tsconfig.json` for development experience.

Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.

Whether to enable `tsconfig` strict mode or not.

The test environment to use if `unitTestRunner` is set to `jest`.

Create a TypeScript Library

workspace-generator

Create a custom generator

Generates a target to run any command in the terminal.

Create a custom target to run any command.

Add the `printhello` target to `my-feature-lib`

Current working directory of the command.

Env files to be loaded before executing the commands.

Create a custom target to run any command

Moves a project's configuration outside of `workspace.json`.

convert-to-nx-project

Convert the `my-feature-lib` project to use `project.json` file instead of `workspace.json`

Convert all projects in `workspace.json` to separate `project.json` files

@nrwl/workspace:run-commands

Usage

Examples

Options

command

cwd

envFile

name

outputs

project