Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/43081j/eslint-plugin-lit
lit-html support for ESLint
https://github.com/43081j/eslint-plugin-lit
eslint eslintplugin hacktoberfest lit polymer web-components
Last synced: 6 days ago
JSON representation
lit-html support for ESLint
- Host: GitHub
- URL: https://github.com/43081j/eslint-plugin-lit
- Owner: 43081j
- Created: 2018-08-16T22:11:08.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-07T06:49:39.000Z (4 months ago)
- Last Synced: 2024-12-20T09:04:37.814Z (6 days ago)
- Topics: eslint, eslintplugin, hacktoberfest, lit, polymer, web-components
- Language: TypeScript
- Homepage:
- Size: 570 KB
- Stars: 121
- Watchers: 7
- Forks: 22
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `eslint-plugin-lit`
[](https://npmjs.org/package/eslint-plugin-lit 'View this project on npm')
[](https://travis-ci.com/43081j/eslint-plugin-lit)
[](https://coveralls.io/github/43081j/eslint-plugin-lit?branch=master)
[](https://opensource.org/licenses/MIT)
> ESLint plugin for [Lit](https://lit.dev/).
## Install
Assuming you already have ESLint installed, run:
```sh
# npm
npm install eslint-plugin-lit --save-dev
# yarn
yarn add eslint-plugin-lit --dev
```
## Usage
Then extend the recommended eslint config:
```js
{
"extends": [
// ...
"plugin:lit/recommended"
]
}
```
Or if you're using (flat) config files, add to your `eslint.config.js`:
```ts
import {configs} from 'eslint-plugin-lit';
export default [
configs['flat/recommended'],
// or if you want to specify `files`, or other options
{
...configs['flat/recommended'],
files: ['test/**/*.js']
}
];
```
### Custom Configuration
If you want more fine-grained configuration, you can instead add a snippet like this to your ESLint configuration file:
```js
{
"plugins": [
// ...
"lit"
],
"rules": {
// ...
"lit/no-legacy-template-syntax": "error",
"lit/no-template-arrow": "warn"
}
}
```
## List of supported rules
- [lit/attribute-names](docs/rules/attribute-names.md)
- [lit/attribute-value-entities](docs/rules/attribute-value-entities.md)
- [lit/ban-attributes](docs/rules/ban-attributes.md)
- [lit/binding-positions](docs/rules/binding-positions.md)
- [lit/lifecycle-super](docs/rules/lifecycle-super.md)
- [lit/no-classfield-shadowing](docs/rules/no-classfield-shadowing.md)
- [lit/no-duplicate-template-bindings](docs/rules/no-duplicate-template-bindings.md)
- [lit/no-invalid-escape-sequences](docs/rules/no-invalid-escape-sequences.md)
- [lit/no-invalid-html](docs/rules/no-invalid-html.md)
- [lit/no-legacy-imports](docs/rules/no-legacy-imports.md)
- [lit/no-legacy-template-syntax](docs/rules/no-legacy-template-syntax.md)
- [lit/no-native-attributes](docs/rules/no-native-attributes.md)
- [lit/no-private-properties](docs/rules/no-private-properties.md)
- [lit/no-property-change-update](docs/rules/no-property-change-update.md)
- [lit/no-template-arrow](docs/rules/no-template-arrow.md)
- [lit/no-template-bind](docs/rules/no-template-bind.md)
- [lit/no-template-map](docs/rules/no-template-map.md)
- [lit/no-this-assign-in-render](docs/rules/no-this-assign-in-render.md)
- [lit/no-useless-template-literals](docs/rules/no-useless-template-literals.md)
- [lit/no-value-attribute](docs/rules/no-value-attribute.md)
- [lit/prefer-nothing](docs/rules/prefer-nothing.md)
- [lit/quoted-expressions](docs/rules/quoted-expressions.md)
- [lit/value-after-constraints](docs/rules/value-after-constraints.md)
## Shareable configurations
### Recommended
This plugin exports a `recommended` configuration that enforces Lit good practices.
To enable this configuration use the `extends` property in your `.eslintrc` config file:
```js
{
"extends": ["eslint:recommended", "plugin:lit/recommended"]
}
```
## Usage with `eslint-plugin-wc`
We **highly** recommend you also depend on
[eslint-plugin-wc](https://github.com/43081j/eslint-plugin-wc) as it will
provide additional rules for web components in general:
```sh
npm i -D eslint-plugin-wc
```
Then extend the recommended eslint config:
```json
{
"extends": [
"plugin:wc/recommended",
"plugin:lit/recommended"
]
}
```
## License
MIT