Deprecate helpers.markdown() (#3913)

This commit is contained in:
Naoki Takezoe
2026-01-09 22:15:50 +09:00
committed by GitHub
parent 36f7011ebf
commit 2dd2c4f568
11 changed files with 75 additions and 39 deletions

View File

@@ -279,6 +279,8 @@ trait IssuesControllerBase extends ControllerBase {
enableWikiLink = false,
enableRefsLink = true,
enableAnchor = true,
enableLineBreaks = true,
enableTaskList = true,
hasWritePermission = true
)
.toString()
@@ -311,6 +313,8 @@ trait IssuesControllerBase extends ControllerBase {
enableWikiLink = false,
enableRefsLink = true,
enableAnchor = true,
enableLineBreaks = true,
enableTaskList = true,
hasWritePermission = true
)
.toString()

View File

@@ -169,31 +169,19 @@ trait RepositoryViewerControllerBase extends ControllerBase {
*/
post("/:owner/:repository/_preview")(referrersOnly { repository =>
contentType = "text/html"
val filename = params.get("filename")
filename match {
case Some(f) =>
helpers.renderMarkup(
filePath = f.split("/").toList,
fileContent = params("content"),
branch = repository.repository.defaultBranch,
repository = repository,
enableWikiLink = params("enableWikiLink").toBoolean,
enableRefsLink = params("enableRefsLink").toBoolean,
enableAnchor = false
)
case None =>
helpers.markdown(
markdown = params("content"),
repository = repository,
branch = repository.repository.defaultBranch,
enableWikiLink = params("enableWikiLink").toBoolean,
enableRefsLink = params("enableRefsLink").toBoolean,
enableLineBreaks = params("enableLineBreaks").toBoolean,
enableTaskList = params("enableTaskList").toBoolean,
enableAnchor = false,
hasWritePermission = hasDeveloperRole(repository.owner, repository.name, context.loginAccount)
)
}
val filename = params.get("filename").getOrElse("temporary.md")
helpers.renderMarkup(
filePath = filename.split("/").toList,
fileContent = params("content"),
branch = repository.repository.defaultBranch,
repository = repository,
enableWikiLink = params("enableWikiLink").toBoolean,
enableRefsLink = params("enableRefsLink").toBoolean,
enableLineBreaks = params("enableLineBreaks").toBoolean,
enableTaskList = params("enableTaskList").toBoolean,
enableAnchor = false,
hasWritePermission = hasDeveloperRole(repository.owner, repository.name, context.loginAccount)
)
})
/**
@@ -905,6 +893,8 @@ trait RepositoryViewerControllerBase extends ControllerBase {
enableWikiLink = false,
enableRefsLink = true,
enableAnchor = true,
enableLineBreaks = true,
enableTaskList = true,
hasWritePermission = true
)
.toString()

View File

@@ -90,7 +90,17 @@ trait ApiRepositoryContentsControllerBase extends ControllerBase {
path,
"\" id=\"file\">",
"<article>",
renderMarkup(path.split("/").toList, new String(c), refStr, repository, false, false, true).body,
renderMarkup(
filePath = path.split("/").toList,
fileContent = new String(c),
branch = refStr,
repository = repository,
enableWikiLink = false,
enableRefsLink = false,
enableAnchor = false,
enableLineBreaks = true,
enableTaskList = true
).body,
"</article>",
"</div>"
).mkString

View File

@@ -20,7 +20,7 @@ trait Renderer {
object MarkdownRenderer extends Renderer {
override def render(request: RenderRequest): Html = {
import request._
import request.*
Html(
Markdown.toHtml(
markdown = fileContent,
@@ -29,8 +29,8 @@ object MarkdownRenderer extends Renderer {
enableWikiLink = enableWikiLink,
enableRefsLink = enableRefsLink,
enableAnchor = enableAnchor,
enableLineBreaks = false,
enableTaskList = true,
enableLineBreaks = enableLineBreaks,
enableTaskList = enableTaskList,
hasWritePermission = hasWritePermission
)(context)
)
@@ -51,6 +51,8 @@ case class RenderRequest(
enableWikiLink: Boolean,
enableRefsLink: Boolean,
enableAnchor: Boolean,
enableLineBreaks: Boolean,
enableTaskList: Boolean,
hasWritePermission: Boolean,
context: Context
)

View File

@@ -101,6 +101,7 @@ object helpers extends AvatarImageProvider with LinkConverter with RequestCache
/**
* Converts Markdown of Wiki pages to HTML.
*/
@deprecated("This doesn't apply render plugins. Should use renderMarkup() instead.", "4.45.0")
def markdown(
markdown: String,
repository: RepositoryService.RepositoryInfo,
@@ -140,6 +141,8 @@ object helpers extends AvatarImageProvider with LinkConverter with RequestCache
enableWikiLink: Boolean,
enableRefsLink: Boolean,
enableAnchor: Boolean,
enableLineBreaks: Boolean,
enableTaskList: Boolean,
hasWritePermission: Boolean = false
)(implicit context: Context): Html = {
@@ -155,6 +158,8 @@ object helpers extends AvatarImageProvider with LinkConverter with RequestCache
enableWikiLink,
enableRefsLink,
enableAnchor,
enableLineBreaks,
enableTaskList,
hasWritePermission,
context
)

View File

@@ -29,6 +29,8 @@
enableWikiLink = false,
enableRefsLink = true,
enableAnchor = true,
enableLineBreaks = true,
enableTaskList = true,
hasWritePermission = hasWritePermission
)
</div>

View File

@@ -24,7 +24,7 @@
</a>
</span>
@if(comment.action != "commit" && comment.action != "merge" && comment.action != "refer"
&& (isManageable || context.loginAccount.map(_.userName == comment.commentedUserName).getOrElse(false))){
&& (isManageable || context.loginAccount.exists(_.userName == comment.commentedUserName))){
<span class="pull-right">
<a href="#" data-comment-id="@comment.commentId"><i class="octicon octicon-pencil" aria-label="Edit"></i></a>&nbsp;
<a href="#" data-comment-id="@comment.commentId"><i class="octicon octicon-x" aria-label="Remove"></i></a>
@@ -40,6 +40,8 @@
enableWikiLink = false,
enableRefsLink = true,
enableAnchor = true,
enableLineBreaks = true,
enableTaskList = true,
hasWritePermission = isManageable
)
</div>
@@ -52,7 +54,7 @@
@helpers.user(issue.get.openedUserName, styleClass="username strong")
<span class="muted">commented @gitbucket.core.helper.html.datetimeago(issue.get.registeredDate)</span>
<span class="pull-right">
@if(isManageable || context.loginAccount.map(_.userName == issue.get.openedUserName).getOrElse(false)){
@if(isManageable || context.loginAccount.exists(_.userName == issue.get.openedUserName)){
<a href="#" data-issue-id="@issue.get.issueId"><i class="octicon octicon-pencil" aria-label="Edit"></i></a>
}
</span>
@@ -66,6 +68,8 @@
enableWikiLink = false,
enableRefsLink = true,
enableAnchor = true,
enableLineBreaks = true,
enableTaskList = true,
hasWritePermission = isManageable
)
</div>
@@ -339,6 +343,8 @@
enableWikiLink = false,
enableRefsLink = true,
enableAnchor = true,
enableLineBreaks = true,
enableTaskList = true,
hasWritePermission = isManageable
)
</div>
@@ -400,7 +406,7 @@ $(function(){
// diff view
const tr = comment.closest('.not-diff');
if(tr.length > 0){
if(tr.prev('.not-diff').length == 0){
if(tr.prev('.not-diff').length === 0){
tr.next('.not-diff:has(.reply-comment)').remove();
}
tr.remove();
@@ -410,7 +416,7 @@ $(function(){
const panel = comment.closest('div.panel:has(.commit-comment-box)');
if(panel.length > 0){
comment.parent('.commit-comment-box').remove();
if(panel.has('.commit-comment-box').length == 0){
if(panel.has('.commit-comment-box').length === 0){
panel.remove();
}
} else {

View File

@@ -16,7 +16,7 @@
@gitbucket.core.html.menu("issues", repository){
<div>
<div class="show-title pull-right">
@if(isManageable || context.loginAccount.map(_.userName == issue.openedUserName).getOrElse(false)){
@if(isManageable || context.loginAccount.exists(_.userName == issue.openedUserName)){
<a class="btn btn-default" href="#" id="edit">Edit</a>
}
@if(isEditable){

View File

@@ -83,7 +83,18 @@
@defining(helpers.isRenderable(pathList.last)){ isRenderable =>
@if(!isBlame && isRenderable) {
<div class="box-content-bottom @if(content.viewType == "text"){ markdown-body } " style="padding-left: 20px; padding-right: 20px;">
@helpers.renderMarkup(pathList, content.content.getOrElse(""), branch, repository, false, false, true, hasWritePermission)
@helpers.renderMarkup(
filePath = pathList,
fileContent = content.content.getOrElse(""),
branch = branch,
repository = repository,
enableWikiLink = false,
enableRefsLink = false,
enableAnchor = true,
enableLineBreaks = false,
enableTaskList = true,
hasWritePermission = hasWritePermission
)
</div>
}else{
@if(content.viewType == "text"){

View File

@@ -220,7 +220,7 @@
}
</div>
</div>
<div class="box-content-bottom markdown-body" style="padding-left: 20px; padding-right: 20px;">@helpers.renderMarkup(filePath, content, branch, repository, false, false, true)</div>
<div class="box-content-bottom markdown-body" style="padding-left: 20px; padding-right: 20px;">@helpers.renderMarkup(filePath, content, branch, repository, false, false, false, true, true)</div>
}
}
}

View File

@@ -66,7 +66,9 @@
repository = repository,
enableWikiLink = true,
enableRefsLink = false,
enableAnchor = false
enableAnchor = false,
enableLineBreaks = false,
enableTaskList = false
)
</div>
}.getOrElse{
@@ -97,7 +99,9 @@
repository = repository,
enableWikiLink = true,
enableRefsLink = false,
enableAnchor = true
enableAnchor = true,
enableLineBreaks = false,
enableTaskList = false
)
</div>
@footer.map { footerPage =>
@@ -112,7 +116,9 @@
repository = repository,
enableWikiLink = true,
enableRefsLink = false,
enableAnchor = false
enableAnchor = false,
enableLineBreaks = false,
enableTaskList = false
)
</div>
}.getOrElse{