Skip to content

Platform-OS/platformos-check-vscode

Repository files navigation


logo
platformOS

A complete developer experience for platformOS apps

Official VS Code extension for platformOS, powered by platformOS Check, the Liquid/GraphQL linter and language server for platformOS apps.

Features | Installation | Configuration | πŸ“¦ VS Code Marketplace

Features

  • 🎨 Syntax highlighting
  • πŸ’§ Liquid/GraphQL language server (platformOS Check)
    • πŸ“— Completions
    • βœ… Linting
    • πŸ”Ž Go to source
  • πŸ’… Formatting (Liquid Prettier plugin)
  • πŸ“ Automatic indentation
  • 🎎 Auto closing pairs

Installation

This VS Code extension depends on the platformOS Check language server.


⚠️ Warning Windows support is experimental.


Configuration

Optimize your development workflow by configuring the extension settings as follows:

  • "platformosLiquid.languageServerPath": string, (optional): Specifies the path to the platformos-check-language-server executable.
  • "platformosLiquid.disableWindowsWarning": boolean, (default: false): Set to true to disable experimental support warnings for Windows.
  • "platformosCheck.checkOnOpen": boolean, (default: true): Automatically runs checks when a file is opened.
  • "platformosCheck.checkOnChange": boolean, (default: true): Automatically runs checks when a file is modified.
  • "platformosCheck.checkOnSave": boolean, (default: true): Automatically runs checks when a file is saved.
  • "platformosCheck.onlySingleFileChecks": boolean, (default: true): Limits checks to the files currently open.

This configuration is great for enhancing performance during development by focusing on single-file checks. For comprehensive analysis, consider running full platformOS checks through the command line interface (CLI) or in your continuous integration (CI) environment.

Credits

Special thanks to the Shopify team. This extension is based on Shopify's theme-check-vscode.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published