@nrwl/nx-plugin

Nx plugins are npm packages that contain generators and executors to extend a Nx workspace. Generators are blueprints to create new files from templates, and executors run those files. These plugins also update the nx.json when generating new libs or apps.

A list of plugins that is maintained by Nrwl is found in the Nrwl/nx repo.
A list of custom plugins created by the community is found in the Community section. Plugins are written using Nx Devkit. Read Nx Devkit for more information.

For a detailed video explaining the things covered here and more, check out Creating and Publishing Your Own Nx Plugin.

Generating a Plugin

To get started with building a Nx Plugin, run the following command:

npx create-nx-plugin my-org --pluginName my-plugin

This command creates a brand-new workspace, and sets up a pre-configured plugin with the specified name.

Note, the command above will create a plugin the package name set to @my-org/my-plugin. You can pass --importPath to provide a different package name.

If you do not want to create a new workspace, install the @nrwl/nx-plugin dependency in an already existing workspace with npm or yarn. Then run nx g @nrwl/nx-plugin:plugin [pluginName].

A new plugin is created with a default generator, executor, and e2e app.

Generator

The created generator contains boilerplate that will do the following:

Normalize a schema (the options that the generator accepts)
Update the project.json
Add the plugin's project to the nx.json file
Add files to the disk using templates

There will be an exported default function that will be the main entry for the generator.

Generator options

The schema.d.ts file contains all the options that the generator supports. By default, it includes directory, tags, and name as the options. If more options need to be added, please update this file and the schema.json file.

More details

The schema.d.ts file is used for type checking inside the implementation file. It should match the properties in schema.json.

Adding more generators

To add more generators to the plugin, run the following command: nx generate @nrwl/nx-plugin:generator [generatorName] --project=[pluginName].

This will scaffold out a new generator and update the necessary files to support it.

Generator Testing

The generator spec file includes boilerplate to help get started with testing. This includes setting up an empty workspace.

These tests should ensure that files within the tree (created with createTreeWithEmptyWorkspace) are in the correct place, and contain the right content.

Full E2Es are supported (and recommended) and will run everything on the file system like a user would.

Executor

The default executor is set up to just emit a console log. Some examples of what an executor can do are:

Support different languages, (Java, Go, Python, C#)
Compile new UI framework components
Deploy an app on a CDN
Publish to NPM
and many more!

Adding more executors

To add more executors to the plugin, run the following command: nx generate @nrwl/nx-plugin:executor [executor] --project=[pluginName].

This will scaffold out a new generator and update the necessary files to support it.

Executor testing

The executor spec file contains boilerplate to run the default exported function from the executor.

These tests should make sure that the executor is executing and calling the functions that it relies on.

Full E2Es are supported (and recommended) and will run everything on the file system like a user would.

Testing your plugin

One of the biggest benefits that the Nx Plugin package provides is support for E2E and unit testing.

When the E2E app runs, a temporary E2E directory is created in the root of the workspace. This directory is a blank Nx workspace, and will have the plugin's built package installed locally.

E2E Testing file

When the plugin is generated, a test file is created in the my-plugin-e2e app. Inside this test file, there are already tests for making sure that the executor ran, checking if directories are created with the --directory option, and checking if tags are added to the project configuration.

We'll go over a few parts of a test file below:

it('should create my-plugin', async (done) => {
  const plugin = uniq('my-plugin');
  ensureNxProject('@my-org/my-plugin', 'dist/packages/my-plugin');
  await runNxCommandAsync(`generate @my-org/my-plugin:myPlugin ${plugin}`);

  const result = await runNxCommandAsync(`build ${plugin}`);
  expect(result.stdout).toContain('Executor ran');

  done();
});

The uniq function creates a random name with the prefix and a random number.
The ensureNxProject is the function that will create the temporary directory. It takes two arguments, the plugin package name and the dist directory of when it's built.
The runNxCommandAsync will execute a nx command in the E2E directory.

There are additional functions that the @nrwl/nx-plugin/testing package exports. Most of them are file utilities to manipulate and read files in the E2E directory.

Including Assets

Sometimes you might want to include some assets with the plugin. This might be a image or some additional binaries.

To make sure that assets are copied to the dist folder, open the plugin's project.json file. Inside the build property, add additional assets. By default, all .md files in the root, all non-ts files in folders, and the generators.json and executors.json files are included.

project.json
"build": {
  "executor": "@nrwl/node:package",
  "options": {
    // shortened...
    "assets": [
      "packages/my-plugin/*.md",
      {
        "input": "./packages/my-plugin/src",
        "glob": "**/*.!(ts)",
        "output": "./src"
      },
      {
        "input": "./packages/my-plugin",
        "glob": "generators.json",
        "output": "."
      },
      {
        "input": "./packages/my-plugin",
        "glob": "executors.json",
        "output": "."
      }
    ]
  }
}

Using your Nx Plugin

To use your plugin, simply list it in nx.json or use its generators and executors as you would for any other plugin. This could look like nx g @my-org/my-plugin:lib for generators or "executor": "@my-org/my-plugin:build" for executors. It should be usable in all of the same ways as published plugins in your local workspace immediately after generating it. This includes setting it up as the default collection in nx.json, which would allow you to run nx g lib and hit your plugin's generator.

Publishing your Nx Plugin

In order to use your plugin in other workspaces or share it with the community, you will need to publish it to an npm registry. To publish your plugin follow these steps:

Build your plugin with the command nx run my-plugin:build
npm publish ./dist/package/my-plugin and follow the prompts from npm.
That's it!

Version bump

Currently you will have to modify the package.json version by yourself or with a tool.

After that, you can then install your plugin like any other npm package, npm i -D @my-org/my-plugin or yarn add -D @my-org/my-plugin.

Listing your Nx Plugin

Nx provides a utility (nx list) that lists both core and community plugins. To submit your plugin, please follow the steps below:

Fork the Nx repo (if you haven't already)
Update the community/approved-plugins.json file with a new entry for your plugin that includes name, url and description
Use the following commit message template: chore(core): nx plugin submission [PLUGIN_NAME]
push your changes, and run yarn submit-plugin

The yarn submit-plugin command automatically opens the Github pull request process with the correct template.

We will then verify the plugin, offer suggestions or merge the pull request!

Preset

A Preset is a customization option which you provide when creating a new workspace. TS, Node, React are some internal presets that Nx provides by default.

Custom Preset

At its core a preset is a generator, which we can create inside of a plugin. If you don't have an existing plugin you can create one by running

  npx create-nx-plugin my-org --pluginName my-plugin

To create our preset inside of our plugin we can run

  nx generate @nrwl/nx-plugin:generator --name=preset --project=happynrwl

Double check

The word preset is required for the name of this generator

You should have a similar structure to this:

happynrwl/
	├── e2e
	├── jest.config.js
	├── jest.preset.js
	├── nx.json
	├── package-lock.json
	├── package.json
	├── packages
	│   └── happynrwl
	│       ├── src
	│       │   ├── executors
	│       │   ├── generators
	│       │   │   ├── happynrwl
	│       │   │   └── preset 		// <------------- Here
	│       │   └── index.ts
	├── tools
	└── tsconfig.base.json

After the command is finished, the preset generator is created under the folder named preset. The generator.ts provides an entry point to the generator. This file contains a function that is called to perform manipulations on a tree that represents the file system. The schema.json provides a description of the generator, available options, validation information, and default values.

Here is the sample generator function which you can customize to meet your needs.

export default async function (tree: Tree, options: PresetGeneratorSchema) {
  const normalizedOptions = normalizeOptions(tree, options);
  addProjectConfiguration(tree, normalizedOptions.projectName, {
    root: normalizedOptions.projectRoot,
    projectType: 'application',
    sourceRoot: `${normalizedOptions.projectRoot}/src`,
    targets: {
      exec: {
        executor: 'nx:run-commands',
        options: {
          command: `node ${projectRoot}/src/index.js`,
        },
      },
    },
    tags: normalizedOptions.parsedTags,
  });
  addFiles(tree, normalizedOptions);
  await formatFiles(tree);
}

To get an in-depth guide on customizing/running or debugging your generator see local generators.

Usage

Before you are able to use your newly created preset you must package and publish it to a registry.

After you have published your plugin to a registry you can now use your preset when creating a new workspace

npx create-nx-workspace my-workspace --preset=my-plugin-name