Add more details to the TypeScript docs #1346
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
A live preview of this PR will be available at the URL(s) below. |
e111077
reviewed
Jul 2, 2024
| @@ -202,12 +202,23 @@ For full installation and usage instructions, see the [Web Dev Server documentat | |||
|
|
|||
| ## TypeScript { #typescript } | |||
|
|
|||
| TypeScript extends the Javascript language by adding support for types. Types are useful for catching errors early and making code more readable and understandable. | |||
| Lit support developing components in TypeScript, including full type declarations for the Lit APIs, standard and experimental decorators, and community tools for template type-checking and linting. | |||
There was a problem hiding this comment.
Supports*
also I think differentiating between decorators isn’t totally relevant here esp since we tackle that later. Maybe focus a bit more on “it also supports TS” might help be a bit more concise here
| TypeScript extends the Javascript language by adding support for types. Types are useful for catching errors early and making code more readable and understandable. | ||
| Lit support developing components in TypeScript, including full type declarations for the Lit APIs, standard and experimental decorators, and community tools for template type-checking and linting. | ||
|
|
||
| Because Lit is just a library, and doesn't require a compiler or use non-standard langauge syntax, there are no specific TypeScript tools that are required. Lit works with the official TypeScript compiler, `tsc`, with TypeScript wrappers such as those for Rollup, Vite, or Webpack, and alternate compilers like `esbuild`. |
There was a problem hiding this comment.
Clarify to reader what you’re implying by “just a library”
|
Oops it’s merged |
I can make those changes though! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We hadn't mentioned what's required from a TypeScript config in this section yet.