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.

Sign up for GitHub

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

Jump to bottom

Add parsing + prettier support for @param in {% doc %} tags #646

Merged
merged 16 commits into from
Jan 16, 2025
Merged

Add parsing + prettier support for @param in {% doc %} tags #646

merged 16 commits into from
Jan 16, 2025

Conversation

jamesmengo
Copy link
Contributor

@jamesmengo jamesmengo commented Dec 3, 2024 •
edited
Loading

What are you adding in this PR?

Closes https://github.com/Shopify/develop-advanced-edits/issues/441
https://share.descript.com/view/sZkEWbd5kAr

Added support for parsing and formatting @param tags within Liquid doc blocks.

  • Added a configurable option to prettier liquidDocParamDash to format all descriptions with - (or not)

What's next? Any followup issues?

  • I'm moving on to completions while Josh is going to add parsing + prettier support for the @example tag
  • I want to add support for optional params, default values, etc afterwards

What did you learn?

Creating ohm syntax rules is an art form

Testing

Cursor.-.Extension.Development.Host.swatch.liquid.horizon.mp4

Before you deploy

  • I included a minor bump changeset
  • My feature is backward compatible

@jamesmengo Graphite App
Copy link
Contributor Author

jamesmengo commented Dec 3, 2024 •
edited
Loading

This stack of pull requests is managed by Graphite. Learn more about stacking.

@jamesmengo jamesmengo mentioned this pull request Dec 3, 2024
Closed
8 tasks
@jamesmengo jamesmengo force-pushed the jm/implement_fallbackNode branch from 4d4c72d to 92a1d96 Compare December 4, 2024 17:28
@jamesmengo jamesmengo force-pushed the jm/doc_param branch 2 times, most recently from 64f7dd8 to 944ecb4 Compare December 4, 2024 17:37
@jamesmengo jamesmengo force-pushed the jm/implement_fallbackNode branch from 92a1d96 to 10ded69 Compare December 4, 2024 19:36
@jamesmengo jamesmengo changed the base branch from jm/doc_param to jm/doc_tag December 4, 2024 19:36
This was referenced Dec 4, 2024
Merged
Merged
Closed
@jamesmengo jamesmengo changed the title Implement fallbackNode for LiquidDoc Add parsing support for @param tags in LiquidDoc Dec 4, 2024
Base automatically changed from jm/doc_tag to main December 4, 2024 22:10
@jamesmengo jamesmengo force-pushed the jm/implement_fallbackNode branch from 10ded69 to 79f4c94 Compare December 5, 2024 00:56
@jamesmengo jamesmengo mentioned this pull request Dec 5, 2024
Closed
8 tasks
@jamesmengo jamesmengo changed the title Add parsing support for @param tags in LiquidDoc Add basic parsing support for @param tags in LiquidDoc Dec 5, 2024
This was referenced Dec 11, 2024
Merged
Merged
Merged
@jamesmengo jamesmengo force-pushed the jm/implement_fallbackNode branch 2 times, most recently from 68227c4 to e7ed99d Compare December 11, 2024 00:42
@jamesmengo jamesmengo changed the title Add basic parsing support for @param tags in LiquidDoc Add basic parsing + prettier support for LiquidDoc param tag Dec 11, 2024
@jamesmengo jamesmengo changed the title Add basic parsing + prettier support for LiquidDoc param tag Add parsing + prettier support for @param in {% doc %} tags Dec 11, 2024
@jamesmengo jamesmengo mentioned this pull request Dec 11, 2024
Merged
8 tasks
@jamesmengo jamesmengo force-pushed the jm/implement_fallbackNode branch from 38b6f21 to 4d6c5e4 Compare December 19, 2024 23:20
@jamesmengo jamesmengo marked this pull request as ready for review January 7, 2025 17:14
@jamesmengo jamesmengo mentioned this pull request Jan 7, 2025
Merged
8 tasks
@jamesmengo jamesmengo force-pushed the jm/implement_fallbackNode branch from 4d6c5e4 to 330f04b Compare January 7, 2025 22:42
@jamesmengo jamesmengo force-pushed the jm/implement_fallbackNode branch 2 times, most recently from ba370d4 to 3c9cefa Compare January 14, 2025 23:07
@jamesmengo jamesmengo requested a review from charlespwd January 14, 2025 23:22
@charlespwd
Copy link
Contributor

image

image

image

@jamesmengo Graphite App
Copy link
Contributor Author

jamesmengo commented Jan 16, 2025 •
edited
Loading

Merge activity

  • Jan 16, 5:17 PM EST: A user started a stack merge that includes this pull request via Graphite.
  • Jan 16, 5:18 PM EST: Graphite rebased this pull request as part of a merge.
  • Jan 16, 5:19 PM EST: A user merged this pull request with Graphite.

@jamesmengo
Parser + Prettier support for {% doc %} tag and @param node in Liquid…
a31f033 
… Doc
@jamesmengo
Make paramName required
d02e8c2
@jamesmengo
Make LiquidDoc param descriptions more flexible
3f3df3d
@jamesmengo
Remove artifact comment
3d6a40f
@jamesmengo
Improve clarity of fallback node in stage-1 CST test
6d62a21
@jamesmengo
Remove unused value property for LiquidDocParamNode
b2697da
@jamesmengo
Refactor LiquidDocParamNode to enforce 'param' as a constant name
f545c19
@jamesmengo
Improve type clarity by making LiquidDocParamNode description and typ…
24d9d74 
…e optional
@jamesmengo
Make LiquidDoc @param description dash seperator a configurable prett…
6a18b6f 
…ier option and simplify types

Now that this is a configurable option, we don't need to capture this information in the type.
This means we can replace the description node with a simple text node.

Simplify types: Remove Replace LiquidDocParamDescription with TextNode

Now that the param description is configurable, this isn't needed
@jamesmengo
Add LiquidDocConcreteNode as a type of LiquidHtmlConcreteNode
61be9cc
@jamesmengo
Fix - pass 'param' as node name to stage 2
9320665
@jamesmengo
AST-1: Remove unused DashSeperator field
28cbadb
@jamesmengo
Refactor toLiquidDocAst: Assign param attributes via mappings rather …
53fa27e 
…than directly
@jamesmengo
Add test for parsing @param with type containing spaces in LiquidDoc
bbe657f
@jamesmengo
Update grammar to strip whitespace using Ohm matcher
dcd4fd2
@jamesmengo
Add changeset
ac55577
@jamesmengo jamesmengo force-pushed the jm/implement_fallbackNode branch from 56acedc to ac55577 Compare January 16, 2025 22:17
@jamesmengo jamesmengo merged commit 6ab6856 into main Jan 16, 2025
7 checks passed
@jamesmengo jamesmengo deleted the jm/implement_fallbackNode branch January 16, 2025 22:19
This was referenced Jan 20, 2025
Merged
Closed
Open
Draft
Draft
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aswamy aswamy aswamy approved these changes

@charlespwd charlespwd Awaiting requested review from charlespwd

Assignees

@jamesmengo jamesmengo

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jamesmengo @charlespwd @aswamy