kristianmandrup / nx-publish-package

Nx publish package

Publish an Nx package to npm from the builder target folder of your project.

Installation

Install your plugin like any other npm package:

npm i -D @nx-publish-package or yarn add -D @nx-publish-package.

Run executor

To publish a project (that has been built) to npm

nx run myapp:publish

By default it will use the outputPath of the project.json for the project, here dist/myapp

{
  "tags": [],
  "implicitDependencies": [],
  "targets": {
    "build": {
      "executor": "@nrwl/node:build",
      "outputs": ["{options.outputPath}"],
      "options": {
        "outputPath": "dist/myapp",
        "main": "apps/myapp/src/main.ts",
        "tsConfig": "apps/myapp/tsconfig.app.json"
      }
    }
  }
}

If no build target outputPath is set, it will default to dist/${projectName}. You can override this automatic build target determination by supplying a --dist option if necessary.

nx run myapp:publish --dist my/dist/myapp

Plugin

This library was generated with Nx.

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 @nx-publish-package --ver=1.0.0 which automatically builds @nx-publish-package

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. 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

Building

Run nx build publish to build the library.

Running unit tests

Run nx test publish to execute the unit tests via Jest.