https://github.com/shopify/theme-check-vscode

Official Shopify Liquid VS Code extension
https://github.com/shopify/theme-check-vscode

language linter liquid syntax-highlighting vscode-extension

Last synced: 28 days ago
JSON representation

Official Shopify Liquid VS Code extension

• Host: GitHub
• URL: https://github.com/shopify/theme-check-vscode
• Owner: Shopify
• License: mit
• Archived: true
• Created: 2020-12-03T20:26:13.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-20T18:21:35.000Z (6 months ago)
• Last Synced: 2024-11-27T17:59:45.517Z (28 days ago)
• Topics: language, linter, liquid, syntax-highlighting, vscode-extension
• Language: JavaScript
• Size: 10.3 MB
• Stars: 73
• Watchers: 250
• Forks: 19
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
> [!WARNING]  

> This project has been absorbed by and moved to [Shopify/theme-tools](https://github.com/Shopify/theme-tools).



  


    

  


  Shopify Liquid

  




A complete developer experience for Shopify themes


Official VS Code extension for [Shopify Liquid](https://shopify.dev/docs/themes) powered by [Theme Check][tc] the Liquid linter and language server for online store themes.

![](https://github.com/Shopify/theme-check-vscode/blob/feature/readme-revamp/images/demo.gif?raw=true)

[Features](#features) |  [Installation](#installation) | [Configuration](#configuration) | [📦 VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=shopify.theme-check-vscode).

## Features

- 🎨 Syntax highlighting

- 💧 Liquid language server ([Theme Check][tc])

  - 📗 Completions

  - ✅ Linting

  - 🔎 Go to source

- 💅 Formatting ([Liquid Prettier plugin](https://github.com/shopify/prettier-plugin-liquid))

- 📐 Automatic indentation

- 🎎 Auto closing pairs

## Installation

This VS Code extensions depends on the [Theme Check][tc] language server, which is bundled in the latest [Shopify CLI](https://shopify.dev/themes/tools/cli).

To install the `shopify` CLI, follow these steps:

1. Go to https://shopify.dev/themes/tools/cli/install

2. Follow the instructions for your operating system

-----

⚠️ **Warning** Windows support is experimental. See [this issue](https://github.com/Shopify/theme-check-vscode/issues/5) for details.

-----

## Configuration

- `"shopifyLiquid.shopifyCLIPath": string`, (optional, Unix-only) a path to the `shopify` executable.

- `"shopifyLiquid.languageServerPath": string`, (optional) a path to the `theme-check-language-server` executable.

- `"shopifyLiquid.disableWindowsWarning": boolean`, (default: `false`) When true, theme check won't bug you with the Windows warning anymore.

- `"themeCheck.checkOnOpen": boolean`, (default: `true`) makes it so theme check runs on file open.

- `"themeCheck.checkOnChange": boolean`, (default: `true`) makes it so theme check runs on file change.

- `"themeCheck.checkOnSave": boolean`, (default: `true`) makes it so theme check runs on file save.

- `"themeCheck.onlySingleFileChecks": boolean`, (default: `false`) makes it so theme check only runs single file checks for the files that are open.

  Great for performance if can ignore checks that span multiple files during development and otherwise run full theme checks on the CLI or in CI.

[tc]: https://github.com/Shopify/theme-check