The Linter plugin for Nx contains executors, generators and utilities used for linting JavaScript/TypeScript projects within an Nx workspace.

The Linter plugin contains executors, generator, plugin and utilities used for linting JavaScript/TypeScript projects within an Nx workspace.

## Setting Up Linter

### Installation

In any Nx workspace, you can install `@nrwl/linter` by running the following commands if `@nrwl/linter` package is not installed:

```bash
npm i --save-dev @nrwl/linter
```

```bash
yarn add --dev @nrwl/linter
```

## Lint

You can lint an application or a library with the following command:

```bash
nx lint my-app
```

```bash
nx lint my-lib
```

## Utils

- [convert-tslint-to-eslint](/packages/angular/generators/convert-tslint-to-eslint) - Converts a project linter from [TSLint](https://palantir.github.io/tslint/) to [ESLint](https://eslint.org/)


Overview

![ESLint logo](/shared/eslint-logo.png)

A plugin containing a collection of recommended ESLint rule configurations wrapped as ESLint plugins and an Nx specific [enforce-module-boundaries](#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:

```bash
npm i --save-dev @nrwl/eslint-plugin-nx
```

```bash
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:

```json
{
  // ... more ESLint config here
  "overrides": [
    {
      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
      "rules": {
        "@nrwl/nx/enforce-module-boundaries": [
          "error",
          {
            // ...rule specific configuration
          }
        ]
      }
    }
    // ... more ESLint overrides here
  ]
}
```

Read more about proper usage of this rule:

- [Enforce Project Boundaries](/core-features/enforce-project-boundaries)
- [Ban Dependencies with Certain Tags](/recipe/ban-dependencies-with-tags)
- [Tag in Multiple Dimensions](/recipe/tag-multiple-dimensions)
- [Ban External Imports](/recipe/ban-external-imports)
- [Tags Allow List](/recipe/tags-allow-list)
- [Taming Code Organization with Module Boundaries in Nx](https://blog.nrwl.io/mastering-the-project-boundaries-in-nx-f095852f5bf4)


eslint-plugin-nx

**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in `v10.3.0`.

lint

Fixes linting errors (may overwrite linted files).

Succeeds even if there was linting errors.

ESLint Output formatter (https://eslint.org/docs/user-guide/formatters).

Number of warnings to trigger nonzero exit code - default: `-1`.

The name of the TypeScript configuration file.

Lint Target

eslint

Strategy to use for detecting changed files in the cache.

The name of the ESLint configuration file.

When set to `true`, the linter will invalidate its cache when any of its dependencies changes.

One or more files/dirs/globs to pass directly to ESLint's `lintFiles()` method.

The equivalent of the `--no-eslintrc` flag on the ESLint CLI, it is `false` by default.

The equivalent of the `--report-unused-disable-directives` flag on the ESLint CLI.

The equivalent of the `--resolve-plugins-relative-to` flag on the ESLint CLI.

The equivalent of the `--rulesdir` flag on the ESLint CLI.

ESLint Lint Target

workspace-rules-project

Create the Workspace Lint Rules Project

workspace-rule

Create a new workspace lint rule called my-custom-rule

Create a new workspace lint rule located at `tools/eslint-rules/a/b/c/my-custom-rule.ts`

Create the rule under this directory within `tools/eslint-rules/` (can be nested).

@nrwl/linter:workspace-rules-project

Usage

Examples

Options