Maintain a Published Plugins

To create a plugin, see the create a local plugin tutorial.

Publish 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:

nx publish my-plugin --ver=1.0.0 which automatically builds my-plugin
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.

List your Nx Plugin

Nx provides a utility (nx list) that lists both core and community plugins. You can submit your plugin to be added to this list, but it needs to meet a few criteria first:

Run some kind of automated e2e tests in your repository
Include @nx/devkit as a dependency in the plugin's package.json
List a repository.url in the plugin's package.json

package.json
{
  "repository": {
    "type": "git",
    "url": "https://github.com/nrwl/nx.git",
    "directory": "packages/web"
  }
}

Unmaintained Plugins

We reserve the right to remove unmaintained plugins from the registry. If the plugins become maintained again, they can be resubmitted to the registry.

Once those criteria are met, you can submit your plugin by following 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!

Write Migrations

Once other repos are using your plugin, it would help them if you write migrations to automatically update their configuration files whenever you make breaking changes. Read the migration generators guide to find out how.