Draft: Code Block component for rendering code snippets
What does this MR do?
Introduces a new Vue component for rendering the code snippets purely on the frontend. At the moment, all the code snippets are generated on the BE (with Rouge) that creates a massive load and delay in getting the responses on different routes. This MR suggests a component that takes a plain code string and outputs it ina code block with the syntaxis highlighting using monaco
.
This is a part of a series of experiments of rendering the code blocks in the product using different approaches:
- Using Source Editor with the specially designed read-only extension
- Using Monaco's highlighting directly without the editor itself (this MR)
- Using highlightjs
:refactor_blob_viewer
feature flag.
Screenshots or Screencasts (strongly suggested)
How to setup and validate locally (strongly suggested)
Does this MR meet the acceptance criteria?
Conformity
-
I have included changelog trailers, or none are needed. (Does this MR need a changelog?) -
I have added/updated documentation, or it's not needed. (Is documentation required?) -
I have properly separated EE content from FOSS, or this MR is FOSS only. (Where should EE code go?) -
I have added information for database reviewers in the MR description, or it's not needed. (Does this MR have database related changes?) -
I have self-reviewed this MR per code review guidelines. -
This MR does not harm performance, or I have asked a reviewer to help assess the performance impact. (Merge request performance guidelines) -
I have followed the style guides. -
This change is backwards compatible across updates, or this does not apply.
Availability and Testing
-
I have added/updated tests following the Testing Guide, or it's not needed. (Consider all test levels. See the Test Planning Process.) -
I have tested this MR in all supported browsers, or it's not needed. -
I have informed the Infrastructure department of a default or new setting change per definition of done, or it's not needed.
Security
Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.
-
Label as security and @ mention @gitlab-com/gl-security/appsec
-
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team