A plugin containing a collection of recommended ESLint rule configurations wrapped as ESLint plugins and an Nx specific enforce-module-boundaries rule.
Setting Up ESLint Plugin
Installation
In any Nx workspace, you can install @nrwl/eslint-plugin-nx by running the following commands if the package is not already installed:
npm i --save-dev @nrwl/eslint-plugin-nx
yarn add --dev @nrwl/eslint-plugin-nx
ESLint plugins
The plugin contains the following rule configurations divided into sub-plugins.
JavaScript
The @nrwl/nx/javascript ESLint plugin contains best practices when using JavaScript.
TypeScript
The @nrwl/nx/typescript ESLint plugin contains best practices when using TypeSript.
Angular
Contains configurations matching best practices when using Angular framework:
- @nrwl/nx/angular
- @nrwl/nx/angular-template
React
Contains configurations matching best practices when using React framework:
- @nrwl/nx/react-base
- @nrwl/nx/react-jsx
- @nrwl/nx/react-typescript
You can also use @nrwl/nx/react which includes all three @nrwl/nx/react-* plugins
enforce-module-boundaries
The @nrwl/nx/enforce-module-boundaries ESLint rule enables you to define strict rules for accessing resources between different projects in the repository. By enforcing strict boundaries it helps keep prevent unplanned cross-dependencies.
Usage
You can use enforce-module-boundaries rule by adding it to your ESLint rules configuration:
1{
2 // ... more ESLint config here
3 "overrides": [
4 {
5 "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
6 "rules": {
7 "@nrwl/nx/enforce-module-boundaries": [
8 "error",
9 {
10 // ...rule specific configuration
11 }
12 ]
13 }
14 }
15 // ... more ESLint overrides here
16 ]
17}
18Read more about proper usage of this rule: