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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as assert from 'assert';
import 'mocha';
import * as vscode from 'vscode';
import { MdLink, MdLinkComputer, MdLinkProvider, MdVsCodeLinkProvider } from '../languageFeatures/documentLinks';
import { noopToken } from '../util/cancellation';
import { InMemoryDocument } from '../util/inMemoryDocument';
import { createNewMarkdownEngine } from './engine';
import { InMemoryMdWorkspace } from './inMemoryWorkspace';
import { nulLogger } from './nulLogging';
import { assertRangeEqual, joinLines, workspacePath } from './util';
suite.only('Markdown: MdLinkComputer', () => {
function getLinksForFile(fileContents: string): Promise<MdLink[]> {
const doc = new InMemoryDocument(workspacePath('x.md'), fileContents);
const engine = createNewMarkdownEngine();
const linkProvider = new MdLinkComputer(engine);
return linkProvider.getAllLinks(doc, noopToken);
}
function assertLinksEqual(actualLinks: readonly MdLink[], expected: ReadonlyArray<vscode.Range | { readonly range: vscode.Range; readonly sourceText: string }>) {
assert.strictEqual(actualLinks.length, expected.length);
for (let i = 0; i < actualLinks.length; ++i) {
const exp = expected[i];
if ('range' in exp) {
assertRangeEqual(actualLinks[i].source.hrefRange, exp.range, `Range ${i} to be equal`);
assert.strictEqual(actualLinks[i].source.hrefText, exp.sourceText, `Source text ${i} to be equal`);
} else {
assertRangeEqual(actualLinks[i].source.hrefRange, exp, `Range ${i} to be equal`);
}
}
}
test('Should not return anything for empty document', async () => {
const links = await getLinksForFile('');
assertLinksEqual(links, []);
});
test('Should not return anything for simple document without links', async () => {
const links = await getLinksForFile(joinLines(
'# a',
'fdasfdfsafsa',
));
assertLinksEqual(links, []);
});
test('Should detect basic http links', async () => {
const links = await getLinksForFile('a [b](https://example.com) c');
assertLinksEqual(links, [
new vscode.Range(0, 6, 0, 25)
]);
});
test('Should detect basic workspace links', async () => {
{
const links = await getLinksForFile('a [b](./file) c');
assertLinksEqual(links, [
new vscode.Range(0, 6, 0, 12)
]);
}
{
const links = await getLinksForFile('a [b](file.png) c');
assertLinksEqual(links, [
new vscode.Range(0, 6, 0, 14)
]);
}
});
test('Should detect links with title', async () => {
const links = await getLinksForFile('a [b](https://example.com "abc") c');
assertLinksEqual(links, [
new vscode.Range(0, 6, 0, 25)
]);
});
test('Should handle links with escaped characters in name (#35245)', async () => {
const links = await getLinksForFile('a [b\\]](./file)');
assertLinksEqual(links, [
new vscode.Range(0, 8, 0, 14)
]);
});
test('Should handle links with balanced parens', async () => {
{
const links = await getLinksForFile('a [b](https://example.com/a()c) c');
assertLinksEqual(links, [
new vscode.Range(0, 6, 0, 30)
]);
}
{
const links = await getLinksForFile('a [b](https://example.com/a(b)c) c');
assertLinksEqual(links, [
new vscode.Range(0, 6, 0, 31)
]);
}
{
// #49011
const links = await getLinksForFile('[A link](http://ThisUrlhasParens/A_link(in_parens))');
assertLinksEqual(links, [
new vscode.Range(0, 9, 0, 50)
]);
}
});
test('Should ignore bracketed text inside link title (#150921)', async () => {
{
const links = await getLinksForFile('[some [inner] in title](link)');
assertLinksEqual(links, [
new vscode.Range(0, 24, 0, 28),
]);
}
{
const links = await getLinksForFile('[some [inner] in title](<link>)');
assertLinksEqual(links, [
new vscode.Range(0, 25, 0, 29),
]);
}
{
const links = await getLinksForFile('[some [inner with space] in title](link)');
assertLinksEqual(links, [
new vscode.Range(0, 35, 0, 39),
]);
}
});
test('Should handle two links without space', async () => {
const links = await getLinksForFile('a ([test](test)[test2](test2)) c');
assertLinksEqual(links, [
new vscode.Range(0, 10, 0, 14),
new vscode.Range(0, 23, 0, 28)
]);
});
test('should handle hyperlinked images (#49238)', async () => {
{
const links = await getLinksForFile('[![alt text](image.jpg)](https://example.com)');
assertLinksEqual(links, [
new vscode.Range(0, 25, 0, 44),
new vscode.Range(0, 13, 0, 22),
]);
}
{
const links = await getLinksForFile('[![a]( whitespace.jpg )]( https://whitespace.com )');
assertLinksEqual(links, [
new vscode.Range(0, 26, 0, 48),
new vscode.Range(0, 7, 0, 21),
]);
}
{
const links = await getLinksForFile('[![a](img1.jpg)](file1.txt) text [![a](img2.jpg)](file2.txt)');
assertLinksEqual(links, [
new vscode.Range(0, 17, 0, 26),
new vscode.Range(0, 6, 0, 14),
new vscode.Range(0, 50, 0, 59),
new vscode.Range(0, 39, 0, 47),
]);
}
});
test('Should not consider link references starting with ^ character valid (#107471)', async () => {
const links = await getLinksForFile('[^reference]: https://example.com');
assertLinksEqual(links, []);
});
test('Should find definitions links with spaces in angle brackets (#136073)', async () => {
const links = await getLinksForFile(joinLines(
'[a]: <b c>',
'[b]: <cd>',
));
assertLinksEqual(links, [
{ range: new vscode.Range(0, 6, 0, 9), sourceText: 'b c' },
{ range: new vscode.Range(1, 6, 1, 8), sourceText: 'cd' },
]);
});
test('Should only find one link for reference sources [a]: source (#141285)', async () => {
const links = await getLinksForFile(joinLines(
'[Works]: https://example.com',
));
assertLinksEqual(links, [
{ range: new vscode.Range(0, 9, 0, 28), sourceText: 'https://example.com' },
]);
});
test('Should find reference link shorthand (#141285)', async () => {
const links = await getLinksForFile(joinLines(
'[ref]',
'[ref]: https://example.com',
));
assertLinksEqual(links, [
{ range: new vscode.Range(0, 1, 0, 4), sourceText: 'ref' },
{ range: new vscode.Range(1, 7, 1, 26), sourceText: 'https://example.com' },
]);
});
test('Should find reference link shorthand using empty closing brackets (#141285)', async () => {
const links = await getLinksForFile(joinLines(
'[ref][]',
));
assertLinksEqual(links, [
new vscode.Range(0, 1, 0, 4),
]);
});
test.skip('Should find reference link shorthand for link with space in label (#141285)', async () => {
const links = await getLinksForFile(joinLines(
'[ref with space]',
));
assertLinksEqual(links, [
new vscode.Range(0, 7, 0, 26),
]);
});
test('Should not include reference links with escaped leading brackets', async () => {
const links = await getLinksForFile(joinLines(
`\\[bad link][good]`,
`\\[good]`,
`[good]: http://example.com`,
));
assertLinksEqual(links, [
new vscode.Range(2, 8, 2, 26) // Should only find the definition
]);
});
test('Should not consider links in code fenced with backticks', async () => {
const links = await getLinksForFile(joinLines(
'```',
'[b](https://example.com)',
'```'));
assertLinksEqual(links, []);
});
test('Should not consider links in code fenced with tilde', async () => {
const links = await getLinksForFile(joinLines(
'~~~',
'[b](https://example.com)',
'~~~'));
assertLinksEqual(links, []);
});
test('Should not consider links in indented code', async () => {
const links = await getLinksForFile(' [b](https://example.com)');
assertLinksEqual(links, []);
});
test('Should not consider links in inline code span', async () => {
const links = await getLinksForFile('`[b](https://example.com)`');
assertLinksEqual(links, []);
});
test('Should not consider links with code span inside', async () => {
const links = await getLinksForFile('[li`nk](https://example.com`)');
assertLinksEqual(links, []);
});
test('Should not consider links in multiline inline code span', async () => {
const links = await getLinksForFile(joinLines(
'`` ',
'[b](https://example.com)',
'``'));
assertLinksEqual(links, []);
});
test('Should not consider link references in code fenced with backticks (#146714)', async () => {
const links = await getLinksForFile(joinLines(
'```',
'[a] [bb]',
'```'));
assertLinksEqual(links, []);
});
test('Should not consider reference sources in code fenced with backticks (#146714)', async () => {
const links = await getLinksForFile(joinLines(
'```',
'[a]: http://example.com;',
'[b]: <http://example.com>;',
'[c]: (http://example.com);',
'```'));
assertLinksEqual(links, []);
});
test('Should not consider links in multiline inline code span between between text', async () => {
const links = await getLinksForFile(joinLines(
'[b](https://1.com) `[b](https://2.com)',
'[b](https://3.com) ` [b](https://4.com)'));
assertLinksEqual(links, [
new vscode.Range(0, 4, 0, 17),
new vscode.Range(1, 25, 1, 38),
]);
});
test('Should not consider links in multiline inline code span with new line after the first backtick', async () => {
const links = await getLinksForFile(joinLines(
'`',
'[b](https://example.com)`'));
assertLinksEqual(links, []);
});
test('Should not miss links in invalid multiline inline code span', async () => {
const links = await getLinksForFile(joinLines(
'`` ',
'',
'[b](https://example.com)',
'',
'``'));
assertLinksEqual(links, [
new vscode.Range(2, 4, 2, 23)
]);
});
test('Should find autolinks', async () => {
const links = await getLinksForFile('pre <http://example.com> post');
assertLinksEqual(links, [
new vscode.Range(0, 5, 0, 23)
]);
});
test('Should not detect links inside html comment blocks', async () => {
const links = await getLinksForFile(joinLines(
`<!-- <http://example.com> -->`,
`<!-- [text](./foo.md) -->`,
`<!-- [text]: ./foo.md -->`,
``,
`<!--`,
`<http://example.com>`,
`-->`,
``,
`<!--`,
`[text](./foo.md)`,
`-->`,
``,
`<!--`,
`[text]: ./foo.md`,
`-->`,
));
assertLinksEqual(links, []);
});
test.skip('Should not detect links inside inline html comments', async () => {
// See #149678
const links = await getLinksForFile(joinLines(
`text <!-- <http://example.com> --> text`,
`text <!-- [text](./foo.md) --> text`,
`text <!-- [text]: ./foo.md --> text`,
``,
`text <!--`,
`<http://example.com>`,
`--> text`,
``,
`text <!--`,
`[text](./foo.md)`,
`--> text`,
``,
`text <!--`,
`[text]: ./foo.md`,
`--> text`,
));
assertLinksEqual(links, []);
});
test('Should not mark checkboxes as links', async () => {
const links = await getLinksForFile(joinLines(
'- [x]',
'- [X]',
'- [ ]',
'* [x]',
'* [X]',
'* [ ]',
``,
`[x]: http://example.com`
));
assertLinksEqual(links, [
new vscode.Range(7, 5, 7, 23)
]);
});
test('Should still find links on line with checkbox', async () => {
const links = await getLinksForFile(joinLines(
'- [x] [x]',
'- [X] [x]',
'- [] [x]',
``,
`[x]: http://example.com`
));
assertLinksEqual(links, [
new vscode.Range(0, 7, 0, 8),
new vscode.Range(1, 7, 1, 8),
new vscode.Range(2, 6, 2, 7),
new vscode.Range(4, 5, 4, 23),
]);
});
test('Should find link only within angle brackets.', async () => {
const links = await getLinksForFile(joinLines(
`[link](<path>)`
));
assertLinksEqual(links, [new vscode.Range(0, 8, 0, 12)]);
});
test('Should find link within angle brackets even with link title.', async () => {
const links = await getLinksForFile(joinLines(
`[link](<path> "test title")`
));
assertLinksEqual(links, [new vscode.Range(0, 8, 0, 12)]);
});
test('Should find link within angle brackets even with surrounding spaces.', async () => {
const links = await getLinksForFile(joinLines(
`[link]( <path> )`
));
assertLinksEqual(links, [new vscode.Range(0, 9, 0, 13)]);
});
test('Should find link within angle brackets for image hyperlinks.', async () => {
const links = await getLinksForFile(joinLines(
`![link](<path>)`
));
assertLinksEqual(links, [new vscode.Range(0, 9, 0, 13)]);
});
test('Should find link with spaces in angle brackets for image hyperlinks with titles.', async () => {
const links = await getLinksForFile(joinLines(
`![link](< path > "test")`
));
assertLinksEqual(links, [new vscode.Range(0, 9, 0, 15)]);
});
test('Should not find link due to incorrect angle bracket notation or usage.', async () => {
const links = await getLinksForFile(joinLines(
`[link](<path )`,
`[link](<> path>)`,
`[link](> path)`,
));
assertLinksEqual(links, []);
});
test('Should find link within angle brackets even with space inside link.', async () => {
const links = await getLinksForFile(joinLines(
`[link](<pa th>)`
));
assertLinksEqual(links, [new vscode.Range(0, 8, 0, 13)]);
});
test('Should find links with titles', async () => {
const links = await getLinksForFile(joinLines(
`[link](<no such.md> "text")`,
`[link](<no such.md> 'text')`,
`[link](<no such.md> (text))`,
`[link](no-such.md "text")`,
`[link](no-such.md 'text')`,
`[link](no-such.md (text))`,
));
assertLinksEqual(links, [
new vscode.Range(0, 8, 0, 18),
new vscode.Range(1, 8, 1, 18),
new vscode.Range(2, 8, 2, 18),
new vscode.Range(3, 7, 3, 17),
new vscode.Range(4, 7, 4, 17),
new vscode.Range(5, 7, 5, 17),
]);
});
test('Should not include link with empty angle bracket', async () => {
const links = await getLinksForFile(joinLines(
`[](<>)`,
`[link](<>)`,
`[link](<> "text")`,
`[link](<> 'text')`,
`[link](<> (text))`,
));
assertLinksEqual(links, []);
});
});
suite('Markdown: VS Code DocumentLinkProvider', () => {
function getLinksForFile(fileContents: string) {
const doc = new InMemoryDocument(workspacePath('x.md'), fileContents);
const workspace = new InMemoryMdWorkspace([doc]);
const engine = createNewMarkdownEngine();
const linkProvider = new MdLinkProvider(engine, workspace, nulLogger);
const provider = new MdVsCodeLinkProvider(linkProvider);
return provider.provideDocumentLinks(doc, noopToken);
}
function assertLinksEqual(actualLinks: readonly vscode.DocumentLink[], expectedRanges: readonly vscode.Range[]) {
assert.strictEqual(actualLinks.length, expectedRanges.length);
for (let i = 0; i < actualLinks.length; ++i) {
assertRangeEqual(actualLinks[i].range, expectedRanges[i], `Range ${i} to be equal`);
}
}
test('Should include defined reference links (#141285)', async () => {
const links = await getLinksForFile(joinLines(
'[ref]',
'[ref][]',
'[ref][ref]',
'',
'[ref]: http://example.com'
));
assertLinksEqual(links, [
new vscode.Range(0, 1, 0, 4),
new vscode.Range(1, 1, 1, 4),
new vscode.Range(2, 6, 2, 9),
new vscode.Range(4, 7, 4, 25),
]);
});
test('Should not include reference link shorthand when definition does not exist (#141285)', async () => {
const links = await getLinksForFile('[ref]');
assertLinksEqual(links, []);
});
});
|