Shopify / Shopify/theme-tools

Support for prettier plugins

Open
#342 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

tech debt
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.
Previously we had to format our liquid files with prettier, but with the v2 of the Shopify Liquid extension, we use theme-check to format our liquid files. This will make it impossible to use prettier-plugin-tailwindcss to automatically order our tailwind classes.

Describe the solution you'd like
Make sure we can use prettier plugins, so we can easily extend the theme-check formatter.

Describe alternatives you've considered
Give the option to either use a prettier plugin or the extension (with plugins).

Checklist

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

I also opened an issue on the repo of the Shopify Liquid extension.

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 packages/prettier-plugin-liquid and its principles at docs/prettier-plugin-liquid/principles/index.md. Determine how the formatter currently handles extensions, then define what plugin support must cover, including prettier-plugin-tailwindcss or an extension-provided plugin. Done means the requested plugin can be used to order Tailwind classes without losing Liquid formatting.

Written by the indexing model from the issue text.

Assessment

Tech stack
tailwindcss, typescript
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.