Docs: Add ADR about Type Checking #1286
Open
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
florian-sanders-cc
requested review from
hsablonniere,
Galimede,
roberttran-cc,
pdesoyres-cc,
HeleneAmouzou and
clara-layus-cc
|
🔎 A preview has been automatically published : https://clever-components-preview.cellar-c2.services.clever-cloud.com/docs/adr-typechecking/index.html. This preview will be deleted once this PR is closed. |
roberttran-cc
requested changes
Jan 7, 2025
| JSDoc's main flaw is that it's fairly verbose. | ||
| Although this is a compromise we're willing to accept, there are a few cases where we'd love to see the syntax improve: | ||
| - Importing and using generics with JSDoc is tedious and inconvenient, as pointed out in the following issues: | ||
| - [JSDoc doesn't support generics correctly - issue #56102 - TypeScript repository](https://github.com/microsoft/TypeScript/issues/27387) |
There was a problem hiding this comment.
🔨 issue:
Suggested change
| - [JSDoc doesn't support generics correctly - issue #56102 - TypeScript repository](https://github.com/microsoft/TypeScript/issues/27387) | |
| - [JSDoc doesn't support generics correctly - issue #56102 - TypeScript repository](https://github.com/microsoft/TypeScript/issues/56102) |
|
|
||
| ## What is left to do? | ||
|
|
||
| - Find a way to upgrade the TypeScript version when we want (lit labs analyzer) |
There was a problem hiding this comment.
🎯 suggestion:
Suggested change
| - Find a way to upgrade the TypeScript version when we want (lit labs analyzer) | |
| - Find a way to upgrade the TypeScript version when we want |
| ## What is left to do? | ||
|
|
||
| - Find a way to upgrade the TypeScript version when we want (lit labs analyzer) | ||
| - This should be possible if we move from `custom-elements-manifest/analyzer` & `lit-analyzer` to `@lit-labs/analyzer` but this is not trivial as explained in [Investigate @lit-labs/analyzer usage - issue #1156 - Clever Components repository]. |
There was a problem hiding this comment.
🔨 issue:
Suggested change
| - This should be possible if we move from `custom-elements-manifest/analyzer` & `lit-analyzer` to `@lit-labs/analyzer` but this is not trivial as explained in [Investigate @lit-labs/analyzer usage - issue #1156 - Clever Components repository]. | |
| - This should be possible if we move from `custom-elements-manifest/analyzer` & `lit-analyzer` to `@lit-labs/analyzer` but this is not trivial as explained in [Investigate @lit-labs/analyzer usage - issue #1156 - Clever Components repository](https://github.com/CleverCloud/clever-components/issues/1156). |
HeleneAmouzou
approved these changes
Jan 8, 2025
There was a problem hiding this comment.
LGTM ! 👏 Nothing more to add than the comments @roberttran-cc already made !
hsablonniere
approved these changes
Jan 8, 2025
There was a problem hiding this comment.
Great ADR!!! 👏
- The build step is only here to optimize the code of the components.
Not sure if we really want to but there's an opportunity to mention bare imports. Our source files need a bundling phase to handle such bare imports. Nowadays, they could work as is but with import maps.
Include a note about this if you think it's relevant 😉
Galimede
approved these changes
Jan 8, 2025
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.
What does this PR do?