@nrwl/eslint-plugin-nx

What is @nrwl/eslint-plugin-nx?

The @nrwl/eslint-plugin-nx package provides a set of ESLint rules and configurations specifically designed for Nx workspaces. Nx is a suite of powerful, extensible dev tools to help you architect, test, and build at any scale — integrating seamlessly with modern technologies and libraries while providing a robust CLI, caching, dependency management, and more. This ESLint plugin helps enforce best practices and consistent code standards within an Nx workspace.

What are @nrwl/eslint-plugin-nx's main functionalities?

Enforce Module Boundaries

This rule helps to maintain module boundaries by restricting imports between libraries in an Nx workspace. It can enforce that libraries can only depend on other libraries that are tagged to be dependencies, preventing circular dependencies and ensuring a proper project structure.

{
  "rules": {
    "@nrwl/nx/enforce-module-boundaries": [
      "error",
      {
        "enforceBuildableLibDependency": true,
        "allow": [],
        "depConstraints": [
          { "sourceTag": "*", "onlyDependOnLibsWithTags": ["*"] }
        ]
      }
    ]
  }
}

Ban Project Import

This rule prevents importing from specific projects within the workspace. It's useful for large workspaces where you want to enforce strict boundaries between projects, such as not allowing imports from a specific library or application.

{
  "rules": {
    "@nrwl/nx/ban-project-import": [
      "error",
      {
        "allow": ["my-app/**"]
      }
    ]
  }
}

Other packages similar to @nrwl/eslint-plugin-nx

eslint-plugin-import

This package provides a set of rules that help validate proper imports. It includes features like ensuring imports point to a file/module that can be resolved, or ensuring named imports correspond to a named export in the remote file. While it offers similar functionality to @nrwl/eslint-plugin-nx, it is not specific to Nx workspaces and does not have rules tailored to the specific structure and best practices of an Nx workspace.

eslint-plugin-module-resolver

This plugin integrates with eslint-plugin-import to help resolve imports using custom module resolution strategies. It's useful for projects that have custom aliases or directory structures. However, unlike @nrwl/eslint-plugin-nx, it does not provide rules specific to Nx workspaces and their architectural best practices.

README

---

What is Nx?

🔎 Extensible Dev Tools for Monorepos.

Nx Helps You

Use Modern Tools

Using Nx, you can add TypeScript, Cypress, Jest, Prettier, Angular, React, Next.js and Nest into your dev workflow. Nx sets up these tools and allows you to use them seamlessly. Nx fully integrates with the other modern tools you already use and love.

Build Full-Stack Applications

With Nx, you can build full-stack applications using modern frameworks. You can share code between the frontend and the backend. And you can use the same build/test/serve commands throughout the whole dev experience.

Develop like Google, Facebook, and Microsoft

With Nx, you can develop multiple full-stack applications holistically and share code between them all in the same workspace. Nx provides advanced tools which help you scale your enterprise development. Nx also helps enforce your organization’s standards and community best practices.

Getting Started

Creating an Nx Workspace

Using npx

npx create-nx-workspace myworkspace

Using npm init

npm init nx-workspace myworkspace

Using yarn create

yarn create nx-workspace myworkspace

If it's your first Nx project, the command will recommend you to install @nrwl/cli globally, so you can invoke nx directly without going through yarn or npm.

Creating First Application

By default, an Nx workspace starts blank. There are no applications to build, serve, and test. To create one, you need to add capabilities to the workspace.

To add a web components app, run:

yarn add --dev @nrwl/web
nx g @nrwl/web:app myapp # or just "nx g myapp"

npm install --save-dev @nrwl/web
nx g @nrwl/web:app myapp # or just "nx g myapp"

To add an Angular app, run:

yarn add --dev @nrwl/angular
nx g @nrwl/angular:app myapp # or just "nx g myapp"

npm install --save-dev @nrwl/angular
nx g @nrwl/angular:app myapp # or just "nx g myapp"

To add a React app, run:

yarn add --dev @nrwl/react
nx g @nrwl/react:app myapp # or just "nx g myapp"

npm install --save-dev @nrwl/react
nx g @nrwl/react:app myapp # or just "nx g myapp"

If nx g fails, use: yarn nx g @nrwl/web:app myapp or npm run nx -- g @nrwl/web:app myapp.

Regardless of what framework you chose, the resulting file tree will look like this:

<workspace name>/
├── apps/
│   ├── myapp/
│   └── myapp-e2e/
├── libs/
├── tools/
├── nx.json
├── package.json
├── tsconfig.json
└── tslint.json

Serving Application

• Run nx serve myapp to serve the newly generated application!
• Run nx test myapp to test it.
• Run nx e2e myapp-e2e to run e2e tests for it.

Angular users can also run ng g/serve/test/e2e.

You are good to go!

Documentation

• Nx Documentation and Guides
• Nx blog posts

Quick Start Videos

Angular

React

Free Course

Create a free account on the Connect Platform and enjoy a complete Nx course on us!

Books

• Effective React Development with Nx
• Angular Enterprise Monorepo Patterns

Videos

• Building Angular full-stack applications in a monorepo.
• Building React full-stack applications in a monorepo.
• Video course on using Nx Workspaces

Talks

• Angular at Large Organizations
• Nx: The New Way to Build Enterprise Angular Apps
• Supercharging the Angular CLI
• Hands on Full Stack development with Nx and Bazel

Misc

• nx-examples repo has branches for different nx comments to display expected behavior and example app and libraries. Check out the branch (workspace, ngrx...) to see what gets created for you. More info on readme.
• xplat - Cross-platform tools for Nx workspaces

Want to help?

If you want to file a bug or submit a PR, read up on our guidelines for contributing.

Core Team

Victor Savkin	Jason Jean	Benjamin Cabanes	Brandon Roberts	Wes Grimes
vsavkin	FrozenPandaz	bcabanes	brandonroberts	wesleygrimes