@ionic/eslint-plugindeprecated

ESLint plugin for Ionic with recommended configurations.

Usage no npm install needed!

<script type="module">
  import ionicEslintPlugin from 'https://cdn.skypack.dev/@ionic/eslint-plugin';
</script>

README

@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.