Shopify / Shopify/theme-tools

Add code action to disable a check

Open
#432 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area:theme-check enhancement good first issue
Dominant language
TypeScript
Stars
234
Forks
92
Avg merge
1d 3h
Merged PRs (30d)
6

Description

ESLint has those neat code actions we could emulate:

  • "Disable $rule for this line"
  • "Disable $rule for entire file"

It adds the magic comment for you. Might be possible to do the same.

image

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 by locating the TypeScript language-server or VS Code extension entry point that handles diagnostics and code actions; the issue names no specific file or test. Add actions for disabling a rule on the current line and for the entire file, inserting the corresponding magic comment, then verify both actions in the editor.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, typescript, vscode
Domain
developer-experience, devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.