ionic-team/eslint-plugin

ESLint plugin for Ionic with recommended configurations

🚨 DEPRECATED 🚨

Ionic, Capacitor, and Stencil projects are now using the following Pretter + ESLint configs:

• https://github.com/ionic-team/prettier-config
• https://github.com/ionic-team/eslint-config

@ionic/eslint-plugin

Common ESLint rules & preferences for Ionic.

Usage

Install

npm i -D eslint @ionic/eslint-plugin

Configure

Create .eslintrc.js, or otherwise configure ESLint to use the Ionic ESLint Plugin.

• You must manually configure env to setup your ESLint environment.
• You must manually configure parserOptions to point to your tsconfig.json and configure any additional options.

module.exports = {
  env: {
    browser: true,
    node: true,
    es6: true,
  },
  parserOptions: {
    project: './tsconfig.json',
    ecmaFeatures: {
      jsx: true,
    },
  },
  plugins: ['@ionic'],
  extends: ['plugin:@ionic/recommended'], // or use `plugin:@ionic/strict`
  rules: {
    // additional rule configuration
  }
};

Flavors

• plugin:@ionic/crucial: Builds on top of @typescript-eslint/recommended and eslint:recommended.
• plugin:@ionic/recommended: Recommended set of rules.
• plugin:@ionic/strict: Stricter set of rules for very consistent code. Good for new projects.

eslint-plugin's Issues

Won't work with vscode + prettier

Error while loading rule '@typescript-eslint/no-unnecessary-type-assertion '/src/app/app.component.ts:: You have used a rule which requires parserServices to be generated. You must therefore provide a value for the "parserOptions.project" property for @typescript-eslint/parser.
Occurred while linting /src/app/app.component.ts

Replace no-shadow with typescript no-shadow rule

According to this doc: https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-shadow.md