Skip to content

elastic/highlightjs-esql

Repository files navigation

ES|QL syntax grammar for highlight.js

This package contains the ES|QL grammar for Highlight.js.

ES|QL sample highlighted query

Usage:

const hljs = require('highlight.js');
const esql = require('@elastic/highlightjs-esql');

hljs.registerLanguage('esql', esql);

Contributing

First clone the main Highlight.js repository:

git clone https://github.com/highlightjs/highlight.js.git

Then clone this repo into the extra/ directory:

cd extra
git clone https://github.com/elastic/highlightjs-esql.git
cd ..
npm i

To test changes visually using "developer tool", build ES|QL grammar only:

node tools/build.js -n esql

Open tools/developer.html to see your changes in action.

Run only ES|QL language tests:

ONLY_EXTRA=true npm run build-browser

Run all tests:

npm run test

Releasing

Run build script:

npm i
node ./tools/build.js -t node

Run CDN build:

node ./tools/build.js -t cdn

Publish with release-it tool:

npx release-it

License

MIT

About

No description, website, or topics provided.

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 6