Inspiration - add create mapping and checker script #5139
Conversation
|
Thanks for the PR! 🎉 We've deployed an automatic preview for this PR - you can see your changes here:
Note The build needs to finish before your changes are deployed. |
| type LitElementConstructor = Constructor<{}>; | ||
| type LitElementClassType = Constructor<{}>; | ||
| type ReactiveElementConstructor = Constructor<{}>; | ||
| type ReactiveElementClassType = Constructor<{}>; |
There was a problem hiding this comment.
Typing all the template types to Constructor<{}> so that the errors are pushed to the check-html-element-tag-types.ts file
| "strictFunctionTypes": false, | ||
| "moduleResolution": "bundler", | ||
| "maxNodeModuleJsDepth": 3, | ||
| "skipLibCheck": true |
There was a problem hiding this comment.
Skip errors in *.d.ts files
| "strict": true, | ||
| "strictFunctionTypes": false, | ||
| "moduleResolution": "bundler", | ||
| "maxNodeModuleJsDepth": 3, |
There was a problem hiding this comment.
Need this to include the localize mixin from intl: https://github.com/BrightspaceUI/intl/blob/main/lib/localize.js#L17
| @@ -0,0 +1,14 @@ | |||
| /** Generated from {@link ../tools/create-mapping.sh} */ | |||
| import { LitElement } from 'lit'; | |||
There was a problem hiding this comment.
This import is needed to extend the HTMLElementTagNameMap instead of defining it. Not sure if there is a better way to do this.
awikkerink
force-pushed
the
awikkerink/inspiration-add-create-mapping-script
branch
2 times, most recently
from
0c76e6c
to
6acaee2
Compare
jsconfig.json
Outdated
There was a problem hiding this comment.
jsconfig.json is something that IDEs will pick up and use to add typing information.
| declare global { | ||
| interface HTMLElementTagNameMap { | ||
| // Components with export class...extends LitElement | ||
| 'd2l-build-info': import('../index.js').BuildInfo; |
There was a problem hiding this comment.
After this, a CI step can be created to automatically update the mapping as needed. Then, adding new components to the map should be very simple. Just add an export or @typedef, then a PR will automatically be created to add it, and the lint step will ensure that the mixins are being used correctly.
awikkerink
force-pushed
the
awikkerink/inspiration-add-create-mapping-script
branch
2 times, most recently
from
05e2774
to
77821e9
Compare
awikkerink
force-pushed
the
awikkerink/inspiration-add-create-mapping-script
branch
2 times, most recently
from
a2eb685
to
ce2d1ac
Compare
awikkerink
force-pushed
the
awikkerink/inspiration-add-create-mapping-script
branch
from
ce2d1ac
to
b03db4f
Compare
No description provided.