Shopify / Shopify/theme-tools

Introduce global suggestions for supporting `{% # theme-check-disable <type> %}`

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

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
234
Forks
92
Avg merge
1d 3h
Merged PRs (30d)
6

Description

Is your feature request related to a problem? Please describe.

Currently, our language server doesn't offer suggestions to ignore theme-check offenses. I believe it would be a great to have a single implementation to ignore across all checks (something like: {% # theme-check-disable <check_name> %}).

I don't foresee this feature promoting excessive use of the ignore function. Given that comments in the code already create a certain level of noise, so this feature seems to be more beneficial than not providing those suggestions.

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 language-server suggestion entry points and the existing handling for theme-check offenses or ignore comments. Implement the proposed {% # theme-check-disable <check_name> %} suggestion consistently across checks, then verify that suggestions appear for the intended offenses and use the requested syntax.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.