Skip to content

codeware-sthlm/nx-plugins

Repository files navigation


    codeware sthlm logo

Nx Plugins

A collection of Nx plugins powered by Codeware Sthlm.

Test state     MIT

Plugins

Add support for Payload in your existing Nx workspace.

Quickly create a new Nx workspace with a Payload application, using the plugin as a preset.

Quickstart Overview

Create a new workspace with a Payload application

npx create-nx-payload

or

npx create-nx-workspace --preset @cdwr/nx-payload

Add Payload plugin to an existing workspace

npm add -D @cdwr/nx-payload

Generate a Payload application

npx nx generate @cdwr/nx-payload:app

What about yarn and pnpm?

Nx has great support for package managers. You can get started with the package manager you love the most. For example

yarn create nx-payload
pnpm create nx-payload

or

npx create-nx-workspace --pm yarn
npx create-nx-workspace --pm pnpm

Read more about Nx installation

Development

Installing Nx globally has advantages and lets you focus on runing Nx commands, without worring about your current package manager.

Run targets for all packages

nx run-many -t build lint test e2e

or shorter

nx run-many

Run a target for a specific package

nx run [package]:[target] [options]

or use the shorter infix notation

nx [target] [package] [options]

Publish and test a local Npm package

Packages can be published locally to a Verdaccio registry, to be able to run manual smoke tests complementing the automated tests.

Start Verdaccio and configure package managers for a local setup.

nx local-registry

The process will keep running in the current terminal.

Quit the process to shutdown Verdaccio when needed, which will also restore the initial package manager setup

In another terminal build an publish all plugins to local Verdaccio registry.

nx local-registry:publish

Open http://localhost:4873/ to view the packages.

It's now possible to test a plugin in a local scope.

For example

npx create-nx-payload@local