Shopify / Shopify/theme-tools

Predefined options for `@param` in `doc` tag.

Open
#1,080 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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.
I'd like to suggestions predefined options to my team.

Describe the solution you'd like
Would be very nice if we could implement a more jsdocs based version to have more control over how and what we can define.

@param {'open' | 'close'} listener - The listener to subscribe to

Checklist

  • I have checked and made sure that the proposal adheres to this plugin's principles

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 reviewing packages/prettier-plugin-liquid and its documented principles, then trace how the doc tag and @param syntax are currently handled. Define the expected behavior for predefined options such as {'open' | 'close'} and identify the relevant tests or entry points. Done means the requested JSDoc-style option syntax is supported without violating the plugin principles.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.