Skip to content

Update markdown and screenshots parsing #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thelovekesh merged 2 commits into from
Jan 28, 2026
Merged

Update markdown and screenshots parsing #163

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f36b437
Update markdown and screenshots parsing
thelovekesh Jan 28, 2026
ec6cf03
Remove redundant logic and update types
thelovekesh Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 62 additions & 29 deletions pkg/wp/parser/readme-txt.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,17 @@ func (p *ReadmeParser) Parse(content string) {

lineIndex := 0

// Parse plugin name from === Plugin Name ===
// Parse plugin name from === Plugin Name === OR # Plugin Name
lineIndex = p.skipEmptyLines(lines, lineIndex)
if lineIndex < len(lines) {
trimmedLine := strings.TrimSpace(lines[lineIndex])
if strings.HasPrefix(trimmedLine, "===") && strings.HasSuffix(trimmedLine, "===") && len(trimmedLine) > 6 { // e.g. "===A==="
p.Name = p.parsePluginName(trimmedLine)

// Check Classic (===)
if strings.HasPrefix(trimmedLine, "===") && strings.HasSuffix(trimmedLine, "===") && len(trimmedLine) > 6 {
p.Name = p.parsePluginName(trimmedLine, "===")
lineIndex++
} else if strings.HasPrefix(trimmedLine, "# ") {
p.Name = p.parsePluginName(trimmedLine, "#")
lineIndex++
}
}
Expand All @@ -89,10 +94,10 @@ func (p *ReadmeParser) stripBOM(lines []string) []string {
return lines
}

// parsePluginName extracts the plugin name.
func (p *ReadmeParser) parsePluginName(line string) string {
name := strings.TrimPrefix(line, "===")
name = strings.TrimSuffix(name, "===")
// parsePluginName extracts the plugin name stripping markers.
func (p *ReadmeParser) parsePluginName(line, marker string) string {
name := strings.TrimPrefix(line, marker)
name = strings.TrimSuffix(name, marker)
return strings.TrimSpace(name)
}

Expand Down Expand Up @@ -143,8 +148,10 @@ func (p *ReadmeParser) parseHeaders(lines []string, start int) int {
continue
}

// Headers end when a section (==) or plugin title (===) starts.
if strings.HasPrefix(trimmedLine, "==") {
// Headers end when a section starts.
// Classic: starts with "=="
// Markdown: starts with "##"
if strings.HasPrefix(trimmedLine, "==") || strings.HasPrefix(trimmedLine, "##") {
break
}

Expand Down Expand Up @@ -195,7 +202,7 @@ func (p *ReadmeParser) parseMetaDescription(lines []string, start int) int {

if i < len(lines) {
line := strings.TrimSpace(lines[i])
if !strings.HasPrefix(line, "==") {
if !strings.HasPrefix(line, "==") && !strings.HasPrefix(line, "##") {
p.MetaDescription = line
i++
}
Expand All @@ -220,10 +227,23 @@ func (p *ReadmeParser) parseSections(lines []string, start int) {
line := lines[i]
trimmedLine := strings.TrimSpace(line)

if strings.HasPrefix(trimmedLine, "==") && strings.HasSuffix(trimmedLine, "==") &&
!strings.HasPrefix(trimmedLine, "===") && len(trimmedLine) >= 4 { // Min: "== =="
isClassicSection := strings.HasPrefix(trimmedLine, "==") && strings.HasSuffix(trimmedLine, "==") &&
!strings.HasPrefix(trimmedLine, "===") && len(trimmedLine) >= 4

isMarkdownSection := strings.HasPrefix(trimmedLine, "##")

if isClassicSection || isMarkdownSection {
saveSection()
sectionTitle := strings.TrimSpace(trimmedLine[2 : len(trimmedLine)-2])
var sectionTitle string

if isClassicSection {
sectionTitle = strings.TrimSpace(trimmedLine[2 : len(trimmedLine)-2])
} else {
sectionTitle = strings.TrimPrefix(trimmedLine, "##")
sectionTitle = strings.TrimSuffix(sectionTitle, "##")
sectionTitle = strings.TrimSpace(sectionTitle)
}

currentSectionKey = strings.ToLower(strings.ReplaceAll(sectionTitle, " ", "_"))
} else {
if currentSectionKey != "" {
Expand Down Expand Up @@ -261,7 +281,8 @@ func (p *ReadmeParser) processSpecialSections() {
}
}

// parseBlockStyleItems parses sections like FAQ or UpgradeNotice where items are "= Item Title =".
// parseBlockStyleItems parses sections like FAQ or UpgradeNotice.
// Handles Classic "= Item Title =" and Markdown "### Item Title".
func (p *ReadmeParser) parseBlockStyleItems(content string) map[string]string {
itemsMap := make(map[string]string)
lines := strings.Split(content, "\n")
Expand All @@ -278,10 +299,20 @@ func (p *ReadmeParser) parseBlockStyleItems(content string) map[string]string {
for _, line := range lines {
trimmedLine := strings.TrimSpace(line)

if strings.HasPrefix(trimmedLine, "=") && strings.HasSuffix(trimmedLine, "=") &&
!strings.HasPrefix(trimmedLine, "==") && len(trimmedLine) >= 3 { // Min: "=A=" or "= ="
isClassicItem := strings.HasPrefix(trimmedLine, "=") && strings.HasSuffix(trimmedLine, "=") &&
!strings.HasPrefix(trimmedLine, "==") && len(trimmedLine) >= 3

isMarkdownItem := strings.HasPrefix(trimmedLine, "###")

if isClassicItem || isMarkdownItem {
saveItem()
currentItemTitle = strings.TrimSpace(trimmedLine[1 : len(trimmedLine)-1])
if isClassicItem {
currentItemTitle = strings.TrimSpace(trimmedLine[1 : len(trimmedLine)-1])
} else {
currentItemTitle = strings.TrimPrefix(trimmedLine, "###")
currentItemTitle = strings.TrimSuffix(currentItemTitle, "###")
currentItemTitle = strings.TrimSpace(currentItemTitle)
}
} else if currentItemTitle != "" { // Only append if we have an active item title
currentItemContent.WriteString(line + "\n")
}
Expand Down Expand Up @@ -338,6 +369,7 @@ func renderFAQMarkdown(parser *ReadmeParser, _ string, md *strings.Builder) bool
for q := range parser.FAQ {
questions = append(questions, q)
}
// Sort carefully to keep things somewhat stable
sort.Strings(questions)
for _, question := range questions {
md.WriteString("### " + question + "\n\n")
Expand All @@ -355,10 +387,14 @@ func renderScreenshotsMarkdown(parser *ReadmeParser, _ string, md *strings.Build
keys = append(keys, k)
}
sort.Ints(keys)

for _, k := range keys {
fmt.Fprintf(md, "![Screenshot %d](%s)\n", k, parser.Screenshots[k])
title := parser.Screenshots[k]
safeAltTitle := strings.ReplaceAll(title, "\"", "&quot;")

md.WriteString("### " + title + "\n")
fmt.Fprintf(md, `<img id="screenshot-%d" src="/screenshot-%d.png" alt="%s" />`+"\n\n", k, k, safeAltTitle)
}
md.WriteString("\n") // Extra newline after the list
return true
}
return false
Expand All @@ -370,7 +406,7 @@ func renderUpgradeNoticeMarkdown(parser *ReadmeParser, _ string, md *strings.Bui
for v := range parser.UpgradeNotice {
versions = append(versions, v)
}
sort.Strings(versions) // Note: simple string sort for versions
sort.Strings(versions)
for _, version := range versions {
md.WriteString("### " + version + "\n\n")
md.WriteString(parser.UpgradeNotice[version] + "\n\n")
Expand All @@ -397,14 +433,12 @@ func (p *ReadmeParser) ToMarkdown() string {
for _, config := range standardSectionConfigs {
content, keyUsed, found := p.getSectionContent(config.primaryKey, config.alternateKeys...)

// If not found, or found but the content is empty, skip rendering its title/content.
// Mark as "handled" if found (even if empty) to prevent it appearing in "Other sections".
if !found {
continue
}
renderedSectionKeys[keyUsed] = true // Mark key as handled
renderedSectionKeys[keyUsed] = true
if content == "" {
continue // Don't render title for empty sections
continue
}

md.WriteString(config.markdownTitle + "\n\n")
Expand All @@ -425,15 +459,14 @@ func (p *ReadmeParser) ToMarkdown() string {
otherSectionKeys = append(otherSectionKeys, key)
}
}
sort.Strings(otherSectionKeys) // Sort for consistent output
sort.Strings(otherSectionKeys)

titleCaser := cases.Title(language.English)
for _, sectionKey := range otherSectionKeys {
content := p.Sections[sectionKey]
if content == "" { // Should not happen if `renderedSectionKeys` logic is correct for empty sections
if content == "" {
continue
}
// Convert snake_case_key to Title Case
title := titleCaser.String(strings.ReplaceAll(sectionKey, "_", " "))
md.WriteString("## " + title + "\n\n")
md.WriteString(p.convertSubsections(content) + "\n\n")
Expand All @@ -442,8 +475,8 @@ func (p *ReadmeParser) ToMarkdown() string {
return strings.TrimSpace(md.String())
}

func (p *ReadmeParser) GetMetadata() map[string]interface{} {
return map[string]interface{}{
func (p *ReadmeParser) GetMetadata() map[string]any {
return map[string]any{
"name": p.Name,
"meta_description": p.MetaDescription,
"contributors": p.Contributors,
Expand Down