Skip to content

Commit 86c41a1

Browse files
bteagraphieros
andauthored
fix(ui): render badge-only descriptions left as bare brackets as empty (#3454)
Co-authored-by: Alec Lloyd Probert <55991794+graphieros@users.noreply.github.com>
1 parent c00b27d commit 86c41a1

2 files changed

Lines changed: 32 additions & 0 deletions

File tree

‎app/composables/useMarkdown.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,9 @@ function parseMarkdown({
103103
if (!text) return ''
104104

105105
// First strip HTML tags and escape remaining HTML
106+
// Badge images without an enclosing link strip down to bare "[]" wrappers
106107
let html = stripAndEscapeHtml(text)
108+
if (/^(?:\[\s*\]\s*)+$/.test(html)) return ''
107109

108110
// Bold: **text** or __text__
109111
html = html.replace(/\*\*(.+?)\*\*/g, '<strong>$1</strong>')

‎test/nuxt/composables/use-markdown.spec.ts‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,36 @@ describe('useMarkdown', () => {
264264
expect(processed.value).toBe('A library')
265265
})
266266

267+
it('returns empty when a linkless badge strips down to bare brackets', () => {
268+
// A badge image without an enclosing link loses its image atom but the
269+
// wrapper has no URL to match, leaving a bare "[]" behind
270+
const processed = useMarkdown({
271+
text: '[![Test Status](https://github.com/user/repo/actions/workflows/test.yml/badge.svg?branch=main)]',
272+
})
273+
expect(processed.value).toBe('')
274+
})
275+
276+
it('returns empty when linked and linkless badges leave only bare brackets', () => {
277+
const processed = useMarkdown({
278+
text: '[![Npm Package](https://badgen.net/npm/v/jsdoc-type-pratt-parser)](https://www.npmjs.com/package/jsdoc-type-pratt-parser) [![Test Status](https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/actions/workflows/test.yml/badge.svg?branch=main)]',
279+
})
280+
expect(processed.value).toBe('')
281+
})
282+
283+
it('returns empty for a literal empty bracket pair', () => {
284+
expect(useMarkdown({ text: '[]' }).value).toBe('')
285+
expect(useMarkdown({ text: ' [] ' }).value).toBe('')
286+
})
287+
288+
it('returns empty when multiple linkless badges strip down to bare brackets', () => {
289+
expect(useMarkdown({ text: '[![a](https://x.svg)] [![b](https://y.svg)]' }).value).toBe('')
290+
expect(useMarkdown({ text: '[![a](https://x.svg)]\n[![b](https://y.svg)]' }).value).toBe('')
291+
})
292+
293+
it('preserves brackets that are part of the text', () => {
294+
expect(useMarkdown({ text: 'returns [] when empty' }).value).toBe('returns [] when empty')
295+
})
296+
267297
it('strips reference-style linked image badges (regression #2767)', () => {
268298
const processed = useMarkdown({
269299
text: '[![npm version][npm-v-src]][npm-v-href] [![npm downloads][npm-d-src]][npm-d-href] A library',

0 commit comments

Comments
 (0)