@d0whc3r/eslint-plugin-stencil
ESLint rules specific to Stencil JS projects.
Last updated a month ago by d0whc3r .
MIT · Repository · Original npm · Tarball · package.json
$ cnpm install @d0whc3r/eslint-plugin-stencil 
SYNC missed versions from official npm registry.

@d0whc3r/eslint-plugin-stencil

ESLint rules specific to Stencil JS projects.

Installation

Install the following deps in your stencil project:

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

Usage

.eslintrc.json configuration file:

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

Add a new lint script to the package.json:

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

Lint all your project:

npm run lint

Supported Rules

This rule catches Stencil public methods that are not async.

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 lifecycle written order.

This rule catches Stencil Methods marked as private or protected.

This rule catches Stencil Watchthys 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 is recommended to be "off" because it will trigger a bad autogenerated components.d.ts more details here

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

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

Contributing

When submitting new rules please:

All contributions welcome.

Licence

Current Tags

  • 0.7.0                                ...           latest (a month ago)

20 Versions

  • 0.7.0                                ...           a month ago
  • 0.6.1                                ...           7 months ago
  • 0.6.0                                ...           7 months ago
  • 0.5.11                                ...           7 months ago
  • 0.5.10                                ...           8 months ago
  • 0.5.9                                ...           8 months ago
  • 0.5.8                                ...           8 months ago
  • 0.5.7                                ...           8 months ago
  • 0.5.6                                ...           8 months ago
  • 0.5.5                                ...           8 months ago
  • 0.5.4                                ...           8 months ago
  • 0.5.3                                ...           8 months ago
  • 0.5.2                                ...           8 months ago
  • 0.5.1                                ...           8 months ago
  • 0.5.0                                ...           8 months ago
  • 0.4.2                                ...           8 months ago
  • 0.4.1                                ...           8 months ago
  • 0.4.0                                ...           8 months ago
  • 0.2.2                                ...           8 months ago
  • 0.2.1                                ...           8 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 20
Last Day 0
Last Week 20
Last Month 10
Dependencies (5)
Dev Dependencies (10)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |