forked from npmx-dev/npmx.dev
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMarkdownText.spec.ts
More file actions
422 lines (378 loc) · 14.5 KB
/
MarkdownText.spec.ts
File metadata and controls
422 lines (378 loc) · 14.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
import { describe, expect, it } from 'vitest'
import { mountSuspended } from '@nuxt/test-utils/runtime'
import MarkdownText from '~/components/MarkdownText.vue'
describe('MarkdownText', () => {
describe('plain text', () => {
it('renders plain text unchanged', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: 'Hello world' },
})
expect(component.text()).toBe('Hello world')
})
it('returns empty for empty text', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: '' },
})
expect(component.text()).toBe('')
})
})
describe('HTML escaping', () => {
it('strips HTML tags to prevent XSS', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: '<script>alert("xss")</script>' },
})
// HTML tags should be stripped (not rendered)
expect(component.html()).not.toContain('<script>')
// Only the text content remains
expect(component.text()).toBe('alert("xss")')
})
it('escapes special characters', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: 'a < b && c > d' },
})
expect(component.text()).toBe('a < b && c > d')
})
})
describe('bold formatting', () => {
it('renders **text** as bold', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: 'This is **bold** text' },
})
const strong = component.find('strong')
expect(strong.exists()).toBe(true)
expect(strong.text()).toBe('bold')
})
it('renders __text__ as bold', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: 'This is __bold__ text' },
})
const strong = component.find('strong')
expect(strong.exists()).toBe(true)
expect(strong.text()).toBe('bold')
})
})
describe('italic formatting', () => {
it('renders *text* as italic', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: 'This is *italic* text' },
})
const em = component.find('em')
expect(em.exists()).toBe(true)
expect(em.text()).toBe('italic')
})
it('renders _text_ as italic', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: 'This is _italic_ text' },
})
const em = component.find('em')
expect(em.exists()).toBe(true)
expect(em.text()).toBe('italic')
})
})
describe('inline code', () => {
it('renders `code` in code tags', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: 'Run `npm install` to start' },
})
const code = component.find('code')
expect(code.exists()).toBe(true)
expect(code.text()).toBe('npm install')
})
})
describe('strikethrough', () => {
it('renders ~~text~~ as strikethrough', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: 'This is ~~deleted~~ text' },
})
const del = component.find('del')
expect(del.exists()).toBe(true)
expect(del.text()).toBe('deleted')
})
})
describe('links', () => {
it('renders [text](https://url) as a link', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: 'Visit [our site](https://example.com) for more' },
})
const link = component.find('a')
expect(link.exists()).toBe(true)
expect(link.attributes('href')).toBe('https://example.com/')
expect(link.text()).toBe('our site')
})
it('adds security attributes to links', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: '[link](https://example.com)' },
})
const link = component.find('a')
expect(link.attributes('rel')).toBe('nofollow noreferrer noopener')
expect(link.attributes('target')).toBe('_blank')
})
it('allows mailto: links', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: 'Contact [us](mailto:test@example.com)' },
})
const link = component.find('a')
expect(link.exists()).toBe(true)
expect(link.attributes('href')).toBe('mailto:test@example.com')
})
it('blocks javascript: protocol links', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: '[click me](javascript:alert("xss"))' },
})
const link = component.find('a')
expect(link.exists()).toBe(false)
expect(component.text()).toContain('click me')
})
it('blocks http: links (only https allowed)', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: '[site](http://example.com)' },
})
const link = component.find('a')
expect(link.exists()).toBe(false)
expect(component.text()).toContain('site')
})
it('handles invalid URLs gracefully', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: '[link](not a valid url)' },
})
const link = component.find('a')
expect(link.exists()).toBe(false)
expect(component.text()).toContain('link')
})
it('handles URLs with ampersands', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: '[search](https://example.com?a=1&b=2)' },
})
const link = component.find('a')
expect(link.exists()).toBe(true)
expect(link.attributes('href')).toBe('https://example.com/?a=1&b=2')
})
})
describe('plain prop', () => {
it('renders link text without anchor tag when plain=true', async () => {
const component = await mountSuspended(MarkdownText, {
props: {
text: 'Visit [our site](https://example.com) for more',
plain: true,
},
})
const link = component.find('a')
expect(link.exists()).toBe(false)
expect(component.text()).toBe('Visit our site for more')
})
it('still renders other formatting when plain=true', async () => {
const component = await mountSuspended(MarkdownText, {
props: {
text: '**bold** and [link](https://example.com)',
plain: true,
},
})
const strong = component.find('strong')
const link = component.find('a')
expect(strong.exists()).toBe(true)
expect(link.exists()).toBe(false)
expect(component.text()).toBe('bold and link')
})
})
describe('combined formatting', () => {
it('handles multiple formatting in one string', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: '**bold** and *italic* and `code`' },
})
expect(component.find('strong').exists()).toBe(true)
expect(component.find('em').exists()).toBe(true)
expect(component.find('code').exists()).toBe(true)
})
})
describe('markdown image stripping', () => {
it('strips standalone markdown images', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: ' A library' },
})
expect(component.text()).toBe('A library')
})
it('strips linked markdown images (badges)', async () => {
const component = await mountSuspended(MarkdownText, {
props: {
text: '[](https://travis-ci.org/user/repo) A library',
},
})
expect(component.text()).toBe('A library')
})
it('strips multiple badges', async () => {
const component = await mountSuspended(MarkdownText, {
props: {
text: '[](https://npm.com) [](https://ci.com) A library',
},
})
expect(component.text()).toBe('A library')
})
it('preserves malformed image syntax without closing paren', async () => {
// Incomplete/malformed markdown images are left as-is for safety
const component = await mountSuspended(MarkdownText, {
props: { text: '
// The image syntax is not stripped because it's malformed (no closing paren)
expect(component.text()).toBe('
})
it('strips empty link syntax', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: '[](https://example.com) A library' },
})
expect(component.text()).toBe('A library')
})
it('preserves regular markdown links', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: '[documentation](https://docs.example.com) is here' },
})
const link = component.find('a')
expect(link.exists()).toBe(true)
expect(link.text()).toBe('documentation')
expect(component.text()).toBe('documentation is here')
})
})
describe('packageName prop', () => {
// Package name stripping ONLY happens for descriptions with HTML tags or markdown images
// Normal plain text descriptions should keep the package name (like "Nuxt is a framework...")
it('does NOT strip package name from plain text descriptions', async () => {
// Plain text descriptions should be kept as-is
const component = await mountSuspended(MarkdownText, {
props: {
text: 'my-package - A great library',
packageName: 'my-package',
},
})
expect(component.text()).toBe('my-package - A great library')
})
it('does NOT strip package name from plain text with colon', async () => {
const component = await mountSuspended(MarkdownText, {
props: {
text: 'my-package: A great library',
packageName: 'my-package',
},
})
expect(component.text()).toBe('my-package: A great library')
})
it('strips package name from HTML-containing descriptions', async () => {
const component = await mountSuspended(MarkdownText, {
props: {
text: '<b>my-package</b> - A great library',
packageName: 'my-package',
},
})
expect(component.text()).toBe('A great library')
})
it('strips package name from HTML descriptions with colon separator', async () => {
const component = await mountSuspended(MarkdownText, {
props: {
text: '<div>my-package: A great library</div>',
packageName: 'my-package',
},
})
expect(component.text()).toBe('A great library')
})
it('strips package name from HTML descriptions with em dash', async () => {
const component = await mountSuspended(MarkdownText, {
props: {
text: '<span>my-package — A great library</span>',
packageName: 'my-package',
},
})
expect(component.text()).toBe('A great library')
})
it('is case-insensitive for HTML descriptions', async () => {
const component = await mountSuspended(MarkdownText, {
props: {
text: '<b>MY-PACKAGE</b> - A great library',
packageName: 'my-package',
},
})
expect(component.text()).toBe('A great library')
})
it('does not strip package name from middle of HTML text', async () => {
const component = await mountSuspended(MarkdownText, {
props: {
text: '<div>A great my-package library</div>',
packageName: 'my-package',
},
})
expect(component.text()).toBe('A great my-package library')
})
it('handles scoped package names in HTML descriptions', async () => {
const component = await mountSuspended(MarkdownText, {
props: {
text: '<b>@org/my-package</b> - A great library',
packageName: '@org/my-package',
},
})
expect(component.text()).toBe('A great library')
})
it('handles package names with special regex characters in HTML', async () => {
const component = await mountSuspended(MarkdownText, {
props: {
text: '<b>pkg.name+test</b> - A great library',
packageName: 'pkg.name+test',
},
})
expect(component.text()).toBe('A great library')
})
it('strips package name from descriptions with markdown images', async () => {
const component = await mountSuspended(MarkdownText, {
props: {
text: ' my-package - A great library',
packageName: 'my-package',
},
})
expect(component.text()).toBe('A great library')
})
it('does nothing when packageName is not provided', async () => {
const component = await mountSuspended(MarkdownText, {
props: {
text: 'my-package - A great library',
},
})
expect(component.text()).toBe('my-package - A great library')
})
})
describe('HTML tag stripping', () => {
it('strips simple HTML tags but keeps content', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: '<b>bold text</b> here' },
})
expect(component.text()).toBe('bold text here')
expect(component.html()).not.toContain('<b>')
})
it('strips nested HTML tags', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: '<div><span>nested</span> content</div>' },
})
expect(component.text()).toBe('nested content')
})
it('strips self-closing tags', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: 'before<br/>after' },
})
expect(component.text()).toBe('beforeafter')
})
it('strips tags with attributes', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: '<a href="https://evil.com">click me</a>' },
})
expect(component.text()).toBe('click me')
expect(component.find('a').exists()).toBe(false)
})
it('preserves text that looks like comparison operators', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: 'x < y > z and a < b && c > d' },
})
expect(component.text()).toBe('x < y > z and a < b && c > d')
})
it('handles mixed HTML and markdown', async () => {
const component = await mountSuspended(MarkdownText, {
props: { text: '<b>bold</b> and **also bold**' },
})
expect(component.text()).toBe('bold and also bold')
expect(component.find('strong').exists()).toBe(true)
})
})
})