@blitz/eslint-plugin

@blitz/eslint-plugin

An ESLint plugin to enforce a consistent code styles across StackBlitz projects

Installation

You'll first need to install ESLint:

$ yarn add -D eslint

Next, install @blitz/eslint-plugin:

$ yarn add -D @blitz/eslint-plugin

Note: If you installed ESLint globally (using the -g flag) then you must also install @blitz/eslint-plugin globally.

Usage

Add @blitz/eslint-plugin to the extends section of your .eslintrc.js or .eslintrc.json configuration file and and configure parser and parserOptions. For the plugin, you can omit the eslint-plugin-:

{
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "ecmaVersion": 2019,
    "sourceType": "module",
    "ecmaFeatures": {
      "modules": true
    }
  },
  "extends": ["plugin:@blitz/recommended"]
}

Custom Rules

• @blitz/block-scope-case - Ensures all case statements are block scoped
• @blitz/newline-before-return - Require an empty line before 'return' statements