Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add parsing + prettier support for param name and description in doc tags #665

Merged

Conversation

jamesmengo
Copy link
Contributor

What are you adding in this PR?

What's next? Any followup issues?

What did you learn?

Before you deploy

  • This PR includes a new checks or changes the configuration of a check
    • I included a minor bump changeset
    • It's in the allChecks array in src/checks/index.ts
    • I ran yarn build and committed the updated configuration files
      • If applicable, I've updated the theme-app-extension.yml config
  • I included a minor bump changeset
  • My feature is backward compatible
  • I included a patch bump changeset

…iption

Stage 1 -  capture `paramName` and `paramDescription` from the input string.

Stage 2 - Extend LiquidDocParamNode to include paramName and paramDescription

Add prettier support for paramNode and paramDescription

Stage 1: Introduce parsing for concrete paramName and paramDescription types

Stage 2: Translate paramDescription and paramName into TextNode

Prettier supoprt for paramDescription and paramName
@jamesmengo jamesmengo force-pushed the jm/liquid_doc_param_description branch from 7df1d2d to dd1f0a1 Compare December 11, 2024 00:42
@jamesmengo jamesmengo changed the base branch from jm/basic_prettier_support to jm/implement_fallbackNode December 11, 2024 00:42
@jamesmengo jamesmengo changed the title Update grammar to support liquidDocParamName and liquidDocParamDescription Add support for @param name and description in doc tags Dec 11, 2024
@jamesmengo jamesmengo changed the title Add support for @param name and description in doc tags Add parsing + prettier support for @param name and description in doc tags Dec 11, 2024
@jamesmengo jamesmengo changed the title Add parsing + prettier support for @param name and description in doc tags Add parsing + prettier support for param name and description in doc tags Dec 11, 2024
@jamesmengo jamesmengo marked this pull request as ready for review December 19, 2024 23:07
@jamesmengo jamesmengo merged commit 4bf7625 into jm/implement_fallbackNode Dec 19, 2024
6 checks passed
@jamesmengo jamesmengo deleted the jm/liquid_doc_param_description branch December 19, 2024 23:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant