Skip to content

Latest commit

 

History

History
187 lines (126 loc) · 5.64 KB

README.md

File metadata and controls

187 lines (126 loc) · 5.64 KB
Raw

@stencil-community/eslint-plugin

ESLint rules specific to Stencil JS projects.

Installation

If you're using npm v7+, you only need to install this package. Its peer dependencies will be automatically installed.

npm i --save-dev @stencil-community/eslint-plugin

If you're using npm v6 or lower, you will need to install this package and its peer dependencies in your stencil project:

npm i --save-dev eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-react @stencil-community/eslint-plugin typescript

Usage

.eslintrc.json configuration file:

{
  "parserOptions": {
    "project": "./tsconfig.json"
  },
  "extends": [
    "plugin:@stencil-community/recommended"
  ]
}

Add a new lint script to the package.json:

{
  "scripts": {
    "lint": "eslint src/**/*{.ts,.tsx}"
  }
}

By default, ESLint will ignore your node_modules/ directory. Consider adding a .eslintignore file at the root of your project with any output target directories to avoid false positive errors from ESLint.

# place any directories created by the Stencil compilation process here
dist
loader
www

Lint all your project:

npm run lint

Supported Rules

This rule catches Stencil public methods that are not async.

This rule catches Stencil Props with a default value of true.

This rule catches Stencil Component banned tag name prefix.

This rule catches Stencil Component class name not matching configurable pattern.

This rule catches Stencil decorators in bad locations.

This rule catches Stencil decorators style usage.

This rule catches Stencil Element decorator have the correct type.

This rule catches Stencil method hostData.

This rule catches Stencil Methods marked as private or protected.

This rule catches Stencil Watchs with non existing Props or States.

This rule catches own class methods marked as public.

This rule catches own class properties marked as public.

This rule catches Stencil Listen with vdom events.

This rule catches Stencil Props marked as private or protected.

This rule catches Stencil Props marked as non readonly, excluding mutable ones.

This rule catches Stencil Render returning array instead of Host tag.

This rule catches Stencil Props, Methods and Events to define jsdoc.

This rule catches Stencil Component required tag name prefix.

This rule catches Stencil Prop names that share names of Global HTML Attributes.

This rule catches modules that expose more than just the Stencil Component itself.

This rule catches Stencil Prop marked as mutable but not changing value in code.

Recommended rules

{
  "@stencil-community/async-methods": "error",
  "@stencil-community/ban-prefix": ["error", ["stencil", "stnl", "st"]],
  "@stencil-community/decorators-context": "error",
  "@stencil-community/decorators-style": [
    "error", {
      "prop": "inline",
      "state": "inline",
      "element": "inline",
      "event": "inline",
      "method": "multiline",
      "watch": "multiline",
      "listen": "multiline"
    }],
  "@stencil-community/element-type": "error",
  "@stencil-community/host-data-deprecated": "error",
  "@stencil-community/methods-must-be-public": "error",
  "@stencil-community/no-unused-watch": "error",
  "@stencil-community/own-methods-must-be-private": "error",
  "@stencil-community/own-props-must-be-private": "error",
  "@stencil-community/prefer-vdom-listener": "error",
  "@stencil-community/props-must-be-public": "error",
  "@stencil-community/props-must-be-readonly": "error",
  "@stencil-community/render-returns-host": "error",
  "@stencil-community/required-jsdoc": "error",
  "@stencil-community/reserved-member-names": "error",
  "@stencil-community/single-export": "error",
  "@stencil-community/strict-mutable": "error"
}

Contributing

When submitting new rules please:

  • Describe your new rule in the README.md
  • Provide a suite of unit tests for your rule
  • Follow ESLint Rule guidelines (the eslint-rule yeoman generator is good for this)

All contributions welcome.

License