/Vue

Vue syntax for Sublime Text

Primary LanguageVueMIT LicenseMIT

Vue

Sublime Text Syntax highlighting for single-file Vue.js components based on its HTML, CSS, JavaScript, TypeScript, JSX, TSX and HAML syntaxes.

preview

The main branch targets Sublime Text 4.

For Sublime Text 2 compatible package using .tmlanguage files, see st2 branch.

For Sublime Text 3 (3153+) compatible package using .sublime-syntax files, see st3153 branch.

This repository is a fork of vuejs/vue-syntax-highlight with focus on providing syntax highlighting only for Sublime Text.

Installation

Package Control

The easiest way to install is using Package Control. It's listed as Vue.

  1. Open Command Palette using ctrl+shift+P or menu item Tools → Command Palette...
  2. Choose Package Control: Install Package
  3. Find Vue and hit Enter

Manual Install

  1. Download appropriate Vue-5.0.0-st4xxx.sublime-package for your Sublime Text build. The st4xxx suffix denotes the least required ST build for the sublime-package to work.
  2. Rename it to Vue.sublime-package
  3. Copy it into Installed Packages directory

Note

To find Installed Packages...

  1. call Menu > Preferences > Browse Packages..
  2. Navigate to parent folder

Requirements

  • Vue 4.0.0+ requires Sublime Text 4107+

  • Syntax highlighting in <style> tags is powered by:

  • Syntax highlighting in <script> tags is powered by:

  • Syntax highlighting in <template> tags is powered by:

    • HAML (from Sublime Text)
    • Mustache (built-in)
    • Jade
    • Pug
    • Slim

  • Intellisense features are provided by LSP and LSP-vue.

Troubleshooting

§1 Syntax Definition Parse Errors

Vue extends Sublime Text's HTML syntax definition.

If Vue syntax highlighting doesn't work and console displays syntax errors in Vue Component.sublime-syntax, please make sure to remove any out-dated syntax override.

Steps:

  1. call Menu > Preferences > Browse Packages..
  2. Look for HTML folder
  3. Remove it or at least delete any syntax definition in it.

§2 Scripts are not correctly highlighted

Vue relies on JavaScript (source.js), JSX (source.jsx), TypeScript (source.ts) and TSX (source.tsx) to scope script blocks and inline scripts.

Make sure to remove related out-dated syntax packages, which don't meet least compatibility requirements.

They can be identified by calling e.g. sublime.find_syntax_by_scope("source.ts") in ST's console.

Known candidates are:

License

MIT