microsoft / microsoft/vscode-edge-devtools

Edge Devtools and Webhint - the documentation is confusing

Open
#3,156 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
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 webhint is inbuilt. It should.
  • the product page should say that you cannot have both the webhint and Microsoft Edge Tools for VS Code installed at the same time otherwise errors will occur.
  • A link to the current rules that are being apply. The reason for this is that webhint has a lot of functions that can be enabled/disable/changed etc..
  • the instructions say you need node and npm installed, but it does not mention the hint npm 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 html package bundled in the dev tools extension? if html is installed locally or gloablly will this instance override the bundled version? users expect tha can run npx hint http://quantunmwarp.com/ but i don't think this works with just the bundled package.
Reference link

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.