Skip to content

fix: Supporting syntax highlighting for TOML-formatted values when viewing KV in the Consul GUI #23131

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

Open
majiayu000 wants to merge 3 commits into
base: main
Choose a base branch
from
+150 −32
Open

fix: Supporting syntax highlighting for TOML-formatted values when viewing KV in the Consul GUI #23131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dc78e65
ui: Add TOML syntax highlighting support for KV editor
majiayu000 Dec 28, 2025
25b8078
fix: reorder KV format options and add XML
majiayu000 Jan 9, 2026
98ac0c0
fix: complete KV TOML support
majiayu000 Jan 9, 2026
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
117 changes: 86 additions & 31 deletions ui/packages/consul-ui/app/components/consul/kv/form/index.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,41 +37,96 @@
<Hds::Layout::Flex @direction='column' as |LF|>

<LF.Item style='align-self: flex-end;'>
<Hds::Form::Toggle::Field
name='json'
checked={{if this.json 'checked'}}
{{on 'change' api.change}}
as |F|
>
<F.Label>Code</F.Label>
</Hds::Form::Toggle::Field>
<Hds::Layout::Flex @gap='16' @align='center' as |F|>
{{#if this.json}}
<F.Item>
<Hds::Form::Select::Field
name='language'
@width='150px'
{{on 'change' api.change}}
as |S|
>
<S.Label>Format</S.Label>
<S.Options>
{{#each this.languages as |lang|}}
<option value={{lang.value}} selected={{eq this.language lang.value}}>
{{lang.label}}
</option>
{{/each}}
</S.Options>
</Hds::Form::Select::Field>
</F.Item>
{{/if}}
<F.Item>
<Hds::Form::Toggle::Field
name='json'
checked={{if this.json 'checked'}}
{{on 'change' api.change}}
as |F|
>
<F.Label>Code</F.Label>
</Hds::Form::Toggle::Field>
</F.Item>
</Hds::Layout::Flex>
</LF.Item>
<label for='' class='type-text{{if api.data.error.Value " has-error"}}'>
{{#if this.json}}
{{#if (or disabld api.disabled)}}
<Hds::CodeBlock
@language='bash'
@value={{atob api.data.Value}}
@isStandalone={{false}}
@ariaLabel='value'
as |CB|
>
<CB.Title @tag='h2'>Value</CB.Title>
</Hds::CodeBlock>
{{#if (eq this.language 'toml')}}
<Hds::CodeEditor
@name='Value'
@readonly={{true}}
@value={{atob api.data.Value}}
@onInput={{action api.change 'value'}}
@customExtensions={{(toml-extension)}}
@ariaLabel='value'
@hasCopyButton={{true}}
@isStandalone={{false}}
as |CE|
>
<CE.Title @tag='h2'>Value</CE.Title>
</Hds::CodeEditor>
{{else}}
<Hds::CodeBlock
@language={{this.codeBlockLanguage}}
@value={{atob api.data.Value}}
@isStandalone={{false}}
@ariaLabel='value'
as |CB|
>
<CB.Title @tag='h2'>Value</CB.Title>
</Hds::CodeBlock>
{{/if}}
{{else}}
<Hds::CodeEditor
@name='Value'
@readonly={{or disabld api.disabled}}
@value={{atob api.data.Value}}
@onInput={{action api.change 'value'}}
@language='yaml'
@ariaLabel='value'
@hasCopyButton={{true}}
@isStandalone={{false}}
as |CE|
>
<CE.Title @tag='h2'>Value</CE.Title>
</Hds::CodeEditor>
{{#if (eq this.language 'toml')}}
<Hds::CodeEditor
@name='Value'
@readonly={{or disabld api.disabled}}
@value={{atob api.data.Value}}
@onInput={{action api.change 'value'}}
@customExtensions={{(toml-extension)}}
@ariaLabel='value'
@hasCopyButton={{true}}
@isStandalone={{false}}
as |CE|
>
<CE.Title @tag='h2'>Value</CE.Title>
</Hds::CodeEditor>
{{else}}
<Hds::CodeEditor
@name='Value'
@readonly={{or disabld api.disabled}}
@value={{atob api.data.Value}}
@onInput={{action api.change 'value'}}
@language={{this.language}}
@ariaLabel='value'
@hasCopyButton={{true}}
@isStandalone={{false}}
as |CE|
>
<CE.Title @tag='h2'>Value</CE.Title>
</Hds::CodeEditor>
{{/if}}
{{/if}}
{{else}}
<span>Value</span>
Expand Down Expand Up @@ -142,4 +197,4 @@
</form>
{{/let}}
</BlockSlot>
</DataForm>
</DataForm>
37 changes: 36 additions & 1 deletion ui/packages/consul-ui/app/components/consul/kv/form/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,52 @@
*/

import Component from '@ember/component';
import { set } from '@ember/object';
import { set, computed } from '@ember/object';
import { inject as service } from '@ember/service';

/**
* Available syntax highlighting languages for the KV editor.
* Each entry contains:
* - value: The language identifier used by the HDS components
* - label: The display label shown in the dropdown
* - codeBlockLanguage: The fallback language for CodeBlock (which has different supported languages)
*/
const LANGUAGES = [
{ value: 'json', label: 'JSON', codeBlockLanguage: 'json' },
{ value: 'hcl', label: 'HCL', codeBlockLanguage: 'hcl' },
{ value: 'yaml', label: 'YAML', codeBlockLanguage: 'yaml' },
{ value: 'xml', label: 'XML', codeBlockLanguage: 'xml' },
{ value: 'toml', label: 'TOML', codeBlockLanguage: 'hcl' }, // TOML uses HCL as CodeBlock fallback (similar syntax)
];

export default Component.extend({
tagName: '',
encoder: service('btoa'),
json: true,
language: 'yaml', // Default syntax highlighting language

/**
* Available languages for the syntax highlighting dropdown.
*/
languages: LANGUAGES,

ondelete: function () {
this.onsubmit(...arguments);
},
oncancel: function () {
this.onsubmit(...arguments);
},
onsubmit: function () {},

/**
* Gets the appropriate CodeBlock language.
* For TOML, falls back to HCL since CodeBlock doesn't natively support TOML.
*/
codeBlockLanguage: computed('language', function () {
const lang = LANGUAGES.find((l) => l.value === this.language);
return lang ? lang.codeBlockLanguage : 'json';
}),

actions: {
change: function (e, form) {
const item = form.getData();
Expand All @@ -42,6 +74,9 @@ export default Component.extend({
// a set(this, 'json', valueFromSomeStorageJustForThisKV) would be added here
set(this, 'json', !this.json);
break;
case 'language':
set(this, 'language', target.value);
break;
default:
throw err;
}
Expand Down
20 changes: 20 additions & 0 deletions ui/packages/consul-ui/app/helpers/toml-extension.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: BUSL-1.1
*/

import { helper } from '@ember/component/helper';
import { StreamLanguage } from '@codemirror/language';
import { toml } from '@codemirror/legacy-modes/mode/toml';

/**
* Helper to provide TOML syntax highlighting extension for CodeMirror 6.
* Used with the HDS CodeEditor component via @customExtensions.
*
* @returns {Array} Array containing the TOML StreamLanguage extension
*/
export function tomlExtension() {
return [StreamLanguage.define(toml)];
}

export default helper(tomlExtension);
2 changes: 2 additions & 0 deletions ui/packages/consul-ui/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@
"@babel/eslint-parser": "^7.28.5",
"@babel/plugin-proposal-decorators": "^7.28.0",
"@babel/plugin-transform-class-properties": "^7.27.1",
"@codemirror/language": "^6.11.2",
"@codemirror/legacy-modes": "^6.5.1",
"@docfy/ember": "^0.8.5",
"@ember-data/adapter": "~4.12.8",
"@ember-data/model": "~4.12.8",
Expand Down
6 changes: 6 additions & 0 deletions ui/pnpm-lock.yaml
View file
Open in desktop

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