domi/forgejo-domi
1
0
Fork 0
forked from forgejo/forgejo
Code Pull requests Activity

Refactor some Str2html code (#29397)

Browse source 
This PR touches the most interesting part of the "template refactoring".

1. Unclear variable type. Especially for "web/feed/convert.go":
sometimes it uses text, sometimes it uses HTML.
2. Assign text content to "RenderedContent" field, for example: `
project.RenderedContent = project.Description` in web/org/projects.go
3. Assign rendered content to text field, for example: `r.Note =
rendered content` in web/repo/release.go
4. (possible) Incorrectly calling `{{Str2html
.PackageDescriptor.Metadata.ReleaseNotes}}` in
package/content/nuget.tmpl, I guess the name Str2html misleads
developers to use it to "render string to html", but it only sanitizes.
if ReleaseNotes really contains HTML, then this is not a problem.

(cherry picked from commit e71eb8930a5d0f60874b038c223498b41ad65592)

Conflicts:
	modules/templates/util_string.go
	trivial context conflict
This commit is contained in:
wxiaoguang 2024-03-01 15:11:51 +08:00 • committed by Earl Warren
parent 97a0368c28
commit 68099f2f00
No known key found for this signature in database
GPG key ID: 0579CB2928A78A00
32 changed files with 90 additions and 61 deletions
Download patch file Download diff file Expand all files Collapse all files

5
modules/markup/markdown/markdown.go
View file

@ -6,6 +6,7 @@ package markdown
import (
"fmt"
"html/template"
"io"
"strings"
"sync"
@ -266,12 +267,12 @@ func Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error
}
// RenderString renders Markdown string to HTML with all specific handling stuff and return string
func RenderString(ctx *markup.RenderContext, content string) (string, error) {
func RenderString(ctx *markup.RenderContext, content string) (template.HTML, error) {
var buf strings.Builder
if err := Render(ctx, strings.NewReader(content), &buf); err != nil {
return "", err
}
return buf.String(), nil
return template.HTML(buf.String()), nil
}
// RenderRaw renders Markdown to HTML without handling special links.