microsoft / microsoft/vscode-edge-devtools
Edge Devtools and Webhint - the documentation is confusing
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 827
- Forks
- 358
- Avg merge
- 20h 32m
- Merged PRs (30d)
- 10
Description
Environment (please complete the following information):
- OS Windows 11
- Extension version: 2.1.9
Describe the bug:
The documentation is not clear on Webhints status. and the install instructions.
- the product page of Microsoft Edge Tools for VS Code does not mention that
webhintis inbuilt. It should. - the product page should say that you cannot have both the
webhintandMicrosoft Edge Tools for VS Codeinstalled at the same time otherwise errors will occur. - A link to the current rules that are being apply. The reason for this is that
webhinthas a lot of functions that can be enabled/disable/changed etc.. - the instructions say you need
nodeandnpminstalled, but it does not mention thehintnpm package and whether or not you should install it. This should be specifically mentioned as the current information is confusing. - on the product page, clarify that webhint is about "Best Practices" rather than a full blown linter. The reason This should be mentions is that people can decide if they need to install ESLint and the
eslint-plugin-html - is the
htmlpackage bundled in the dev tools extension? ifhtmlis installed locally or gloablly will this instance override the bundled version? users expect tha can runnpx hint http://quantunmwarp.com/but i don't think this works with just the bundled package.
Reference link
- product page: https://marketplace.visualstudio.com/items?itemName=ms-edgedevtools.vscode-edge-devtools
- install instructions: https://learn.microsoft.com/en-gb/microsoft-edge/visual-studio-code/microsoft-edge-devtools-extension/install#step-4-install-nodejs-and-node-package-manager-npm
- hints: https://webhint.io/docs/user-guide/hints/
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 with the Microsoft Edge Tools for VS Code product page and the install instructions linked in the issue, then compare their Webhint guidance with the linked Webhint hints documentation. Clarify Webhint's bundled status, installation requirements, rules, relationship to ESLint, and package behavior; done means the product and installation pages answer each listed question without conflicting instructions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, typescript, vscode
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100