Reccomend lit-plugin (#4)
This commit is contained in:
14
README.md
14
README.md
@@ -47,10 +47,22 @@ To run the dev server and open the project in a new browser tab:
|
||||
```bash
|
||||
npm run serve
|
||||
```
|
||||
## Editing
|
||||
|
||||
If you use VS Code, we highly reccomend the [lit-plugin extension](https://marketplace.visualstudio.com/items?itemName=runem.lit-plugin), which enables some extremely useful features for lit-html templates:
|
||||
- Syntax highlighting
|
||||
- Type-checking
|
||||
- Code completion
|
||||
- Hover-over docs
|
||||
- Jump to definition
|
||||
- Linting
|
||||
- Quick Fixes
|
||||
|
||||
The project is setup to reccomend lit-plugin to VS Code users if they don't already have it installed.
|
||||
|
||||
## Linting
|
||||
|
||||
Linting of TypeScript files is provided by [ESLint](eslint.org) and [TypeScript ESLint](https://github.com/typescript-eslint/typescript-eslint). In addition, [lit-analyzer](https://www.npmjs.com/package/lit-analyzer) is used to type-check and lint lit-html templates.
|
||||
Linting of TypeScript files is provided by [ESLint](eslint.org) and [TypeScript ESLint](https://github.com/typescript-eslint/typescript-eslint). In addition, [lit-analyzer](https://www.npmjs.com/package/lit-analyzer) is used to type-check and lint lit-html templates with the same engine and rules as lit-plugin.
|
||||
|
||||
The rules are mostly the recommended rules from each project, but some have been turned off to make LitElement usage easier. The recommended rules are pretty strict, so you may want to relax them by editing `.eslintrc.json` and `tsconfig.json`.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user