Adding CodeMirror editor for code highlighting and editing #2279
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| <script setup lang="ts"> | ||
| import CodeMirror from "vue-codemirror6"; | ||
| import { json } from "@codemirror/lang-json"; | ||
| import { xml } from "@codemirror/lang-xml"; | ||
| import { StreamLanguage } from "@codemirror/language"; | ||
| import { powerShell } from "@codemirror/legacy-modes/mode/powershell"; | ||
| import { shell } from "@codemirror/legacy-modes/mode/shell"; | ||
| import { csharp } from "@codemirror/legacy-modes/mode/clike"; | ||
| import { Extension } from "@codemirror/state"; | ||
| import { CodeLanguage } from "@/components/codeEditorTypes"; | ||
| import CopyToClipboard from "@/components/CopyToClipboard.vue"; | ||
| import { computed } from "vue"; | ||
| const code = defineModel<string>({ required: true }); | ||
| const props = withDefaults( | ||
| defineProps<{ | ||
| language?: CodeLanguage; | ||
| readOnly?: boolean; | ||
| showGutter?: boolean; | ||
| showCopyToClipboard?: boolean; | ||
| ariaLabel?: string; | ||
| }>(), | ||
| { readOnly: true, showGutter: true, showCopyToClipboard: true } | ||
| ); | ||
| const extensions = computed(() => { | ||
| const extensions: Extension[] = []; | ||
| switch (props.language) { | ||
| case "json": | ||
| extensions.push(json()); | ||
| break; | ||
| case "xml": | ||
| extensions.push(xml()); | ||
| break; | ||
| case "shell": | ||
| extensions.push(StreamLanguage.define(shell)); | ||
| break; | ||
| case "powershell": | ||
| extensions.push(StreamLanguage.define(powerShell)); | ||
| break; | ||
| case "csharp": | ||
| extensions.push(StreamLanguage.define(csharp)); | ||
| break; | ||
| } | ||
| return extensions; | ||
| }); | ||
| </script> | ||
|
|
||
| <template> | ||
| <div class="wrapper" :aria-label="ariaLabel"> | ||
| <div v-if="props.showCopyToClipboard" class="toolbar"> | ||
| <CopyToClipboard :value="code" /> | ||
| </div> | ||
| <CodeMirror v-model="code" :extensions="extensions" :basic="props.showGutter" :minimal="!props.showGutter" :readonly="props.readOnly" :gutter="!props.readOnly"></CodeMirror> | ||
| </div> | ||
| </template> | ||
|
|
||
| <style scoped> | ||
| .wrapper { | ||
| border-radius: 0.5rem; | ||
| padding: 0.5rem; | ||
| border: 1px solid #ccc; | ||
| display: flex; | ||
| flex-direction: column; | ||
| } | ||
| .toolbar { | ||
| border-bottom: 1px solid #ccc; | ||
| padding-bottom: 0.5rem; | ||
| margin-bottom: 0.5rem; | ||
| display: flex; | ||
| flex-direction: row; | ||
| justify-content: end; | ||
| } | ||
| </style> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| <script setup lang="ts"> | ||
| import { Tippy, TippyComponent } from "vue-tippy"; | ||
| import { useTemplateRef } from "vue"; | ||
|
|
||
| const props = defineProps<{ | ||
| value: string; | ||
| }>(); | ||
|
|
||
| const tippyRef = useTemplateRef<TippyComponent | null>("tippyRef"); | ||
| let timeoutId: number; | ||
|
|
||
| async function copyToClipboard() { | ||
| await navigator.clipboard.writeText(props.value); | ||
| window.clearTimeout(timeoutId); | ||
| tippyRef.value?.show(); | ||
| timeoutId = window.setTimeout(() => tippyRef.value?.hide(), 3000); | ||
| } | ||
| </script> | ||
|
|
||
| <template> | ||
| <Tippy content="Copied" ref="tippyRef" trigger="manual"> | ||
| <button type="button" class="btn btn-secondary btn-sm" @click="copyToClipboard"><i class="fa fa-copy"></i> Copy to clipboard</button> | ||
| </Tippy> | ||
| </template> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export type CodeLanguage = "json" | "xml" | "shell" | "powershell" | "csharp"; | ||
|
There was a problem hiding this comment. At the moment these are the only languages supported, we can add more later if needed |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,20 @@ | ||
| <script setup lang="ts"> | ||
| import { ExtendedFailedMessage } from "@/resources/FailedMessage"; | ||
| import { computed } from "vue"; | ||
| import CodeEditor from "@/components/CodeEditor.vue"; | ||
| import parseContentType from "@/composables/contentTypeParser"; | ||
| const props = defineProps<{ | ||
| message: ExtendedFailedMessage; | ||
| }>(); | ||
|
|
||
| const contentType = computed(() => parseContentType(props.message.contentType)); | ||
| </script> | ||
|
|
||
| <template> | ||
| <div v-if="props.message.messageBodyNotFound" class="alert alert-info">Could not find message body. This could be because the message URL is invalid or the corresponding message was processed and is no longer tracked by ServiceControl.</div> | ||
| <div v-else-if="props.message.bodyUnavailable" class="alert alert-info">Message body unavailable.</div> | ||
| <CodeEditor v-else-if="contentType.isSupported" :model-value="props.message.messageBody" :language="contentType.language" :read-only="true" :show-gutter="true"></CodeEditor> | ||
| <div v-else class="alert alert-warning">Message body cannot be displayed because content type "{{ props.message.contentType }}" is not supported.</div> | ||
| </template> | ||
|
|
||
| <style scoped></style> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
comment here to explain that the copy on CodeMirror doesn't seem to work so we rolled our own
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, out of the box, there is no copy button.
The last time I looked at a plugin option, I can't remember which one.
So, we don't need a comment here to spell that out.