Skip to content

Use @elastic/highlightjs-esql instead of custom implementation #1471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 30, 2025
Merged

Use @elastic/highlightjs-esql instead of custom implementation #1471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89a4522
Use `@elastic/highlightjs-esql` instead of custom implementation
reakaleek Jun 30, 2025
153c9d8
Prettier
reakaleek Jun 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
171 changes: 2 additions & 169 deletions src/Elastic.Documentation.Site/Assets/hljs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { mergeHTMLPlugin } from './hljs-merge-html-plugin'
import esql from '@elastic/highlightjs-esql'
import { LanguageFn } from 'highlight.js'
import hljs from 'highlight.js/lib/core'
import asciidoc from 'highlight.js/lib/languages/asciidoc'
Expand Down Expand Up @@ -50,6 +51,7 @@ const languages: Array<{
{ name: 'dockerfile', module: dockerfile },
{ name: 'dos', module: dos },
{ name: 'ebnf', module: ebnf },
{ name: 'esql', module: esql },
{ name: 'go', module: go },
{ name: 'gradle', module: gradle },
{ name: 'groovy', module: groovy },
Expand Down Expand Up @@ -163,175 +165,6 @@ hljs.registerLanguage('painless', function () {
}
})

hljs.registerLanguage('esql', function () {
return {
case_insensitive: true, // language is case-insensitive
keywords: {
keyword:
'FROM ROW SHOW DISSECT DROP ENRICH EVAL GROK KEEP LIMIT LOOKUP JOIN MV_EXPAND RENAME SORT STATS WHERE METADATA CHANGE_POINT',
literal: ['false', 'true', 'null'],
function: [
// aggregate
'AVG',
'COUNT',
'COUNT_DISTINCT',
'MAX',
'MEDIAN',
'MEDIAN_ABSOLUTE_DEVIATION',
'MIN',
'PERCENTILE',
'ST_CENTROID_AGG',
'ST_EXTENT_AGG',
'STD_DEV',
'SUM',
'TOP',
'VALUES',
'WEIGHTED_AVG',
// grouping
'BUCKET',
'CATEGORIZE',
// conditional
'CASE',
'COALESCE',
'GREATEST',
'LEAST',
//Date
'DATE_DIFF',
'DATE_EXTRACT',
'DATE_FORMAT',
'DATE_PARSE',
'DATE_TRUNC',
'NOW',
//ip
'CIDR_MATCH',
'IP_PREFIX',
//math
'ABS',
'ACOS',
'ASIN',
'ATAN',
'ATAN2',
'CBRT',
'CEIL',
'COS',
'COSH',
'E',
'EXP',
'FLOOR',
'HYPOT',
'LOG',
'LOG10',
'PI',
'POW',
'ROUND',
'ROUND_TO',
'SCALB',
'SIGNUM',
'SIN',
'SINH',
'SQRT',
'TAN',
'TANH',
'TAU',
//search
'KQL',
'MATCH',
'QSTR',
//spatial
'ST_DISTANCE',
'ST_INTERSECTS',
'ST_DISJOINT',
'ST_CONTAINS',
'ST_WITHIN',
'ST_X',
'ST_Y',
'ST_ENVELOPE',
'ST_XMAX',
'ST_XMIN',
'ST_YMAX',
'ST_YMIN',
//string
'BIT_LENGTH',
'BYTE_LENGTH',
'CONCAT',
'ENDS_WITH',
'FROM_BASE64',
'HASH',
'LEFT',
'LENGTH',
'LOCATE',
'LTRIM',
'MD5',
'REPEAT',
'REPLACE',
'REVERSE',
'RIGHT',
'RTRIM',
'SHA1',
'SHA256',
'SPACE',
'SPLIT',
'STARTS_WITH',
'SUBSTRING',
'TO_BASE64',
'TO_LOWER',
'TO_UPPER',
'TRIM',
//type conversion
'TO_BOOLEAN',
'TO_CARTESIANPOINT',
'TO_CARTESIANSHAPE',
'TO_DATEPERIOD',
'TO_DATETIME',
'TO_DATE_NANOS',
'TO_DEGREES',
'TO_DOUBLE',
'TO_GEOPOINT',
'TO_GEOSHAPE',
'TO_INTEGER',
'TO_IP',
'TO_LONG',
'TO_RADIANS',
'TO_STRING',
'TO_TIMEDURATION',
'TO_UNSIGNED_LONG',
'TO_VERSION',
//multivalued
'MV_APPEND',
'MV_AVG',
'MV_CONCAT',
'MV_COUNT',
'MV_DEDUPE',
'MV_FIRST',
'MV_LAST',
'MV_MAX',
'MV_MEDIAN',
'MV_MEDIAN_ABSOLUTE_DEVIATION',
'MV_MIN',
'MV_PERCENTILE',
'MV_PSERIES_WEIGHTED_SUM',
'MV_SORT',
'MV_SLICE',
'MV_SUM',
'MV_ZIP',
],
},
contains: [
hljs.QUOTE_STRING_MODE,
hljs.C_LINE_COMMENT_MODE,
{
scope: 'operator', // (pathname: path1/path2/dothis) color #ab5656
match: /(?:<|<=|==|::|\w+:|!=|>=|>|LIKE|RLIKE|IS NULL|IS NOT NULL)/,
},
{
scope: 'punctuation', // (pathname: path1/path2/dothis) color #ab5656
match: /(?:!?\[|\]|\|)/,
},
NUMBER,
],
}
})

hljs.addPlugin(mergeHTMLPlugin)

// The unescaped HTML warning is caused by the mergeHTMLPlugin which we are using
Expand Down
6 changes: 6 additions & 0 deletions src/Elastic.Documentation.Site/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions src/Elastic.Documentation.Site/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
"defaults"
],
"dependencies": {
"@elastic/highlightjs-esql": "1.1.0",
"clipboard": "2.0.11",
"highlight.js": "11.11.1",
"htmx-ext-head-support": "2.0.4",
Expand Down
Loading