@brionmario/eslint-plugin

ESLint plugin containing configurations & custom rules used in Brion Mario's code bases.

Installation

You'll first need to install ESLint:

With npm

npm i eslint --save-dev

With pnpm

pnpm add --save-dev eslint

With Yarn

yard add --dev eslint

Next, install @brionmario/eslint-plugin:

With npm

npm i @brionmario/eslint-plugin --save-dev

With pnpm

pnpm add --save-dev @brionmario/eslint-plugin

With Yarn

yard add --dev @brionmario/eslint-plugin

Usage

For JavaScript projects

If you're working on any es5 or es6 projects, do the following extension in your eslint config.

{
  "extends": "plugin:@brionmario/javascript"
}

For TypeScript projects

If you're working on a TypeScript based project, do the following extension in your eslint config.

{
  "extends": "plugin:@brionmario/typescript"
}

Stricter Rules

If you want to enforce more stricter rules like mandating types for variables, mandating return types etc, do the following extension in your eslint config.

{
  "extends": [
    "plugin:@brionmario/typescript"
+   "plugin:@brionmario/strict"
  ]
}

For React projects

If you're working on a React project, do the following extension in your eslint config.

React JavaScript

{
  "extends": [
    "plugin:@brionmario/javascript"
    "plugin:@brionmario/react",
  ]
}

React TypeScript

{
  "extends": [
    "plugin:@brionmario/typescript"
    "plugin:@brionmario/react",
  ]
}

For Next.js

If you're working on a Next.js project, do the following extension in your eslint config.

{
  "extends": [
    "plugin:@brionmario/typescript"
+   "plugin:@brionmario/next",
  ]
}

Jest & React Testing Library.

If you're working on project that uses Jest & React Testing Library for unit testing, do the following extension in your eslint config.

{
  "extends": [
    ...,
+   "plugin:@brionmario/jest",
  ]
}

Prettier

If you want to integrate the prettier ESLint in to your project, do the following extension in your eslint config.

{
  "extends": [
    ...,
+   "plugin:@brionmario/prettier",
  ]
}

For Brion's Projects

For Brion's own projects, the following extension is used to enforce specific standards such as file license headers, etc.

{
  "extends": [
    ...,
+   "plugin:@brionmario/internal",
  ]
}

JSON

If you want to JSON sort your package.json file and other JSON files, do the following extension in your eslint config.

{
  "extends": [
    ...,
+   "plugin:@brionmario/json",
  ]
}