pub-solar/forgejo
5
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Ensure syntax highlighting is the same inside diffs (#12205)

Browse source 
Make sure to end up with the same syntax highlighting inside various sections of diffs by processing the code first before detecting specific changes between the lines. Also try and make sure that when highlighting individual lines in a diff that it is tokenized the same as it would be when part of an entire file with more context.

Fixes: #12190
This commit is contained in:
mrsdizzie 2020-07-11 01:43:12 -04:00 committed by GitHub
parent 6a62884782
commit 8d081950e6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
modules/highlight/highlight.go
View file

@ -14,7 +14,6 @@ import (
"code.gitea.io/gitea/modules/log" "code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/setting" "code.gitea.io/gitea/modules/setting"
"github.com/alecthomas/chroma"
"github.com/alecthomas/chroma/formatters/html" "github.com/alecthomas/chroma/formatters/html"
"github.com/alecthomas/chroma/lexers" "github.com/alecthomas/chroma/lexers"
"github.com/alecthomas/chroma/styles" "github.com/alecthomas/chroma/styles"
@ -44,9 +43,12 @@ func NewContext() {
func Code(fileName, code string) string { func Code(fileName, code string) string {
NewContext() NewContext()
if code == "" { // diff view newline will be passed as empty, change to literal \n so it can be copied
// preserve literal newline in blame view
if code == "" || code == "\n" {
return "\n" return "\n"
} }
if len(code) > sizeLimit { if len(code) > sizeLimit {
return code return code
} }
@ -72,7 +74,7 @@ func Code(fileName, code string) string {
lexer = lexers.Fallback lexer = lexers.Fallback
} }
iterator, err := lexer.Tokenise(&chroma.TokeniseOptions{State: "root", Nested: true}, string(code)) iterator, err := lexer.Tokenise(nil, string(code))
if err != nil { if err != nil {
log.Error("Can't tokenize code: %v", err) log.Error("Can't tokenize code: %v", err)
return code return code
@ -85,7 +87,9 @@ func Code(fileName, code string) string {
} }
htmlw.Flush() htmlw.Flush()
return htmlbuf.String() // Chroma will add newlines for certain lexers in order to highlight them properly
// Once highlighted, strip them here so they don't cause copy/paste trouble in HTML output
return strings.TrimSuffix(htmlbuf.String(), "\n")
} }
// File returns map with line lumbers and HTML version of code with chroma syntax highlighting classes // File returns map with line lumbers and HTML version of code with chroma syntax highlighting classes

8
services/gitdiff/gitdiff.go
View file

@ -188,14 +188,14 @@ func diffToHTML(fileName string, diffs []diffmatchpatch.Diff, lineType DiffLineT
switch { switch {
case diffs[i].Type == diffmatchpatch.DiffInsert && lineType == DiffLineAdd: case diffs[i].Type == diffmatchpatch.DiffInsert && lineType == DiffLineAdd:
buf.Write(addedCodePrefix) buf.Write(addedCodePrefix)
buf.WriteString(highlight.Code(fileName, diffs[i].Text)) buf.WriteString(getLineContent(diffs[i].Text))
buf.Write(codeTagSuffix) buf.Write(codeTagSuffix)
case diffs[i].Type == diffmatchpatch.DiffDelete && lineType == DiffLineDel: case diffs[i].Type == diffmatchpatch.DiffDelete && lineType == DiffLineDel:
buf.Write(removedCodePrefix) buf.Write(removedCodePrefix)
buf.WriteString(highlight.Code(fileName, diffs[i].Text)) buf.WriteString(getLineContent(diffs[i].Text))
buf.Write(codeTagSuffix) buf.Write(codeTagSuffix)
case diffs[i].Type == diffmatchpatch.DiffEqual: case diffs[i].Type == diffmatchpatch.DiffEqual:
buf.WriteString(highlight.Code(fileName, getLineContent(diffs[i].Text))) buf.WriteString(getLineContent(diffs[i].Text))
} }
} }
return template.HTML(buf.Bytes()) return template.HTML(buf.Bytes())
@ -287,7 +287,7 @@ func (diffSection *DiffSection) GetComputedInlineDiffFor(diffLine *DiffLine) tem
return template.HTML(highlight.Code(diffSection.FileName, diffLine.Content)) return template.HTML(highlight.Code(diffSection.FileName, diffLine.Content))
} }
diffRecord := diffMatchPatch.DiffMain(diff1[1:], diff2[1:], true) diffRecord := diffMatchPatch.DiffMain(highlight.Code(diffSection.FileName, diff1[1:]), highlight.Code(diffSection.FileName, diff2[1:]), true)
diffRecord = diffMatchPatch.DiffCleanupEfficiency(diffRecord) diffRecord = diffMatchPatch.DiffCleanupEfficiency(diffRecord)
return diffToHTML(diffSection.FileName, diffRecord, diffLine.Type) return diffToHTML(diffSection.FileName, diffRecord, diffLine.Type)
} }