material-components / material-components/material-web
Provide a `web-types.json` file for compatibility with Intellij IDEs
Nobody has claimed this yet.
- Dominant language
- SCSS
- Stars
- 11.3k
- Forks
- 1.1k
- Avg merge
- 20h 28m
- Merged PRs (30d)
- 13
Description
### What is affected?
Tooling
### Description
Provide a `web-types.json` file in line with Intellij standards, in order to enable syntax highlighting for Intellij IDEs. This could probably be automatically generated in `scripts/analyzer`.
See https://github.com/JetBrains/web-types
### Reproduction
Use `@material/web` in an Intellij IDE, and write some code using material web components. An inspection error saying "Unknown html tag" will appear (see image)
### Workaround
Add each component to `Settings > Editor > Inspections > HTML > Unknown tag` manually
### Is this a regression?
No or unsure. This never worked, or I haven't tried before.
### Affected versions
1.0.1
### Browser/OS/Node environment
IntelliJ IDEA 2023.2.5 (Ultimate Edition)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the web-types standard linked in the issue and inspect the existing generation entry point in scripts/analyzer. Determine the metadata IntelliJ requires for the Material Web components, then provide a compatible web-types.json file or generation output and verify that IntelliJ recognizes the components without unknown-tag warnings.
Written by the indexing model from the issue text.
Assessment
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100