Skip to content

docs: highlight all lexer keywords in the playground and in-repo grammars - #6210

Merged
max-sixty merged 3 commits into
mainfrom
docs/grammar-keyword-sync
Aug 19, 2026
Merged

docs: highlight all lexer keywords in the playground and in-repo grammars#6210
max-sixty merged 3 commits into
mainfrom
docs/grammar-keyword-sync

Conversation

@prql-bot

@prql-botprql-bot commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Problem

#6207 brought the two Handlebars/highlight.js keyword lists in line with the lexer's keyword parser, but the same drift remains in the grammars this repo ships. Against the ten keywords the lexer defines (let, into, case, prql, type, module, internal, func, import, enum):

GrammarMissing
web/playground/src/workbench/prql-syntax.js (Monarch)into, type, module, internal, func, import, enum
grammars/GtkSourceView/prql.langinto, case, type, module, internal, func, import, enum
grammars/CotEditor/PRQL.yamlinto, type, internal, func, import, enum
grammars/KSyntaxHighlighting/prql.xmlinto, case, internal, func, import, enum

The playground one is the most visible: module, type and into render as plain identifiers on prql-lang.org today. The emacs and nano grammars already carry the full set, so they're untouched.

Solution

Add the missing entries to each keyword list, with the same "keep in sync with the lexer" comment #6207 added, so the next drift is easier to spot.

Two grammars also needed their styling adjusting so the added keywords actually render as keywords:

  • GtkSourceView had a single declarations context (style-ref="declaration", which maps to def:type), so func/case/into/import would have rendered in the same colour as int and timestamp, while the file's keyword style — mapping to def:keyword — was declared but referenced by nothing. That context is now keywords, styled keyword, holding all ten; the unused declaration style is dropped. prql moves out of built-in-object into it, which brings the file in line with emacs (prql-other-keywordsfont-lock-keyword-face), nano and KSyntaxHighlighting, all of which put the same ten on one keyword face.
  • KSyntaxHighlighting holds prql in a modules_builtin list that no context references, so it wasn't highlighted at all; it's now in the new keywords list, alongside import in imports. Both map to the same Keyword attribute as the lists beside them. The <language>version is bumped 01, per KDE's contributing note ("If you are modifying an existing syntax definition XML file, you must increase the version number of the language").

CotEditor and the playground keep their existing groupings — both already carried prql on a keyword list.

Testing

No automated coverage exists for these grammars (#2052 tracks that), so verification is structural: both XML files parse, every style the GtkSourceView file declares is now referenced by a context, the CotEditor YAML parses to the expected 20-entry keyword list, and prettier passes on the JS and YAML.

Found during the nightly rolling survey of grammars/GtkSourceView/prql.lang and web/playground/src/workbench/monaco-theme.json.

@prql-botprql-bot left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two observations on the grammar files, one of which means the PR doesn't quite reach its own goal.

prql still isn't highlighted in the KSyntaxHighlighting grammar. The new comment says "prql is a built-in module", but the modules_builtin list holding it isn't referenced by any context — the only keyword rules in the Normal context are types, specialvars, builtinfuncs, declarations, letExpressions, imports and the newly-added keywords (date_functions, text_functions and durations are orphaned the same way). So prql renders as a plain identifier in Kate, and the comment points the next person checking for drift at a list that does nothing. The inline suggestion adds it to the new keywords list; the alternative — referencing modules_builtin from Normal — needs a new itemData and would be shadowed for date/text, which the types rule already claims a few lines earlier.

In GtkSourceView all nine land on style-ref="declaration", which maps to def:type.func, case, into and import will render in the same colour as int and timestamp, while the file declares <style id="keyword" … map-to="def:keyword"/> that nothing references (grep style-ref= prql.lang returns every style except keyword). The other three grammars here put these tokens on a keyword token/attribute, and emacs' prql-other-keywords — the same ten — uses font-lock-keyword-face. A second context styled keyword, mirroring the new keywords list this PR adds on the KSyntaxHighlighting side, would be more consistent; whether let/type/module move with it is a styling call, so leaving it rather than pushing one.

Two smaller things:

  • prql.xml still carries version="0", unchanged since the file was added, and this is the first content change to it. I believe KSyntaxHighlighting selects among duplicate definitions of a language by that attribute, so it's conventionally incremented on each edit — I couldn't reach docs.kde.org from CI to confirm the exact rule, hence flagging rather than suggesting.
  • Four grammars drifted simultaneously here. The sync comments make the next drift easier to spot but nothing fails when it happens, and test-grammars only covers lezer and raku. keyword() spells its ten out inline; lifting them into a const would let a small test assert each grammar file mentions each keyword — cheap coverage for the part of #2052 that bit here.

Comment threadgrammars/KSyntaxHighlighting/prql.xml
`prql` sat in the `modules_builtin` list, which no context references, so
it rendered as a plain identifier.
@prql-bot

Copy link
Copy Markdown
CollaboratorAuthor

Thanks — both grammar points were real; pushed 2e54e6a and 9ebdbf3.

GtkSourceView styling. Made the call and moved all ten onto keyword: the declarations context is now keywords, style-ref="keyword", the unreferenced declaration style is dropped, and prql moves out of built-in-object into it. That matches emacs (prql-other-keywordsfont-lock-keyword-face), nano (one color yellow line for the same ten) and KSyntaxHighlighting (every keyword list → the Keyword attribute), so all five grammars now put the lexer's keywords on one face. Every style the file declares is referenced by a context again, which is what flagged the problem in the first place.

version="0". Confirmed and bumped to 1 — KDE's contributing notes say "If you are modifying an existing syntax definition XML file, you must increase the version number of the language." (docs.kde.org is unreachable from CI, but the repo README is fetchable via the API.)

A drift test. Agreed it's the right fix for the class of bug, but it's independently revertable from this PR and I'm at five open PRs, so noting the shape here rather than opening a sixth: lift the ten just(..) arms in keyword() into a pub const KEYWORDS: [&str; 10], drive the parser from it, and assert in a test that each grammar file under grammars/ carrying a keyword list, plus web/playground/src/workbench/prql-syntax.js, contains every entry. A substring check over the file text is crude but is exactly the assertion that would have failed here, and it needs no per-format parser. #2052 is the tracking issue.

Not addressed: modules_builtin, date_functions, text_functions and durations in prql.xml are all orphaned lists no context references — pre-existing, and untangling them means new itemData entries and resolving the shadowing against types.

@max-sixty
max-sixty merged commit 7c3ed1a into mainAug 19, 2026
39 checks passed
@max-sixty
max-sixty deleted the docs/grammar-keyword-sync branch August 19, 2026 13:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@prql-bot@max-sixty
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
docs: highlight all lexer keywords in the playground and in-repo grammars by prql-bot · Pull Request #6210 · PRQL/prql · GitHub
Skip to content

docs: highlight all lexer keywords in the playground and in-repo grammars - #6210

Merged
max-sixty merged 3 commits into
mainfrom
docs/grammar-keyword-sync
Aug 19, 2026
Merged

docs: highlight all lexer keywords in the playground and in-repo grammars#6210
max-sixty merged 3 commits into
mainfrom
docs/grammar-keyword-sync

Conversation

@prql-bot

@prql-botprql-bot commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Problem

#6207 brought the two Handlebars/highlight.js keyword lists in line with the lexer's keyword parser, but the same drift remains in the grammars this repo ships. Against the ten keywords the lexer defines (let, into, case, prql, type, module, internal, func, import, enum):

GrammarMissing
web/playground/src/workbench/prql-syntax.js (Monarch)into, type, module, internal, func, import, enum
grammars/GtkSourceView/prql.langinto, case, type, module, internal, func, import, enum
grammars/CotEditor/PRQL.yamlinto, type, internal, func, import, enum
grammars/KSyntaxHighlighting/prql.xmlinto, case, internal, func, import, enum

The playground one is the most visible: module, type and into render as plain identifiers on prql-lang.org today. The emacs and nano grammars already carry the full set, so they're untouched.

Solution

Add the missing entries to each keyword list, with the same "keep in sync with the lexer" comment #6207 added, so the next drift is easier to spot.

Two grammars also needed their styling adjusting so the added keywords actually render as keywords:

  • GtkSourceView had a single declarations context (style-ref="declaration", which maps to def:type), so func/case/into/import would have rendered in the same colour as int and timestamp, while the file's keyword style — mapping to def:keyword — was declared but referenced by nothing. That context is now keywords, styled keyword, holding all ten; the unused declaration style is dropped. prql moves out of built-in-object into it, which brings the file in line with emacs (prql-other-keywordsfont-lock-keyword-face), nano and KSyntaxHighlighting, all of which put the same ten on one keyword face.
  • KSyntaxHighlighting holds prql in a modules_builtin list that no context references, so it wasn't highlighted at all; it's now in the new keywords list, alongside import in imports. Both map to the same Keyword attribute as the lists beside them. The <language>version is bumped 01, per KDE's contributing note ("If you are modifying an existing syntax definition XML file, you must increase the version number of the language").

CotEditor and the playground keep their existing groupings — both already carried prql on a keyword list.

Testing

No automated coverage exists for these grammars (#2052 tracks that), so verification is structural: both XML files parse, every style the GtkSourceView file declares is now referenced by a context, the CotEditor YAML parses to the expected 20-entry keyword list, and prettier passes on the JS and YAML.

Found during the nightly rolling survey of grammars/GtkSourceView/prql.lang and web/playground/src/workbench/monaco-theme.json.

@prql-botprql-bot left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two observations on the grammar files, one of which means the PR doesn't quite reach its own goal.

prql still isn't highlighted in the KSyntaxHighlighting grammar. The new comment says "prql is a built-in module", but the modules_builtin list holding it isn't referenced by any context — the only keyword rules in the Normal context are types, specialvars, builtinfuncs, declarations, letExpressions, imports and the newly-added keywords (date_functions, text_functions and durations are orphaned the same way). So prql renders as a plain identifier in Kate, and the comment points the next person checking for drift at a list that does nothing. The inline suggestion adds it to the new keywords list; the alternative — referencing modules_builtin from Normal — needs a new itemData and would be shadowed for date/text, which the types rule already claims a few lines earlier.

In GtkSourceView all nine land on style-ref="declaration", which maps to def:type.func, case, into and import will render in the same colour as int and timestamp, while the file declares <style id="keyword" … map-to="def:keyword"/> that nothing references (grep style-ref= prql.lang returns every style except keyword). The other three grammars here put these tokens on a keyword token/attribute, and emacs' prql-other-keywords — the same ten — uses font-lock-keyword-face. A second context styled keyword, mirroring the new keywords list this PR adds on the KSyntaxHighlighting side, would be more consistent; whether let/type/module move with it is a styling call, so leaving it rather than pushing one.

Two smaller things:

  • prql.xml still carries version="0", unchanged since the file was added, and this is the first content change to it. I believe KSyntaxHighlighting selects among duplicate definitions of a language by that attribute, so it's conventionally incremented on each edit — I couldn't reach docs.kde.org from CI to confirm the exact rule, hence flagging rather than suggesting.
  • Four grammars drifted simultaneously here. The sync comments make the next drift easier to spot but nothing fails when it happens, and test-grammars only covers lezer and raku. keyword() spells its ten out inline; lifting them into a const would let a small test assert each grammar file mentions each keyword — cheap coverage for the part of #2052 that bit here.

Comment threadgrammars/KSyntaxHighlighting/prql.xml
`prql` sat in the `modules_builtin` list, which no context references, so
it rendered as a plain identifier.
@prql-bot

Copy link
Copy Markdown
CollaboratorAuthor

Thanks — both grammar points were real; pushed 2e54e6a and 9ebdbf3.

GtkSourceView styling. Made the call and moved all ten onto keyword: the declarations context is now keywords, style-ref="keyword", the unreferenced declaration style is dropped, and prql moves out of built-in-object into it. That matches emacs (prql-other-keywordsfont-lock-keyword-face), nano (one color yellow line for the same ten) and KSyntaxHighlighting (every keyword list → the Keyword attribute), so all five grammars now put the lexer's keywords on one face. Every style the file declares is referenced by a context again, which is what flagged the problem in the first place.

version="0". Confirmed and bumped to 1 — KDE's contributing notes say "If you are modifying an existing syntax definition XML file, you must increase the version number of the language." (docs.kde.org is unreachable from CI, but the repo README is fetchable via the API.)

A drift test. Agreed it's the right fix for the class of bug, but it's independently revertable from this PR and I'm at five open PRs, so noting the shape here rather than opening a sixth: lift the ten just(..) arms in keyword() into a pub const KEYWORDS: [&str; 10], drive the parser from it, and assert in a test that each grammar file under grammars/ carrying a keyword list, plus web/playground/src/workbench/prql-syntax.js, contains every entry. A substring check over the file text is crude but is exactly the assertion that would have failed here, and it needs no per-format parser. #2052 is the tracking issue.

Not addressed: modules_builtin, date_functions, text_functions and durations in prql.xml are all orphaned lists no context references — pre-existing, and untangling them means new itemData entries and resolving the shadowing against types.

@max-sixty
max-sixty merged commit 7c3ed1a into mainAug 19, 2026
39 checks passed
@max-sixty
max-sixty deleted the docs/grammar-keyword-sync branch August 19, 2026 13:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@prql-bot@max-sixty
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' docs: highlight all lexer keywords in the playground and in-repo grammars by prql-bot · Pull Request #6210 · PRQL/prql · GitHub
Skip to content

docs: highlight all lexer keywords in the playground and in-repo grammars - #6210

Merged
max-sixty merged 3 commits into
mainfrom
docs/grammar-keyword-sync
Aug 19, 2026
Merged

docs: highlight all lexer keywords in the playground and in-repo grammars#6210
max-sixty merged 3 commits into
mainfrom
docs/grammar-keyword-sync

Conversation

@prql-bot

@prql-botprql-bot commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Problem

#6207 brought the two Handlebars/highlight.js keyword lists in line with the lexer's keyword parser, but the same drift remains in the grammars this repo ships. Against the ten keywords the lexer defines (let, into, case, prql, type, module, internal, func, import, enum):

GrammarMissing
web/playground/src/workbench/prql-syntax.js (Monarch)into, type, module, internal, func, import, enum
grammars/GtkSourceView/prql.langinto, case, type, module, internal, func, import, enum
grammars/CotEditor/PRQL.yamlinto, type, internal, func, import, enum
grammars/KSyntaxHighlighting/prql.xmlinto, case, internal, func, import, enum

The playground one is the most visible: module, type and into render as plain identifiers on prql-lang.org today. The emacs and nano grammars already carry the full set, so they're untouched.

Solution

Add the missing entries to each keyword list, with the same "keep in sync with the lexer" comment #6207 added, so the next drift is easier to spot.

Two grammars also needed their styling adjusting so the added keywords actually render as keywords:

  • GtkSourceView had a single declarations context (style-ref="declaration", which maps to def:type), so func/case/into/import would have rendered in the same colour as int and timestamp, while the file's keyword style — mapping to def:keyword — was declared but referenced by nothing. That context is now keywords, styled keyword, holding all ten; the unused declaration style is dropped. prql moves out of built-in-object into it, which brings the file in line with emacs (prql-other-keywordsfont-lock-keyword-face), nano and KSyntaxHighlighting, all of which put the same ten on one keyword face.
  • KSyntaxHighlighting holds prql in a modules_builtin list that no context references, so it wasn't highlighted at all; it's now in the new keywords list, alongside import in imports. Both map to the same Keyword attribute as the lists beside them. The <language>version is bumped 01, per KDE's contributing note ("If you are modifying an existing syntax definition XML file, you must increase the version number of the language").

CotEditor and the playground keep their existing groupings — both already carried prql on a keyword list.

Testing

No automated coverage exists for these grammars (#2052 tracks that), so verification is structural: both XML files parse, every style the GtkSourceView file declares is now referenced by a context, the CotEditor YAML parses to the expected 20-entry keyword list, and prettier passes on the JS and YAML.

Found during the nightly rolling survey of grammars/GtkSourceView/prql.lang and web/playground/src/workbench/monaco-theme.json.

@prql-botprql-bot left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two observations on the grammar files, one of which means the PR doesn't quite reach its own goal.

prql still isn't highlighted in the KSyntaxHighlighting grammar. The new comment says "prql is a built-in module", but the modules_builtin list holding it isn't referenced by any context — the only keyword rules in the Normal context are types, specialvars, builtinfuncs, declarations, letExpressions, imports and the newly-added keywords (date_functions, text_functions and durations are orphaned the same way). So prql renders as a plain identifier in Kate, and the comment points the next person checking for drift at a list that does nothing. The inline suggestion adds it to the new keywords list; the alternative — referencing modules_builtin from Normal — needs a new itemData and would be shadowed for date/text, which the types rule already claims a few lines earlier.

In GtkSourceView all nine land on style-ref="declaration", which maps to def:type.func, case, into and import will render in the same colour as int and timestamp, while the file declares <style id="keyword" … map-to="def:keyword"/> that nothing references (grep style-ref= prql.lang returns every style except keyword). The other three grammars here put these tokens on a keyword token/attribute, and emacs' prql-other-keywords — the same ten — uses font-lock-keyword-face. A second context styled keyword, mirroring the new keywords list this PR adds on the KSyntaxHighlighting side, would be more consistent; whether let/type/module move with it is a styling call, so leaving it rather than pushing one.

Two smaller things:

  • prql.xml still carries version="0", unchanged since the file was added, and this is the first content change to it. I believe KSyntaxHighlighting selects among duplicate definitions of a language by that attribute, so it's conventionally incremented on each edit — I couldn't reach docs.kde.org from CI to confirm the exact rule, hence flagging rather than suggesting.
  • Four grammars drifted simultaneously here. The sync comments make the next drift easier to spot but nothing fails when it happens, and test-grammars only covers lezer and raku. keyword() spells its ten out inline; lifting them into a const would let a small test assert each grammar file mentions each keyword — cheap coverage for the part of #2052 that bit here.

Comment threadgrammars/KSyntaxHighlighting/prql.xml
`prql` sat in the `modules_builtin` list, which no context references, so
it rendered as a plain identifier.
@prql-bot

Copy link
Copy Markdown
CollaboratorAuthor

Thanks — both grammar points were real; pushed 2e54e6a and 9ebdbf3.

GtkSourceView styling. Made the call and moved all ten onto keyword: the declarations context is now keywords, style-ref="keyword", the unreferenced declaration style is dropped, and prql moves out of built-in-object into it. That matches emacs (prql-other-keywordsfont-lock-keyword-face), nano (one color yellow line for the same ten) and KSyntaxHighlighting (every keyword list → the Keyword attribute), so all five grammars now put the lexer's keywords on one face. Every style the file declares is referenced by a context again, which is what flagged the problem in the first place.

version="0". Confirmed and bumped to 1 — KDE's contributing notes say "If you are modifying an existing syntax definition XML file, you must increase the version number of the language." (docs.kde.org is unreachable from CI, but the repo README is fetchable via the API.)

A drift test. Agreed it's the right fix for the class of bug, but it's independently revertable from this PR and I'm at five open PRs, so noting the shape here rather than opening a sixth: lift the ten just(..) arms in keyword() into a pub const KEYWORDS: [&str; 10], drive the parser from it, and assert in a test that each grammar file under grammars/ carrying a keyword list, plus web/playground/src/workbench/prql-syntax.js, contains every entry. A substring check over the file text is crude but is exactly the assertion that would have failed here, and it needs no per-format parser. #2052 is the tracking issue.

Not addressed: modules_builtin, date_functions, text_functions and durations in prql.xml are all orphaned lists no context references — pre-existing, and untangling them means new itemData entries and resolving the shadowing against types.

@max-sixty
max-sixty merged commit 7c3ed1a into mainAug 19, 2026
39 checks passed
@max-sixty
max-sixty deleted the docs/grammar-keyword-sync branch August 19, 2026 13:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@prql-bot@max-sixty
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' docs: highlight all lexer keywords in the playground and in-repo grammars by prql-bot · Pull Request #6210 · PRQL/prql · GitHub
Skip to content

docs: highlight all lexer keywords in the playground and in-repo grammars - #6210

Merged
max-sixty merged 3 commits into
mainfrom
docs/grammar-keyword-sync
Aug 19, 2026
Merged

docs: highlight all lexer keywords in the playground and in-repo grammars#6210
max-sixty merged 3 commits into
mainfrom
docs/grammar-keyword-sync

Conversation

@prql-bot

@prql-botprql-bot commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Problem

#6207 brought the two Handlebars/highlight.js keyword lists in line with the lexer's keyword parser, but the same drift remains in the grammars this repo ships. Against the ten keywords the lexer defines (let, into, case, prql, type, module, internal, func, import, enum):

GrammarMissing
web/playground/src/workbench/prql-syntax.js (Monarch)into, type, module, internal, func, import, enum
grammars/GtkSourceView/prql.langinto, case, type, module, internal, func, import, enum
grammars/CotEditor/PRQL.yamlinto, type, internal, func, import, enum
grammars/KSyntaxHighlighting/prql.xmlinto, case, internal, func, import, enum

The playground one is the most visible: module, type and into render as plain identifiers on prql-lang.org today. The emacs and nano grammars already carry the full set, so they're untouched.

Solution

Add the missing entries to each keyword list, with the same "keep in sync with the lexer" comment #6207 added, so the next drift is easier to spot.

Two grammars also needed their styling adjusting so the added keywords actually render as keywords:

  • GtkSourceView had a single declarations context (style-ref="declaration", which maps to def:type), so func/case/into/import would have rendered in the same colour as int and timestamp, while the file's keyword style — mapping to def:keyword — was declared but referenced by nothing. That context is now keywords, styled keyword, holding all ten; the unused declaration style is dropped. prql moves out of built-in-object into it, which brings the file in line with emacs (prql-other-keywordsfont-lock-keyword-face), nano and KSyntaxHighlighting, all of which put the same ten on one keyword face.
  • KSyntaxHighlighting holds prql in a modules_builtin list that no context references, so it wasn't highlighted at all; it's now in the new keywords list, alongside import in imports. Both map to the same Keyword attribute as the lists beside them. The <language>version is bumped 01, per KDE's contributing note ("If you are modifying an existing syntax definition XML file, you must increase the version number of the language").

CotEditor and the playground keep their existing groupings — both already carried prql on a keyword list.

Testing

No automated coverage exists for these grammars (#2052 tracks that), so verification is structural: both XML files parse, every style the GtkSourceView file declares is now referenced by a context, the CotEditor YAML parses to the expected 20-entry keyword list, and prettier passes on the JS and YAML.

Found during the nightly rolling survey of grammars/GtkSourceView/prql.lang and web/playground/src/workbench/monaco-theme.json.

@prql-botprql-bot left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two observations on the grammar files, one of which means the PR doesn't quite reach its own goal.

prql still isn't highlighted in the KSyntaxHighlighting grammar. The new comment says "prql is a built-in module", but the modules_builtin list holding it isn't referenced by any context — the only keyword rules in the Normal context are types, specialvars, builtinfuncs, declarations, letExpressions, imports and the newly-added keywords (date_functions, text_functions and durations are orphaned the same way). So prql renders as a plain identifier in Kate, and the comment points the next person checking for drift at a list that does nothing. The inline suggestion adds it to the new keywords list; the alternative — referencing modules_builtin from Normal — needs a new itemData and would be shadowed for date/text, which the types rule already claims a few lines earlier.

In GtkSourceView all nine land on style-ref="declaration", which maps to def:type.func, case, into and import will render in the same colour as int and timestamp, while the file declares <style id="keyword" … map-to="def:keyword"/> that nothing references (grep style-ref= prql.lang returns every style except keyword). The other three grammars here put these tokens on a keyword token/attribute, and emacs' prql-other-keywords — the same ten — uses font-lock-keyword-face. A second context styled keyword, mirroring the new keywords list this PR adds on the KSyntaxHighlighting side, would be more consistent; whether let/type/module move with it is a styling call, so leaving it rather than pushing one.

Two smaller things:

  • prql.xml still carries version="0", unchanged since the file was added, and this is the first content change to it. I believe KSyntaxHighlighting selects among duplicate definitions of a language by that attribute, so it's conventionally incremented on each edit — I couldn't reach docs.kde.org from CI to confirm the exact rule, hence flagging rather than suggesting.
  • Four grammars drifted simultaneously here. The sync comments make the next drift easier to spot but nothing fails when it happens, and test-grammars only covers lezer and raku. keyword() spells its ten out inline; lifting them into a const would let a small test assert each grammar file mentions each keyword — cheap coverage for the part of #2052 that bit here.

Comment threadgrammars/KSyntaxHighlighting/prql.xml
`prql` sat in the `modules_builtin` list, which no context references, so
it rendered as a plain identifier.
@prql-bot

Copy link
Copy Markdown
CollaboratorAuthor

Thanks — both grammar points were real; pushed 2e54e6a and 9ebdbf3.

GtkSourceView styling. Made the call and moved all ten onto keyword: the declarations context is now keywords, style-ref="keyword", the unreferenced declaration style is dropped, and prql moves out of built-in-object into it. That matches emacs (prql-other-keywordsfont-lock-keyword-face), nano (one color yellow line for the same ten) and KSyntaxHighlighting (every keyword list → the Keyword attribute), so all five grammars now put the lexer's keywords on one face. Every style the file declares is referenced by a context again, which is what flagged the problem in the first place.

version="0". Confirmed and bumped to 1 — KDE's contributing notes say "If you are modifying an existing syntax definition XML file, you must increase the version number of the language." (docs.kde.org is unreachable from CI, but the repo README is fetchable via the API.)

A drift test. Agreed it's the right fix for the class of bug, but it's independently revertable from this PR and I'm at five open PRs, so noting the shape here rather than opening a sixth: lift the ten just(..) arms in keyword() into a pub const KEYWORDS: [&str; 10], drive the parser from it, and assert in a test that each grammar file under grammars/ carrying a keyword list, plus web/playground/src/workbench/prql-syntax.js, contains every entry. A substring check over the file text is crude but is exactly the assertion that would have failed here, and it needs no per-format parser. #2052 is the tracking issue.

Not addressed: modules_builtin, date_functions, text_functions and durations in prql.xml are all orphaned lists no context references — pre-existing, and untangling them means new itemData entries and resolving the shadowing against types.

@max-sixty
max-sixty merged commit 7c3ed1a into mainAug 19, 2026
39 checks passed
@max-sixty
max-sixty deleted the docs/grammar-keyword-sync branch August 19, 2026 13:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@prql-bot@max-sixty
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' docs: highlight all lexer keywords in the playground and in-repo grammars by prql-bot · Pull Request #6210 · PRQL/prql · GitHub
Skip to content

docs: highlight all lexer keywords in the playground and in-repo grammars - #6210

Merged
max-sixty merged 3 commits into
mainfrom
docs/grammar-keyword-sync
Aug 19, 2026
Merged

docs: highlight all lexer keywords in the playground and in-repo grammars#6210
max-sixty merged 3 commits into
mainfrom
docs/grammar-keyword-sync

Conversation

@prql-bot

@prql-botprql-bot commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Problem

#6207 brought the two Handlebars/highlight.js keyword lists in line with the lexer's keyword parser, but the same drift remains in the grammars this repo ships. Against the ten keywords the lexer defines (let, into, case, prql, type, module, internal, func, import, enum):

GrammarMissing
web/playground/src/workbench/prql-syntax.js (Monarch)into, type, module, internal, func, import, enum
grammars/GtkSourceView/prql.langinto, case, type, module, internal, func, import, enum
grammars/CotEditor/PRQL.yamlinto, type, internal, func, import, enum
grammars/KSyntaxHighlighting/prql.xmlinto, case, internal, func, import, enum

The playground one is the most visible: module, type and into render as plain identifiers on prql-lang.org today. The emacs and nano grammars already carry the full set, so they're untouched.

Solution

Add the missing entries to each keyword list, with the same "keep in sync with the lexer" comment #6207 added, so the next drift is easier to spot.

Two grammars also needed their styling adjusting so the added keywords actually render as keywords:

  • GtkSourceView had a single declarations context (style-ref="declaration", which maps to def:type), so func/case/into/import would have rendered in the same colour as int and timestamp, while the file's keyword style — mapping to def:keyword — was declared but referenced by nothing. That context is now keywords, styled keyword, holding all ten; the unused declaration style is dropped. prql moves out of built-in-object into it, which brings the file in line with emacs (prql-other-keywordsfont-lock-keyword-face), nano and KSyntaxHighlighting, all of which put the same ten on one keyword face.
  • KSyntaxHighlighting holds prql in a modules_builtin list that no context references, so it wasn't highlighted at all; it's now in the new keywords list, alongside import in imports. Both map to the same Keyword attribute as the lists beside them. The <language>version is bumped 01, per KDE's contributing note ("If you are modifying an existing syntax definition XML file, you must increase the version number of the language").

CotEditor and the playground keep their existing groupings — both already carried prql on a keyword list.

Testing

No automated coverage exists for these grammars (#2052 tracks that), so verification is structural: both XML files parse, every style the GtkSourceView file declares is now referenced by a context, the CotEditor YAML parses to the expected 20-entry keyword list, and prettier passes on the JS and YAML.

Found during the nightly rolling survey of grammars/GtkSourceView/prql.lang and web/playground/src/workbench/monaco-theme.json.

@prql-botprql-bot left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two observations on the grammar files, one of which means the PR doesn't quite reach its own goal.

prql still isn't highlighted in the KSyntaxHighlighting grammar. The new comment says "prql is a built-in module", but the modules_builtin list holding it isn't referenced by any context — the only keyword rules in the Normal context are types, specialvars, builtinfuncs, declarations, letExpressions, imports and the newly-added keywords (date_functions, text_functions and durations are orphaned the same way). So prql renders as a plain identifier in Kate, and the comment points the next person checking for drift at a list that does nothing. The inline suggestion adds it to the new keywords list; the alternative — referencing modules_builtin from Normal — needs a new itemData and would be shadowed for date/text, which the types rule already claims a few lines earlier.

In GtkSourceView all nine land on style-ref="declaration", which maps to def:type.func, case, into and import will render in the same colour as int and timestamp, while the file declares <style id="keyword" … map-to="def:keyword"/> that nothing references (grep style-ref= prql.lang returns every style except keyword). The other three grammars here put these tokens on a keyword token/attribute, and emacs' prql-other-keywords — the same ten — uses font-lock-keyword-face. A second context styled keyword, mirroring the new keywords list this PR adds on the KSyntaxHighlighting side, would be more consistent; whether let/type/module move with it is a styling call, so leaving it rather than pushing one.

Two smaller things:

  • prql.xml still carries version="0", unchanged since the file was added, and this is the first content change to it. I believe KSyntaxHighlighting selects among duplicate definitions of a language by that attribute, so it's conventionally incremented on each edit — I couldn't reach docs.kde.org from CI to confirm the exact rule, hence flagging rather than suggesting.
  • Four grammars drifted simultaneously here. The sync comments make the next drift easier to spot but nothing fails when it happens, and test-grammars only covers lezer and raku. keyword() spells its ten out inline; lifting them into a const would let a small test assert each grammar file mentions each keyword — cheap coverage for the part of #2052 that bit here.

Comment threadgrammars/KSyntaxHighlighting/prql.xml
`prql` sat in the `modules_builtin` list, which no context references, so
it rendered as a plain identifier.
@prql-bot

Copy link
Copy Markdown
CollaboratorAuthor

Thanks — both grammar points were real; pushed 2e54e6a and 9ebdbf3.

GtkSourceView styling. Made the call and moved all ten onto keyword: the declarations context is now keywords, style-ref="keyword", the unreferenced declaration style is dropped, and prql moves out of built-in-object into it. That matches emacs (prql-other-keywordsfont-lock-keyword-face), nano (one color yellow line for the same ten) and KSyntaxHighlighting (every keyword list → the Keyword attribute), so all five grammars now put the lexer's keywords on one face. Every style the file declares is referenced by a context again, which is what flagged the problem in the first place.

version="0". Confirmed and bumped to 1 — KDE's contributing notes say "If you are modifying an existing syntax definition XML file, you must increase the version number of the language." (docs.kde.org is unreachable from CI, but the repo README is fetchable via the API.)

A drift test. Agreed it's the right fix for the class of bug, but it's independently revertable from this PR and I'm at five open PRs, so noting the shape here rather than opening a sixth: lift the ten just(..) arms in keyword() into a pub const KEYWORDS: [&str; 10], drive the parser from it, and assert in a test that each grammar file under grammars/ carrying a keyword list, plus web/playground/src/workbench/prql-syntax.js, contains every entry. A substring check over the file text is crude but is exactly the assertion that would have failed here, and it needs no per-format parser. #2052 is the tracking issue.

Not addressed: modules_builtin, date_functions, text_functions and durations in prql.xml are all orphaned lists no context references — pre-existing, and untangling them means new itemData entries and resolving the shadowing against types.

@max-sixty
max-sixty merged commit 7c3ed1a into mainAug 19, 2026
39 checks passed
@max-sixty
max-sixty deleted the docs/grammar-keyword-sync branch August 19, 2026 13:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@prql-bot@max-sixty
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' docs: highlight all lexer keywords in the playground and in-repo grammars by prql-bot · Pull Request #6210 · PRQL/prql · GitHub
Skip to content

docs: highlight all lexer keywords in the playground and in-repo grammars - #6210

Merged
max-sixty merged 3 commits into
mainfrom
docs/grammar-keyword-sync
Aug 19, 2026
Merged

docs: highlight all lexer keywords in the playground and in-repo grammars#6210
max-sixty merged 3 commits into
mainfrom
docs/grammar-keyword-sync

Conversation

@prql-bot

@prql-botprql-bot commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Problem

#6207 brought the two Handlebars/highlight.js keyword lists in line with the lexer's keyword parser, but the same drift remains in the grammars this repo ships. Against the ten keywords the lexer defines (let, into, case, prql, type, module, internal, func, import, enum):

GrammarMissing
web/playground/src/workbench/prql-syntax.js (Monarch)into, type, module, internal, func, import, enum
grammars/GtkSourceView/prql.langinto, case, type, module, internal, func, import, enum
grammars/CotEditor/PRQL.yamlinto, type, internal, func, import, enum
grammars/KSyntaxHighlighting/prql.xmlinto, case, internal, func, import, enum

The playground one is the most visible: module, type and into render as plain identifiers on prql-lang.org today. The emacs and nano grammars already carry the full set, so they're untouched.

Solution

Add the missing entries to each keyword list, with the same "keep in sync with the lexer" comment #6207 added, so the next drift is easier to spot.

Two grammars also needed their styling adjusting so the added keywords actually render as keywords:

  • GtkSourceView had a single declarations context (style-ref="declaration", which maps to def:type), so func/case/into/import would have rendered in the same colour as int and timestamp, while the file's keyword style — mapping to def:keyword — was declared but referenced by nothing. That context is now keywords, styled keyword, holding all ten; the unused declaration style is dropped. prql moves out of built-in-object into it, which brings the file in line with emacs (prql-other-keywordsfont-lock-keyword-face), nano and KSyntaxHighlighting, all of which put the same ten on one keyword face.
  • KSyntaxHighlighting holds prql in a modules_builtin list that no context references, so it wasn't highlighted at all; it's now in the new keywords list, alongside import in imports. Both map to the same Keyword attribute as the lists beside them. The <language>version is bumped 01, per KDE's contributing note ("If you are modifying an existing syntax definition XML file, you must increase the version number of the language").

CotEditor and the playground keep their existing groupings — both already carried prql on a keyword list.

Testing

No automated coverage exists for these grammars (#2052 tracks that), so verification is structural: both XML files parse, every style the GtkSourceView file declares is now referenced by a context, the CotEditor YAML parses to the expected 20-entry keyword list, and prettier passes on the JS and YAML.

Found during the nightly rolling survey of grammars/GtkSourceView/prql.lang and web/playground/src/workbench/monaco-theme.json.

@prql-botprql-bot left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two observations on the grammar files, one of which means the PR doesn't quite reach its own goal.

prql still isn't highlighted in the KSyntaxHighlighting grammar. The new comment says "prql is a built-in module", but the modules_builtin list holding it isn't referenced by any context — the only keyword rules in the Normal context are types, specialvars, builtinfuncs, declarations, letExpressions, imports and the newly-added keywords (date_functions, text_functions and durations are orphaned the same way). So prql renders as a plain identifier in Kate, and the comment points the next person checking for drift at a list that does nothing. The inline suggestion adds it to the new keywords list; the alternative — referencing modules_builtin from Normal — needs a new itemData and would be shadowed for date/text, which the types rule already claims a few lines earlier.

In GtkSourceView all nine land on style-ref="declaration", which maps to def:type.func, case, into and import will render in the same colour as int and timestamp, while the file declares <style id="keyword" … map-to="def:keyword"/> that nothing references (grep style-ref= prql.lang returns every style except keyword). The other three grammars here put these tokens on a keyword token/attribute, and emacs' prql-other-keywords — the same ten — uses font-lock-keyword-face. A second context styled keyword, mirroring the new keywords list this PR adds on the KSyntaxHighlighting side, would be more consistent; whether let/type/module move with it is a styling call, so leaving it rather than pushing one.

Two smaller things:

  • prql.xml still carries version="0", unchanged since the file was added, and this is the first content change to it. I believe KSyntaxHighlighting selects among duplicate definitions of a language by that attribute, so it's conventionally incremented on each edit — I couldn't reach docs.kde.org from CI to confirm the exact rule, hence flagging rather than suggesting.
  • Four grammars drifted simultaneously here. The sync comments make the next drift easier to spot but nothing fails when it happens, and test-grammars only covers lezer and raku. keyword() spells its ten out inline; lifting them into a const would let a small test assert each grammar file mentions each keyword — cheap coverage for the part of #2052 that bit here.

Comment threadgrammars/KSyntaxHighlighting/prql.xml
`prql` sat in the `modules_builtin` list, which no context references, so
it rendered as a plain identifier.
@prql-bot

Copy link
Copy Markdown
CollaboratorAuthor

Thanks — both grammar points were real; pushed 2e54e6a and 9ebdbf3.

GtkSourceView styling. Made the call and moved all ten onto keyword: the declarations context is now keywords, style-ref="keyword", the unreferenced declaration style is dropped, and prql moves out of built-in-object into it. That matches emacs (prql-other-keywordsfont-lock-keyword-face), nano (one color yellow line for the same ten) and KSyntaxHighlighting (every keyword list → the Keyword attribute), so all five grammars now put the lexer's keywords on one face. Every style the file declares is referenced by a context again, which is what flagged the problem in the first place.

version="0". Confirmed and bumped to 1 — KDE's contributing notes say "If you are modifying an existing syntax definition XML file, you must increase the version number of the language." (docs.kde.org is unreachable from CI, but the repo README is fetchable via the API.)

A drift test. Agreed it's the right fix for the class of bug, but it's independently revertable from this PR and I'm at five open PRs, so noting the shape here rather than opening a sixth: lift the ten just(..) arms in keyword() into a pub const KEYWORDS: [&str; 10], drive the parser from it, and assert in a test that each grammar file under grammars/ carrying a keyword list, plus web/playground/src/workbench/prql-syntax.js, contains every entry. A substring check over the file text is crude but is exactly the assertion that would have failed here, and it needs no per-format parser. #2052 is the tracking issue.

Not addressed: modules_builtin, date_functions, text_functions and durations in prql.xml are all orphaned lists no context references — pre-existing, and untangling them means new itemData entries and resolving the shadowing against types.

@max-sixty
max-sixty merged commit 7c3ed1a into mainAug 19, 2026
39 checks passed
@max-sixty
max-sixty deleted the docs/grammar-keyword-sync branch August 19, 2026 13:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@prql-bot@max-sixty
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' docs: highlight all lexer keywords in the playground and in-repo grammars by prql-bot · Pull Request #6210 · PRQL/prql · GitHub
Skip to content

docs: highlight all lexer keywords in the playground and in-repo grammars - #6210

Merged
max-sixty merged 3 commits into
mainfrom
docs/grammar-keyword-sync
Aug 19, 2026
Merged

docs: highlight all lexer keywords in the playground and in-repo grammars#6210
max-sixty merged 3 commits into
mainfrom
docs/grammar-keyword-sync

Conversation

@prql-bot

@prql-botprql-bot commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Problem

#6207 brought the two Handlebars/highlight.js keyword lists in line with the lexer's keyword parser, but the same drift remains in the grammars this repo ships. Against the ten keywords the lexer defines (let, into, case, prql, type, module, internal, func, import, enum):

GrammarMissing
web/playground/src/workbench/prql-syntax.js (Monarch)into, type, module, internal, func, import, enum
grammars/GtkSourceView/prql.langinto, case, type, module, internal, func, import, enum
grammars/CotEditor/PRQL.yamlinto, type, internal, func, import, enum
grammars/KSyntaxHighlighting/prql.xmlinto, case, internal, func, import, enum

The playground one is the most visible: module, type and into render as plain identifiers on prql-lang.org today. The emacs and nano grammars already carry the full set, so they're untouched.

Solution

Add the missing entries to each keyword list, with the same "keep in sync with the lexer" comment #6207 added, so the next drift is easier to spot.

Two grammars also needed their styling adjusting so the added keywords actually render as keywords:

  • GtkSourceView had a single declarations context (style-ref="declaration", which maps to def:type), so func/case/into/import would have rendered in the same colour as int and timestamp, while the file's keyword style — mapping to def:keyword — was declared but referenced by nothing. That context is now keywords, styled keyword, holding all ten; the unused declaration style is dropped. prql moves out of built-in-object into it, which brings the file in line with emacs (prql-other-keywordsfont-lock-keyword-face), nano and KSyntaxHighlighting, all of which put the same ten on one keyword face.
  • KSyntaxHighlighting holds prql in a modules_builtin list that no context references, so it wasn't highlighted at all; it's now in the new keywords list, alongside import in imports. Both map to the same Keyword attribute as the lists beside them. The <language>version is bumped 01, per KDE's contributing note ("If you are modifying an existing syntax definition XML file, you must increase the version number of the language").

CotEditor and the playground keep their existing groupings — both already carried prql on a keyword list.

Testing

No automated coverage exists for these grammars (#2052 tracks that), so verification is structural: both XML files parse, every style the GtkSourceView file declares is now referenced by a context, the CotEditor YAML parses to the expected 20-entry keyword list, and prettier passes on the JS and YAML.

Found during the nightly rolling survey of grammars/GtkSourceView/prql.lang and web/playground/src/workbench/monaco-theme.json.

@prql-botprql-bot left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two observations on the grammar files, one of which means the PR doesn't quite reach its own goal.

prql still isn't highlighted in the KSyntaxHighlighting grammar. The new comment says "prql is a built-in module", but the modules_builtin list holding it isn't referenced by any context — the only keyword rules in the Normal context are types, specialvars, builtinfuncs, declarations, letExpressions, imports and the newly-added keywords (date_functions, text_functions and durations are orphaned the same way). So prql renders as a plain identifier in Kate, and the comment points the next person checking for drift at a list that does nothing. The inline suggestion adds it to the new keywords list; the alternative — referencing modules_builtin from Normal — needs a new itemData and would be shadowed for date/text, which the types rule already claims a few lines earlier.

In GtkSourceView all nine land on style-ref="declaration", which maps to def:type.func, case, into and import will render in the same colour as int and timestamp, while the file declares <style id="keyword" … map-to="def:keyword"/> that nothing references (grep style-ref= prql.lang returns every style except keyword). The other three grammars here put these tokens on a keyword token/attribute, and emacs' prql-other-keywords — the same ten — uses font-lock-keyword-face. A second context styled keyword, mirroring the new keywords list this PR adds on the KSyntaxHighlighting side, would be more consistent; whether let/type/module move with it is a styling call, so leaving it rather than pushing one.

Two smaller things:

  • prql.xml still carries version="0", unchanged since the file was added, and this is the first content change to it. I believe KSyntaxHighlighting selects among duplicate definitions of a language by that attribute, so it's conventionally incremented on each edit — I couldn't reach docs.kde.org from CI to confirm the exact rule, hence flagging rather than suggesting.
  • Four grammars drifted simultaneously here. The sync comments make the next drift easier to spot but nothing fails when it happens, and test-grammars only covers lezer and raku. keyword() spells its ten out inline; lifting them into a const would let a small test assert each grammar file mentions each keyword — cheap coverage for the part of #2052 that bit here.

Comment threadgrammars/KSyntaxHighlighting/prql.xml
`prql` sat in the `modules_builtin` list, which no context references, so
it rendered as a plain identifier.
@prql-bot

Copy link
Copy Markdown
CollaboratorAuthor

Thanks — both grammar points were real; pushed 2e54e6a and 9ebdbf3.

GtkSourceView styling. Made the call and moved all ten onto keyword: the declarations context is now keywords, style-ref="keyword", the unreferenced declaration style is dropped, and prql moves out of built-in-object into it. That matches emacs (prql-other-keywordsfont-lock-keyword-face), nano (one color yellow line for the same ten) and KSyntaxHighlighting (every keyword list → the Keyword attribute), so all five grammars now put the lexer's keywords on one face. Every style the file declares is referenced by a context again, which is what flagged the problem in the first place.

version="0". Confirmed and bumped to 1 — KDE's contributing notes say "If you are modifying an existing syntax definition XML file, you must increase the version number of the language." (docs.kde.org is unreachable from CI, but the repo README is fetchable via the API.)

A drift test. Agreed it's the right fix for the class of bug, but it's independently revertable from this PR and I'm at five open PRs, so noting the shape here rather than opening a sixth: lift the ten just(..) arms in keyword() into a pub const KEYWORDS: [&str; 10], drive the parser from it, and assert in a test that each grammar file under grammars/ carrying a keyword list, plus web/playground/src/workbench/prql-syntax.js, contains every entry. A substring check over the file text is crude but is exactly the assertion that would have failed here, and it needs no per-format parser. #2052 is the tracking issue.

Not addressed: modules_builtin, date_functions, text_functions and durations in prql.xml are all orphaned lists no context references — pre-existing, and untangling them means new itemData entries and resolving the shadowing against types.

@max-sixty
max-sixty merged commit 7c3ed1a into mainAug 19, 2026
39 checks passed
@max-sixty
max-sixty deleted the docs/grammar-keyword-sync branch August 19, 2026 13:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@prql-bot@max-sixty
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); docs: highlight all lexer keywords in the playground and in-repo grammars by prql-bot · Pull Request #6210 · PRQL/prql · GitHub
Skip to content

docs: highlight all lexer keywords in the playground and in-repo grammars - #6210

Merged
max-sixty merged 3 commits into
mainfrom
docs/grammar-keyword-sync
Aug 19, 2026
Merged

docs: highlight all lexer keywords in the playground and in-repo grammars#6210
max-sixty merged 3 commits into
mainfrom
docs/grammar-keyword-sync

Conversation

@prql-bot

@prql-botprql-bot commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Problem

#6207 brought the two Handlebars/highlight.js keyword lists in line with the lexer's keyword parser, but the same drift remains in the grammars this repo ships. Against the ten keywords the lexer defines (let, into, case, prql, type, module, internal, func, import, enum):

GrammarMissing
web/playground/src/workbench/prql-syntax.js (Monarch)into, type, module, internal, func, import, enum
grammars/GtkSourceView/prql.langinto, case, type, module, internal, func, import, enum
grammars/CotEditor/PRQL.yamlinto, type, internal, func, import, enum
grammars/KSyntaxHighlighting/prql.xmlinto, case, internal, func, import, enum

The playground one is the most visible: module, type and into render as plain identifiers on prql-lang.org today. The emacs and nano grammars already carry the full set, so they're untouched.

Solution

Add the missing entries to each keyword list, with the same "keep in sync with the lexer" comment #6207 added, so the next drift is easier to spot.

Two grammars also needed their styling adjusting so the added keywords actually render as keywords:

  • GtkSourceView had a single declarations context (style-ref="declaration", which maps to def:type), so func/case/into/import would have rendered in the same colour as int and timestamp, while the file's keyword style — mapping to def:keyword — was declared but referenced by nothing. That context is now keywords, styled keyword, holding all ten; the unused declaration style is dropped. prql moves out of built-in-object into it, which brings the file in line with emacs (prql-other-keywordsfont-lock-keyword-face), nano and KSyntaxHighlighting, all of which put the same ten on one keyword face.
  • KSyntaxHighlighting holds prql in a modules_builtin list that no context references, so it wasn't highlighted at all; it's now in the new keywords list, alongside import in imports. Both map to the same Keyword attribute as the lists beside them. The <language>version is bumped 01, per KDE's contributing note ("If you are modifying an existing syntax definition XML file, you must increase the version number of the language").

CotEditor and the playground keep their existing groupings — both already carried prql on a keyword list.

Testing

No automated coverage exists for these grammars (#2052 tracks that), so verification is structural: both XML files parse, every style the GtkSourceView file declares is now referenced by a context, the CotEditor YAML parses to the expected 20-entry keyword list, and prettier passes on the JS and YAML.

Found during the nightly rolling survey of grammars/GtkSourceView/prql.lang and web/playground/src/workbench/monaco-theme.json.

@prql-botprql-bot left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two observations on the grammar files, one of which means the PR doesn't quite reach its own goal.

prql still isn't highlighted in the KSyntaxHighlighting grammar. The new comment says "prql is a built-in module", but the modules_builtin list holding it isn't referenced by any context — the only keyword rules in the Normal context are types, specialvars, builtinfuncs, declarations, letExpressions, imports and the newly-added keywords (date_functions, text_functions and durations are orphaned the same way). So prql renders as a plain identifier in Kate, and the comment points the next person checking for drift at a list that does nothing. The inline suggestion adds it to the new keywords list; the alternative — referencing modules_builtin from Normal — needs a new itemData and would be shadowed for date/text, which the types rule already claims a few lines earlier.

In GtkSourceView all nine land on style-ref="declaration", which maps to def:type.func, case, into and import will render in the same colour as int and timestamp, while the file declares <style id="keyword" … map-to="def:keyword"/> that nothing references (grep style-ref= prql.lang returns every style except keyword). The other three grammars here put these tokens on a keyword token/attribute, and emacs' prql-other-keywords — the same ten — uses font-lock-keyword-face. A second context styled keyword, mirroring the new keywords list this PR adds on the KSyntaxHighlighting side, would be more consistent; whether let/type/module move with it is a styling call, so leaving it rather than pushing one.

Two smaller things:

  • prql.xml still carries version="0", unchanged since the file was added, and this is the first content change to it. I believe KSyntaxHighlighting selects among duplicate definitions of a language by that attribute, so it's conventionally incremented on each edit — I couldn't reach docs.kde.org from CI to confirm the exact rule, hence flagging rather than suggesting.
  • Four grammars drifted simultaneously here. The sync comments make the next drift easier to spot but nothing fails when it happens, and test-grammars only covers lezer and raku. keyword() spells its ten out inline; lifting them into a const would let a small test assert each grammar file mentions each keyword — cheap coverage for the part of #2052 that bit here.

Comment threadgrammars/KSyntaxHighlighting/prql.xml
`prql` sat in the `modules_builtin` list, which no context references, so
it rendered as a plain identifier.
@prql-bot

Copy link
Copy Markdown
CollaboratorAuthor

Thanks — both grammar points were real; pushed 2e54e6a and 9ebdbf3.

GtkSourceView styling. Made the call and moved all ten onto keyword: the declarations context is now keywords, style-ref="keyword", the unreferenced declaration style is dropped, and prql moves out of built-in-object into it. That matches emacs (prql-other-keywordsfont-lock-keyword-face), nano (one color yellow line for the same ten) and KSyntaxHighlighting (every keyword list → the Keyword attribute), so all five grammars now put the lexer's keywords on one face. Every style the file declares is referenced by a context again, which is what flagged the problem in the first place.

version="0". Confirmed and bumped to 1 — KDE's contributing notes say "If you are modifying an existing syntax definition XML file, you must increase the version number of the language." (docs.kde.org is unreachable from CI, but the repo README is fetchable via the API.)

A drift test. Agreed it's the right fix for the class of bug, but it's independently revertable from this PR and I'm at five open PRs, so noting the shape here rather than opening a sixth: lift the ten just(..) arms in keyword() into a pub const KEYWORDS: [&str; 10], drive the parser from it, and assert in a test that each grammar file under grammars/ carrying a keyword list, plus web/playground/src/workbench/prql-syntax.js, contains every entry. A substring check over the file text is crude but is exactly the assertion that would have failed here, and it needs no per-format parser. #2052 is the tracking issue.

Not addressed: modules_builtin, date_functions, text_functions and durations in prql.xml are all orphaned lists no context references — pre-existing, and untangling them means new itemData entries and resolving the shadowing against types.

@max-sixty
max-sixty merged commit 7c3ed1a into mainAug 19, 2026
39 checks passed
@max-sixty
max-sixty deleted the docs/grammar-keyword-sync branch August 19, 2026 13:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@prql-bot@max-sixty