chore(lit): add linting and fix #12221
Merged
+255
−65
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
github-actions
bot
added
the
dependencies
https://mozilla-hub.atlassian.net/browse/MP-1738 migrate existing lit components to plain javascript with typescript in jsdoc to avoid the headache of dealing with typescript and babel
Bundle StatsHey there, this message comes from a github action that helps you and reviewers to understand how these changes affect the size of this project's bundle. As this PR is updated, I'll keep you updated on how the bundle size is impacted. Total
View detailed bundle breakdownAdded
Removed
Bigger No assets were bigger Smaller No assets were smaller Unchanged
|
github-actions
bot
added
the
merge conflicts 🚧
|
This pull request has merge conflicts that must be resolved before it can be merged. |
caugner
approved these changes
Dec 5, 2024
Comment on lines
147
to
148
| /** @type {HTMLElement} */ | ||
| (e.target).dataset.glean = |
There was a problem hiding this comment.
TIL: This declares the type of (e.target)?
There was a problem hiding this comment.
Yeah, though it's very weird syntax isn't it? I've changed it to a instanceof HTMLElement check for better readability and safety
Comment on lines
5
to
10
| /** | ||
| * @typedef {Object} ContributorData | ||
| * @property {string} name | ||
| * @property {string} github | ||
| * @property {string} [org] | ||
| */ |
There was a problem hiding this comment.
My preference would be to define these in a .d.ts file next to the JavaScript, as it's a bit easier / less verbose + error-prone than the JSDoc. Wdyt?
There was a problem hiding this comment.
Yeah, good idea: it's a pattern we'll be using a lot anyway with rari emitting typescript types (perhaps it could be configured to also emit jsdoc types? but it'll be easier for migration if we keep all the types in typescript, at least for now)
github-actions
bot
removed
the
merge conflicts 🚧
caugner
approved these changes
Dec 5, 2024
LeoMcA
added a commit
that referenced
this pull request
Dec 5, 2024
LeoMcA
added a commit
that referenced
this pull request
Dec 5, 2024
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.
Summary
https://mozilla-hub.atlassian.net/browse/MP-1738
Problem
There's various things we shouldn't do it Lit, and best practices with web components more widely, which we're not checking for.
Solution
Add eslint rules for lit and web components, and typescript support for lit html templates. Also fix existing components and migrate to ts in jsdoc to avoid ts/babel weirdness.
How did you test this change?
yarn devlocally