-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for rendering terminal output with colors (#19497)
- Loading branch information
Showing
10 changed files
with
466 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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 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 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 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,95 @@ | ||
| // Copyright 2022 The Gitea Authors. All rights reserved. | ||
| // Use of this source code is governed by a MIT-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package console | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "io" | ||
| "path/filepath" | ||
| "regexp" | ||
| "strings" | ||
|
|
||
| "code.gitea.io/gitea/modules/markup" | ||
| "code.gitea.io/gitea/modules/setting" | ||
|
|
||
| trend "github.com/buildkite/terminal-to-html/v3" | ||
| "github.com/go-enry/go-enry/v2" | ||
| ) | ||
|
|
||
| // MarkupName describes markup's name | ||
| var MarkupName = "console" | ||
|
|
||
| func init() { | ||
| markup.RegisterRenderer(Renderer{}) | ||
| } | ||
|
|
||
| // Renderer implements markup.Renderer | ||
| type Renderer struct{} | ||
|
|
||
| // Name implements markup.Renderer | ||
| func (Renderer) Name() string { | ||
| return MarkupName | ||
| } | ||
|
|
||
| // NeedPostProcess implements markup.Renderer | ||
| func (Renderer) NeedPostProcess() bool { return false } | ||
|
|
||
| // Extensions implements markup.Renderer | ||
| func (Renderer) Extensions() []string { | ||
| return []string{".sh-session"} | ||
| } | ||
|
|
||
| // SanitizerRules implements markup.Renderer | ||
| func (Renderer) SanitizerRules() []setting.MarkupSanitizerRule { | ||
| return []setting.MarkupSanitizerRule{ | ||
| {Element: "span", AllowAttr: "class", Regexp: regexp.MustCompile(`^term-((fg[ix]?|bg)\d+|container)$`)}, | ||
| } | ||
| } | ||
|
|
||
| // SanitizerDisabled disabled sanitize if return true | ||
| func (Renderer) SanitizerDisabled() bool { | ||
| return false | ||
| } | ||
|
|
||
| // CanRender implements markup.RendererContentDetector | ||
| func (Renderer) CanRender(filename string, input io.Reader) bool { | ||
| buf, err := io.ReadAll(input) | ||
| if err != nil { | ||
| return false | ||
| } | ||
| if enry.GetLanguage(filepath.Base(filename), buf) != enry.OtherLanguage { | ||
| return false | ||
| } | ||
| return bytes.ContainsRune(buf, '\x1b') | ||
| } | ||
|
|
||
| // Render renders terminal colors to HTML with all specific handling stuff. | ||
| func (Renderer) Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error { | ||
| buf, err := io.ReadAll(input) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| buf = trend.Render(buf) | ||
| buf = bytes.ReplaceAll(buf, []byte("\n"), []byte(`<br>`)) | ||
| _, err = output.Write(buf) | ||
| return err | ||
| } | ||
|
|
||
| // Render renders terminal colors to HTML with all specific handling stuff. | ||
| func Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error { | ||
| if ctx.Type == "" { | ||
| ctx.Type = MarkupName | ||
| } | ||
| return markup.Render(ctx, input, output) | ||
| } | ||
|
|
||
| // RenderString renders terminal colors in string to HTML with all specific handling stuff and return string | ||
| func RenderString(ctx *markup.RenderContext, content string) (string, error) { | ||
| var buf strings.Builder | ||
| if err := Render(ctx, strings.NewReader(content), &buf); err != nil { | ||
| return "", err | ||
| } | ||
| return buf.String(), nil | ||
| } |
This file contains 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,31 @@ | ||
| // Copyright 2022 The Gitea Authors. All rights reserved. | ||
| // Use of this source code is governed by a MIT-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package console | ||
|
|
||
| import ( | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "code.gitea.io/gitea/modules/markup" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestRenderConsole(t *testing.T) { | ||
| var render Renderer | ||
| kases := map[string]string{ | ||
| "\x1b[37m\x1b[40mnpm\x1b[0m \x1b[0m\x1b[32minfo\x1b[0m \x1b[0m\x1b[35mit worked if it ends with\x1b[0m ok": "<span class=\"term-fg37 term-bg40\">npm</span> <span class=\"term-fg32\">info</span> <span class=\"term-fg35\">it worked if it ends with</span> ok", | ||
| } | ||
|
|
||
| for k, v := range kases { | ||
| var buf strings.Builder | ||
| canRender := render.CanRender("test", strings.NewReader(k)) | ||
| assert.True(t, canRender) | ||
|
|
||
| err := render.Render(&markup.RenderContext{}, strings.NewReader(k), &buf) | ||
| assert.NoError(t, err) | ||
| assert.EqualValues(t, v, buf.String()) | ||
| } | ||
| } |
This file contains 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 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 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
Oops, something went wrong.