-
Notifications
You must be signed in to change notification settings - Fork 205
Update developement docs #146
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
||
### Using Linting plugins | ||
|
||
Integrating linting into your IDE workflow can help catch errors as early as possible, right when you're typing out your code. The following ESLint plugin can be added to check for some common issues in Lit templates: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's odd that we recommend two Lit-specific IDE plugins, above and in this section. Seems less confusing to only talk about one, or else talk about them in the same section, at least. Since we call out the TypeScript plugin, maybe it would make sense to call this an ESLint plugin in that same section? And maybe move the linting section above the IDE plugin section (so that linting is introduced first?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Re-organized sections as recommended.
|
||
* [https://github.com/43081j/eslint-plugin-lit](https://github.com/43081j/eslint-plugin-lit) | ||
|
||
## Setting up formatting { #formatting } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd personally nix this section; there's nothing Lit-specific about it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Neither does the TS section. Re-org'd a bit.
Co-authored-by: Kevin Schaaf <kschaaf@google.com>
Co-authored-by: Kevin Schaaf <kschaaf@google.com>
Co-authored-by: Kevin Schaaf <kschaaf@google.com>
Co-authored-by: Kevin Schaaf <kschaaf@google.com>
Co-authored-by: Kevin Schaaf <kschaaf@google.com>
Co-authored-by: Kevin Schaaf <kschaaf@google.com>
Co-authored-by: Kevin Schaaf <kschaaf@google.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Co-authored-by: Kevin Schaaf <kschaaf@google.com>
@web/dev-server