Unified eslint plugin for all @thebahaifaith projects.

This package is openly published in the npm registry. Be cautions when making changes.

Plugin Installation

1. Install ESLint

$ pnpm add --save-dev eslint @typescript-eslint/eslint-plugin @typescript-eslint/parser

1.5 If using React, install eslint-plugin-react

$ pnpm add --save-dev eslint-plugin-react

2. Install @thebahaifaith/eslint-plugin

$ pnpm add --save-dev @thebahaifaith/eslint-plugin

Usage

Add @thebahaifaith/eslint-plugin to the plugins section of your .eslintrc configuration file.

{
  "plugins": ["@thebahaifaith/eslint-plugin"]
}

Recommended Configuration

{
    "root": true,
    "parserOptions": {
        "project": ["tsconfig.json"]
    },
    "plugins": ["@thebahaifaith/eslint-plugin"],
    "extends": ["plugin:@thebahaifaith/eslint-plugin/recommended"]
}

Recommended Configuration (React)

{
    "root": true,
    "parserOptions": {
        "project": ["tsconfig.json"]
    },
    "plugins": ["@thebahaifaith/eslint-plugin"],
    "extends": ["plugin:@thebahaifaith/eslint-plugin/react-recommended"]
}

Note: react-recommended already extends recommended so there is no need to include both.