hljs-kql

Kusto Query Language (KQL) syntax highlighting for Highlight.js.

KQL is used by Azure Data Explorer, Azure Monitor, Microsoft Sentinel, and other Microsoft data services.

Install

npm install highlight.js hljs-kql

Use

import hljs from "highlight.js/lib/core";
import kql from "hljs-kql";

hljs.registerLanguage("kql", kql);

const result = hljs.highlight(
  "StormEvents | where State == 'FLORIDA' | summarize count()",
  { language: "kql" }
);

The grammar registers kql and kusto as aliases.

Browser distribution

Build and test everything with:

npm install
npm run build

The build script:

1. Clones Highlight.js 11.11.1 into .cache on the first run.
2. Links this repository into highlight.js/extra/hljs-kql.
3. Runs the standalone package tests.
4. Installs the Highlight.js build dependencies.
5. Lints the grammar with the Highlight.js ESLint configuration.
6. Builds Highlight.js for Node.js and runs the third-party markup tests.
7. Generates dist/kql.min.js and dist/kql.es.min.js.

The cached checkout is reused by later builds and is excluded from Git. Delete .cache if you need to recreate it.

Develop and test

For only the fast standalone tests:

npm install
npm test

Use npm run build before committing grammar or distribution changes. CI runs the same command and rejects stale files in dist.

The grammar follows the official Kusto token grammar and the Highlight.js language contribution guide.

License

MIT