Skip to content

Commit 98be51d

Browse files
feat(ui): improve package description cleaning and search result cards (#2775)
Co-authored-by: Willow (GHOST) <git@willow.sh>
1 parent f0bdd20 commit 98be51d

5 files changed

Lines changed: 100 additions & 81 deletions

File tree

‎app/components/Package/Card.vue‎

Lines changed: 41 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -74,84 +74,52 @@ const numberFormatter = useNumberFormatter()
7474
/>
7575
</header>
7676

77-
<div class="flex flex-col sm:flex-row sm:justify-start sm:items-start gap-6 sm:gap-8">
78-
<div class="min-w-0 w-full">
79-
<p v-if="pkgDescription" class="text-fg-muted text-xs sm:text-sm line-clamp-2 mb-2 sm:mb-3">
80-
<span v-html="pkgDescription" />
81-
</p>
82-
<div class="flex flex-wrap items-center gap-x-3 sm:gap-x-4 gap-y-2 text-xs text-fg-muted">
83-
<dl v-if="showPublisher || result.package.date" class="flex items-center gap-4 m-0">
84-
<div
85-
v-if="showPublisher && result.package.publisher?.username"
86-
class="flex items-center gap-1.5"
87-
>
88-
<dt class="sr-only">{{ $t('package.card.publisher') }}</dt>
89-
<dd class="font-mono">{{ result.package.publisher.username }}</dd>
90-
</div>
91-
<div v-if="result.package.date" class="flex items-center gap-1.5">
92-
<dt class="sr-only">{{ $t('package.card.published') }}</dt>
93-
<dd>
94-
<DateTime
95-
:datetime="result.package.date"
96-
year="numeric"
97-
month="short"
98-
day="numeric"
99-
/>
100-
</dd>
101-
</div>
102-
<div v-if="result.package.license" class="flex items-center gap-1.5">
103-
<dt class="sr-only">{{ $t('package.card.license') }}</dt>
104-
<dd>{{ result.package.license }}</dd>
105-
</div>
106-
</dl>
107-
</div>
108-
<!-- Mobile: downloads on separate row -->
109-
<dl
110-
v-if="result.downloads?.weekly"
111-
class="sm:hidden flex items-center gap-4 mt-2 text-xs text-fg-muted m-0"
112-
>
113-
<div class="flex items-center gap-1.5">
114-
<dt class="sr-only">{{ $t('package.card.weekly_downloads') }}</dt>
115-
<dd class="flex items-center gap-1.5">
116-
<span class="i-lucide:chart-line w-3.5 h-3.5" aria-hidden="true" />
117-
<span class="font-mono">{{ $n(result.downloads.weekly) }}/w</span>
118-
</dd>
119-
</div>
120-
</dl>
121-
</div>
122-
123-
<div class="flex flex-col gap-2 shrink-0">
124-
<div class="text-fg-subtle flex items-start gap-2 sm:justify-end">
125-
<span
126-
v-if="result.package.version"
127-
class="font-mono text-xs truncate max-w-32"
128-
:title="result.package.version"
129-
>
77+
<p v-if="pkgDescription" class="text-fg-muted text-xs sm:text-sm line-clamp-2 mb-2 sm:mb-3">
78+
<span v-html="pkgDescription" />
79+
</p>
80+
<div class="flex flex-wrap items-center gap-x-3 sm:gap-x-4 gap-y-2 text-xs text-fg-muted">
81+
<ProvenanceBadge
82+
v-if="result.package.publisher?.trustedPublisher"
83+
:provider="result.package.publisher.trustedPublisher.id"
84+
:package-name="result.package.name"
85+
:version="result.package.version"
86+
:linked="false"
87+
compact
88+
/>
89+
<dl class="contents m-0">
90+
<div v-if="result.package.version" class="flex items-center gap-1.5 min-w-0">
91+
<dt class="sr-only">{{ $t('package.card.version') }}</dt>
92+
<dd class="font-mono truncate max-w-32" :title="result.package.version">
13093
v{{ result.package.version }}
131-
</span>
132-
<div
133-
v-if="result.package.publisher?.trustedPublisher"
134-
class="flex items-center gap-1.5 shrink-0 max-w-32"
135-
>
136-
<ProvenanceBadge
137-
:provider="result.package.publisher.trustedPublisher.id"
138-
:package-name="result.package.name"
139-
:version="result.package.version"
140-
:linked="false"
141-
compact
142-
/>
143-
</div>
94+
</dd>
95+
</div>
96+
<div v-if="result.package.date" class="flex items-center gap-1.5">
97+
<dt class="sr-only">{{ $t('package.card.published') }}</dt>
98+
<dd>
99+
<DateTime :datetime="result.package.date" year="numeric" month="short" day="numeric" />
100+
</dd>
144101
</div>
145102
<div
146-
v-if="result.downloads?.weekly"
147-
class="text-fg-subtle gap-2 flex items-center sm:justify-end"
103+
v-if="showPublisher && result.package.publisher?.username"
104+
class="flex items-center gap-1.5"
148105
>
149-
<span class="i-lucide:chart-line w-3.5 h-3.5" aria-hidden="true" />
150-
<span class="font-mono text-xs">
151-
{{ $n(result.downloads.weekly) }} {{ $t('common.per_week') }}
152-
</span>
106+
<dt class="sr-only">{{ $t('package.card.publisher') }}</dt>
107+
<dd class="font-mono">{{ result.package.publisher.username }}</dd>
108+
</div>
109+
<div v-if="result.package.license" class="flex items-center gap-1.5">
110+
<dt class="sr-only">{{ $t('package.card.license') }}</dt>
111+
<dd>{{ result.package.license }}</dd>
112+
</div>
113+
<div v-if="result.downloads?.weekly != null" class="flex items-center gap-1.5 sm:ms-auto">
114+
<dt class="sr-only">{{ $t('package.card.weekly_downloads') }}</dt>
115+
<dd class="flex items-center gap-1.5">
116+
<span class="i-lucide:chart-line w-3.5 h-3.5" aria-hidden="true" />
117+
<span class="font-mono">
118+
{{ $n(result.downloads.weekly) }} {{ $t('common.per_week') }}
119+
</span>
120+
</dd>
153121
</div>
154-
</div>
122+
</dl>
155123
</div>
156124

157125
<ul

‎app/composables/useMarkdown.ts‎

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,34 @@ export function useMarkdown(options: MaybeRefOrGetter<UseMarkdownOptions>) {
1010
return computed(() => parseMarkdown(toValue(options)))
1111
}
1212

13-
// Strip markdown image badges from text
13+
/**
14+
* Each step strips one badge shape. Bounded quantifiers ({0,N}) guard against
15+
* ReDoS, and patterns are compiled once at module scope so reactive callers
16+
* don't pay re-instantiation cost on every render.
17+
*/
18+
const STRIPPABLE_MARKDOWN = Object.freeze([
19+
// Image atom: ![alt](url) OR reference-style ![alt][ref]
20+
/!\[[^\]]{0,500}\](?:\([^)]{0,2000}\)|\[[^\]]{0,500}\])/g,
21+
// Empty link wrapper left behind after image removal: [](url) OR [][ref]
22+
/\[\s*\](?:\([^)]{0,2000}\)?|\[[^\]]{0,500}\])/g,
23+
// Reference link definition line: [ref]: url "optional title"
24+
/^[ \t]*\[[^\]]{1,500}\]:[ \t]+\S{1,2000}(?:[ \t]+["'(].*?["')])?[ \t]*$/gm,
25+
])
26+
27+
/**
28+
* Strip markdown image badges from text.
29+
* Each pass removes image atoms, empty link wrappers, and reference defs.
30+
* Re-run to a fixed point so nested shapes like `[![…][ref]][ref]` collapse
31+
* without per-shape rules.
32+
*/
1433
function stripMarkdownImages(text: string): string {
15-
// Remove linked images: [![alt](image-url)](link-url) - handles incomplete URLs too
16-
// Using {0,500} instead of * to prevent ReDoS on pathological inputs
17-
text = text.replace(/\[!\[[^\]]{0,500}\]\([^)]{0,2000}\)\]\([^)]{0,2000}\)?/g, '')
18-
// Remove standalone images: ![alt](url)
19-
text = text.replace(/!\[[^\]]{0,500}\]\([^)]{0,2000}\)/g, '')
20-
// Remove any leftover empty links or broken markdown link syntax
21-
text = text.replace(/\[\]\([^)]{0,2000}\)?/g, '')
34+
let previous: string
35+
do {
36+
previous = text
37+
for (const pattern of STRIPPABLE_MARKDOWN) {
38+
text = text.replace(pattern, '')
39+
}
40+
} while (text !== previous)
2241
return text.trim()
2342
}
2443

‎i18n/locales/en.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -532,6 +532,7 @@
532532
"weekly_downloads": "Weekly downloads",
533533
"keywords": "Keywords",
534534
"license": "License",
535+
"version": "Version",
535536
"select": "Select package",
536537
"select_maximum": "Maximum {count} packages can be selected"
537538
},

‎i18n/schema.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1600,6 +1600,9 @@
16001600
"license": {
16011601
"type": "string"
16021602
},
1603+
"version": {
1604+
"type": "string"
1605+
},
16031606
"select": {
16041607
"type": "string"
16051608
},

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,34 @@ describe('useMarkdown', () => {
188188
expect(processed.value).toBe('A library')
189189
})
190190

191+
it('strips reference-style linked image badges (regression #2767)', () => {
192+
const processed = useMarkdown({
193+
text: '[![npm version][npm-v-src]][npm-v-href] [![npm downloads][npm-d-src]][npm-d-href] A library',
194+
})
195+
expect(processed.value).toBe('A library')
196+
})
197+
198+
it('returns empty when description is only reference-style badges (regression #2767)', () => {
199+
const processed = useMarkdown({
200+
text: '[![npm version][npm-v-src]][npm-v-href] [![npm downloads][npm-d-src]][npm-d-href]',
201+
})
202+
expect(processed.value).toBe('')
203+
})
204+
205+
it('strips standalone reference-style images', () => {
206+
const processed = useMarkdown({
207+
text: '![badge][badge-ref] A library',
208+
})
209+
expect(processed.value).toBe('A library')
210+
})
211+
212+
it('strips reference link definitions', () => {
213+
const processed = useMarkdown({
214+
text: 'A library\n\n[npm-v-src]: https://img.shields.io/npm/v/foo.svg\n[npm-v-href]: https://npm.im/foo',
215+
})
216+
expect(processed.value).toBe('A library')
217+
})
218+
191219
it('preserves regular markdown links', () => {
192220
const processed = useMarkdown({ text: '[documentation](https://docs.example.com) is here' })
193221
expect(processed.value).toBe(

0 commit comments

Comments
 (0)