Shopify / Shopify/theme-tools

Support for .yml.liquid file formatting

Open
#863 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement open for contributions
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.
The current plugin does not properly format .yml.liquid files, which are YAML files containing Liquid template syntax. This leads to inconsistent formatting and potential errors in our project's configuration files.

Describe the solution you'd like
Add support for .yml.liquid files, allowing the plugin to correctly format both the YAML structure and the embedded Liquid syntax without breaking the file's overall structure.

Describe alternatives you've considered
We've considered using separate YAML and Liquid formatters, but this approach is cumbersome and doesn't provide a seamless solution for our mixed-syntax files.

Checklist

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

Additional context
This feature would greatly improve the development workflow for projects using Shopify themes or similar setups where YAML and Liquid are frequently combined.

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 reading docs/prettier-plugin-liquid/principles/index.md and locating the plugin's formatter entry point for YAML and Liquid files. Trace how compound extensions are classified, then verify that .yml.liquid files preserve both YAML structure and embedded Liquid syntax without breaking either format.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
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.