8fa7065cf1
This PR updates examples in `.md` files (both docs and blog posts) to use positional args. Nx 20 changes the position arg to be either `directory` for apps/libs or `path` for artifacts (e.g. components). So before you'd do this: ``` nx g app myapp --directory=apps/myapp nx g lib mylib --directory=libs/mylib nx g lib mylib --directory=libs/nested/mylib nx g lib @acme/foo --directory=libs/@acme/foo --importPath=@acme/foo nx g component foo --directory=libs/ui/src/foo --pascalCaseFiles ``` Will now be simplified to ``` nx g app apps/myapp nx g lib libs/mylib nx g lib libs/nested/mylib nx g lib libs/@acme/foo # name and import path are both "@acme/foo" nx g component libs/ui/src/foo/Foo ``` For cases where `name` and `importPath` need to be changed, you can always manually specify them. ``` nx g lib libs/nested/foo # name is foo nx g lib libs/nested/foo --name=nested-foo # specify name with prefix nx g lib libs/@acme/foo --name # use "foo" as name and don't match importPath nx g lib libs/@internal/foo --importPath=@acme/foo # different importPath from name <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior <!-- This is the behavior we have today --> ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #
2.9 KiB
The Node Plugin contains generators and executors to manage Node applications within an Nx workspace. It provides:
Setting Up @nx/node
Installation
{% callout type="note" title="Keep Nx Package Versions In Sync" %}
Make sure to install the @nx/node version that matches the version of nx in your repository. If the version numbers get out of sync, you can encounter some difficult to debug errors. You can fix Nx version mismatches with this recipe.
{% /callout %}
In any Nx workspace, you can install @nx/node by running the following command:
{% tabs %} {% tab label="Nx 18+" %}
nx add @nx/node
This will install the correct version of @nx/node.
{% /tab %} {% tab label="Nx < 18" %}
Install the @nx/node package with your package manager.
npm add -D @nx/node
{% /tab %} {% /tabs %}
Using the @nx/node Plugin
Creating Applications
You can add a new application with the following:
nx g @nx/node:application apps/my-new-app
You can run your application with nx serve my-new-app, which starts it in watch mode.
Creating Libraries
Node libraries are a good way to separate features within your organization. To create a Node library run the following command:
nx g @nx/node:lib libs/my-new-lib
# If you want the library to be buildable or publishable to npm
nx g @nx/node:lib libs/my-new-lib --buildable
nx g @nx/node:lib libs/my-new-lib \
--publishable \
--importPath=@myorg/my-new-lib
Using Node
Testing Projects
You can run unit tests with:
nx test my-new-app
nx test my-new-lib
Replace my-new-app with the name or your project. This command works for both applications and libraries.
Building Projects
Node applications can be build with:
nx build my-new-app
And if you generated a library with --buildable, then you can build a library as well:
nx build my-new-lib
The output is in the dist folder. You can customize the output folder by setting outputPath in the project's project.json file.
Application Proxies
Generating Node applications has an option to configure other projects in the workspace to proxy API requests. This can be done by passing the --frontendProject with the project name you wish to enable proxy support for.
nx g @nx/node:application apps/my-new-app \
--frontendProject my-react-app
Debugging
Debugging is set to use a random port that is available on the system. The port can be changed by setting the port option in the serve target in the project.json. Or by running the serve command with --port <number>.
For additional information on how to debug Node applications, see the Node.js debugging getting started guide.