@fabernovel/pes-nx-plugin-workspace

Fabernovel's plugin for generating your Nx workspace

Usage

:bulb: No need to clone the repo, this plugin in deployed on npm !

pnpm dlx [email protected] --preset=@fabernovel/pes-nx-plugin-workspace --nxCloud=false --skipGit=true

:warning: You cannot create a new workspace inside PES repo (if you cloned it to contribute for example)

See Nx documentation for other options.

What does it do ?

The previous command will

• setup Fabernovel's workspace layout (See Guidelines and Limitations)
• initialize git repository, and perform the first commit
• setup Pre-commit formatting

Shared library

Here, we refer to a shared library as a library shared between multiple applications. If you want to create a library shared between the libraries of the same application see the nx-plugin-next or nx-plugin-nest readme's.

In order to generate a shared library, run the following command:

pnpm exec nx g @fabernovel/pes-nx-plugin-workspace:shared <name> [options]

| Arguments | Description | | --------- | ---------------------------------------------------------------------- | | <name> | The shared library name (will be requested by the cli if not provided) |

| Options | Default | Description | Required | | ------------- | ------------------ | --------------------------------------------------------------------- | -------- | | --directory | "/shared/<name>" | Library path (string) after /libs | | | --tags | | Tags (string separated by commas). For example: --tags="auth, user" | |

Next step

Now that your workspace is set up, you can add apps to your project! Refer to PES documentation to see all available application generators.