Skip to content

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

Merged
merged 14 commits into from
Feb 26, 2021
Merged

Update developement docs #146

merged 14 commits into from
Feb 26, 2021

Conversation

sorvell
Copy link
Member

@sorvell sorvell commented Feb 4, 2021

  • Edited for consistency
  • Adds section on TypeScript
  • Updated dev server to point to @web/dev-server

@sorvell sorvell requested a review from arthurevans February 4, 2021 20:42
@nicolejadeyee nicolejadeyee added this to the Website complete milestone Feb 10, 2021

### 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:
Copy link
Member

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?)

Copy link
Member Author

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 }
Copy link
Member

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.

Copy link
Member Author

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.

Steve Orvell and others added 9 commits February 24, 2021 10:50
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>
@sorvell sorvell requested a review from kevinpschaaf February 24, 2021 22:47
Copy link
Member

@kevinpschaaf kevinpschaaf left a 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>
@sorvell sorvell merged commit f1c7e88 into master Feb 26, 2021
@justinfagnani justinfagnani deleted the development branch April 1, 2021 20:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants