esql-syntax

Syntax highlighting for ES|QL (Elasticsearch Query Language) queries in .esql files, distributed as:

• VS Code extension — VS Code Marketplace · Open VSX
• IntelliJ plugin — JetBrains Marketplace
• Sublime Text / TextMate / other editors — Package Control (search for ES|QL) or download esql.tmLanguage from syntaxes/

Project layout

syntaxes/
├── esql.tmLanguage.json               # Canonical grammar (edit here)
└── esql.tmLanguage                    # Generated XML — run: npm run build

extensions/
├── vscode/                            # VS Code extension
└── intellij/                          # IntelliJ plugin wrapper

scripts/
├── validate-grammar.js                # Validates alternation ordering
└── json-to-xml.js                     # Converts grammar JSON → XML plist

samples/
└── example.esql                       # Sample queries for manual testing

Installation

VS Code

• Search for "Highlight ES|QL" in the VS Code Marketplace or Open VSX.
• Or download the latest .vsix from GitHub Releases and run Extensions: Install from VSIX....

IntelliJ

• Search for "Highlight ES|QL" in Settings > Plugins > Marketplace.
• Or download the latest plugin ZIP from GitHub Releases and use Install Plugin from Disk....

Development

After editing syntaxes/esql.tmLanguage.json, regenerate the XML and commit both files:

npm run build

Contributing

See CONTRIBUTING.md.

License

Apache 2.0 — see LICENSE.