@rxlint/eslint-plugin v1.3.8

@rxlint/eslint-plugin

This package is a fork of the package cartant/eslint-plugin-rxjs with trimmed and updated dependencies to work with both eslint 8 and 9. Angular-specific rules are in @rxlint/eslint-plugin-angular.

Some rules are opinionated and not included in the recommended configuration. Developers can enable them as needed. Most rules require the TypeScript parser for ESLint but there is a config provided to disable those.

Installation

Install the required packages:

npm install --save-dev eslint typescript @typescript-eslint/parser @rxlint/eslint-plugin
# or
yarn add --dev eslint typescript @typescript-eslint/parser @rxlint/eslint-plugin

Configuration

This plugin works with ESLint v8 (eslintrc) and v9 (eslint.config.js) configuration formats.

ESLint v8 Configuration

Add @rxlint/recommended to your extends array:

.eslintrc.js

module.exports = {
  files: ["**/*.ts"],
  extends: [
    "eslint:recommended",
    "plugin:@typescript-eslint/recommended-type-checked",
    "plugin:@typescript-eslint/stylistic-type-checked",
    "plugin:@rxlint/recommended",
  ],
  parser: "@typescript-eslint/parser",
  parserOptions: {
    ecmaVersion: "latest",
    project: true,
    sourceType: "module",
  },
  rules: {
    "@rxlint/no-async-subscribe": "error",
    "@rxlint/no-ignored-observable": "error",
    "@rxlint/no-ignored-subscription": "error",
    "@rxlint/no-nested-subscribe": "error",
    "@rxlint/no-unbound-methods": "error",
    "@rxlint/throw-error": "error",
  },
};

ESLint v9 Configuration

Import the plugin and add it to the extends array:

eslint.config.js

const rxjs = require("@rxlint/eslint-plugin");

module.exports = [
  {
    files: ["**/*.ts"],
    extends: [
      eslint.configs.recommended,
      tseslint.configs.recommendedTypeChecked,
      tseslint.configs.stylisticTypeChecked,
      rxjs.configs.recommendedTypeChecked,
    ],
  },
];

Disable Type-Aware Linting

Use the disable-type-checked config to turn off type-aware linting for specific file subsets.

ESLint v8

Add @rxlint/disable-type-checked-classic to your extends array:

.eslintrc.js

module.exports = {
  files: ['**/*.{config,test,spec}.{js,ts}'],
  extends: [
    "plugin:@typescript-eslint/disable-type-checked",
    "plugin:@rxlint/disable-type-checked",
  ],
};

ESLint v9

Import the plugin and add rxjs.config.disableTypeChecked to the extends array:

eslint.config.js

module.exports = {
  files: ['**/*.{config,test,spec}.{js,ts}'],
  extends: [
    tseslint.configs.disableTypeChecked,
    rxjs.config.disableTypeChecked,
  ],
};

Rules

The package includes the following rules.

Rules marked with ✅ are recommended and rules marked with 🔧 have fixers.