Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-04-28 04:23:32 +01:00
Code Issues Packages Projects Releases Wiki Activity

markdown link smart pasting (#188437)

Browse Source 
* making markdown link pasting feature smarter

* update validateLink
This commit is contained in:
Meghan Kulkarni
2023-07-24 16:25:19 -07:00
committed by GitHub
parent f991a1ad7b
commit 87afa166d0
7 changed files with 225 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

193
extensions/markdown-language-features/src/test/markdownLink.test.ts
View File

@@ -5,128 +5,215 @@
import * as vscode from 'vscode';
import * as assert from 'assert';
import 'mocha';
import { checkSmartPaste, createLinkSnippet } from '../languageFeatures/copyFiles/shared';
import { SkinnyTextDocument, checkSmartPaste, createEditAddingLinksForUriList, appendToLinkSnippet } from '../languageFeatures/copyFiles/shared';
import { validateLink } from '../languageFeatures/copyFiles/copyPasteLinks';
suite('createEditAddingLinksForUriList', () => {
// end to end test of checkSmartPaste & createLinkSnippet
// check multicursor (end to end)
test('Markdown Link Pasting should occur for a valid link (end to end)', async () => {
// createEditAddingLinksForUriList -> checkSmartPaste -> tryGetUriListSnippet -> createUriListSnippet -> createLinkSnippet
const skinnyDocument: SkinnyTextDocument = {
uri: vscode.Uri.parse('file:///path/to/your/file'),
offsetAt: function () { return 0; },
getText: function () { return 'hello world!'; },
// lineAt: function (position: vscode.Position) {
// return {
// lineNumber: 0,
// text: 'hello world!',
// range: new vscode.Range(position, position),
// rangeIncludingLineBreak: new vscode.Range(position, position),
// firstNonWhitespaceCharacterIndex: 0,
// isEmptyOrWhitespace: false
// } as vscode.TextLine;
// }
};
const result = await createEditAddingLinksForUriList(skinnyDocument, [new vscode.Range(0, 0, 0, 12)], 'https://www.microsoft.com/', true, true, new vscode.CancellationTokenSource().token);
// need to check the actual result -> snippet value
assert.strictEqual(result?.label, 'Insert Markdown Link');
});
suite('validateLink', () => {
test('Markdown pasting should occur for a valid link.', () => {
const isLink = validateLink('https://www.microsoft.com');
const isLink = validateLink('https://www.microsoft.com/').isValid;
assert.strictEqual(isLink, true);
});
test('Markdown pasting should occur for a valid link preceded by a new line.', () => {
const isLink = validateLink('\r\nhttps://www.microsoft.com/').isValid;
assert.strictEqual(isLink, true);
});
test('Markdown pasting should occur for a valid link followed by a new line.', () => {
const isLink = validateLink('https://www.microsoft.com/\r\n').isValid;
assert.strictEqual(isLink, true);
});
test('Markdown pasting should not occur for a valid hostname and invalid protool.', () => {
const isLink = validateLink('invalid://www.microsoft.com');
const isLink = validateLink('invalid:www.microsoft.com').isValid;
assert.strictEqual(isLink, false);
});
test('Markdown pasting should not occur for plain text.', () => {
const isLink = validateLink('hello world!');
const isLink = validateLink('hello world!').isValid;
assert.strictEqual(isLink, false);
});
test('Markdown pasting should not occur for plain text including a colon.', () => {
const isLink = validateLink('hello: world!');
const isLink = validateLink('hello: world!').isValid;
assert.strictEqual(isLink, false);
});
test('Markdown pasting should not occur for plain text including a slashes.', () => {
const isLink = validateLink('hello//world!');
const isLink = validateLink('helloworld!').isValid;
assert.strictEqual(isLink, false);
});
test('Markdown pasting should not occur for a link followed by text.', () => {
const isLink = validateLink('https://www.microsoft.com hello world!');
const isLink = validateLink('https://www.microsoft.com/ hello world!').isValid;
assert.strictEqual(isLink, false);
});
test('Markdown pasting should not occur for a link preceded or followed by spaces.', () => {
const isLink = validateLink(' https://www.microsoft.com ');
assert.strictEqual(isLink, false);
test('Markdown pasting should occur for a link preceded or followed by spaces.', () => {
const isLink = validateLink(' https://www.microsoft.com/ ').isValid;
assert.strictEqual(isLink, true);
});
test('Markdown pasting should not occur for a link with an invalid scheme.', () => {
const isLink = validateLink('hello://www.microsoft.com');
const isLink = validateLink('hello:www.microsoft.com').isValid;
assert.strictEqual(isLink, false);
});
test('Markdown pasting should not occur for multiple links being pasted.', () => {
const isLink = validateLink('https://www.microsoft.com\r\nhttps://www.microsoft.com\r\nhttps://www.microsoft.com\r\nhttps://www.microsoft.com');
const isLink = validateLink('https://www.microsoft.com/\r\nhttps://www.microsoft.com/\r\nhttps://www.microsoft.com/\r\nhttps://www.microsoft.com/').isValid;
assert.strictEqual(isLink, false);
});
test('Markdown pasting should not occur for multiple links with spaces being pasted.', () => {
const isLink = validateLink('https://www.microsoft.com/ \r\nhttps://www.microsoft.com/\r\nhttps://www.microsoft.com/\r\n hello \r\nhttps://www.microsoft.com/').isValid;
assert.strictEqual(isLink, false);
});
});
suite('createLinkSnippet', () => {
suite('appendToLinkSnippet', () => {
test('Should not create Markdown link snippet when pasteAsMarkdownLink is false', () => {
const uri = vscode.Uri.parse('https://www.microsoft.com');
const snippet = createLinkSnippet(false, 'https://www.microsoft.com', '', uri, 0, true);
const uri = vscode.Uri.parse('https://www.microsoft.com/');
const snippet = appendToLinkSnippet(new vscode.SnippetString(''), false, 'https:/www.microsoft.com', '', uri, 0, true);
assert.strictEqual(snippet?.value, 'https://www.microsoft.com/');
});
test('Should create Markdown link snippet when pasteAsMarkdownLink is true', () => {
const uri = vscode.Uri.parse('https://www.microsoft.com');
const snippet = createLinkSnippet(true, 'https://www.microsoft.com', '', uri, 0, true);
const uri = vscode.Uri.parse('https://www.microsoft.com/');
const snippet = appendToLinkSnippet(new vscode.SnippetString(''), true, 'https:/www.microsoft.com', '', uri, 0, true);
assert.strictEqual(snippet?.value, '[${0:Title}](https://www.microsoft.com/)');
});
test('Should use an unencoded URI string in Markdown link when passing in an external browser link', () => {
const uri = vscode.Uri.parse('https://www.microsoft.com');
const snippet = createLinkSnippet(true, 'https://www.microsoft.com', '', uri, 0, true);
const uri = vscode.Uri.parse('https://www.microsoft.com/');
const snippet = appendToLinkSnippet(new vscode.SnippetString(''), true, 'https:/www.microsoft.com', '', uri, 0, true);
assert.strictEqual(snippet?.value, '[${0:Title}](https://www.microsoft.com/)');
});
});
suite('pasteAsMarkdownLink', () => {
suite('checkSmartPaste', () => {
const skinnyDocument: SkinnyTextDocument = {
uri: vscode.Uri.file('/path/to/your/file'),
offsetAt: function () { return 0; },
getText: function () { return 'hello world!'; },
// lineAt: function (position: vscode.Position) {
// return {
// lineNumber: 0,
// text: 'hello world!',
// range: new vscode.Range(position, position),
// rangeIncludingLineBreak: new vscode.Range(position, position),
// firstNonWhitespaceCharacterIndex: 0,
// isEmptyOrWhitespace: false
// } as vscode.TextLine;
// }
};
test('Should evaluate pasteAsMarkdownLink as true for selected plain text', () => {
const smartPaste = checkSmartPaste("hello! world", 0, 5);
const range = new vscode.Range(0, 5, 0, 5);
const smartPaste = checkSmartPaste(skinnyDocument, range);
assert.strictEqual(smartPaste.pasteAsMarkdownLink, true);
});
test('Should evaluate updateTitle as true for pasting over a Markdown link', () => {
const smartPaste = checkSmartPaste("[a](bc)", 0, 7);
assert.strictEqual(smartPaste.updateTitle, true);
});
test('Should evaluate updateTitle as true for pasting over a Markdown image link', () => {
const smartPaste = checkSmartPaste("![a](bc)", 0, 8);
assert.strictEqual(smartPaste.updateTitle, true);
});
test('Should evaluate pasteAsMarkdownLink as false for pasting within a Markdown link', () => {
const smartPaste = checkSmartPaste("[a](bcdef)", 4, 6);
assert.strictEqual(smartPaste.pasteAsMarkdownLink, false);
});
test('Should evaluate pasteAsMarkdownLink as false for pasting within a Markdown image link', () => {
const smartPaste = checkSmartPaste('![alt](https://)', 7, 15);
assert.strictEqual(smartPaste.pasteAsMarkdownLink, false);
});
test('Should evaluate pasteAsMarkdownLink as false for pasting within a code block', () => {
const smartPaste = checkSmartPaste('```\r\n\r\n```', 5, 5);
assert.strictEqual(smartPaste.pasteAsMarkdownLink, false);
});
test('Should evaluate pasteAsMarkdownLink as false for pasting within inline code', () => {
const smartPaste = checkSmartPaste('``', 1, 1);
skinnyDocument.getText = function () { return '```\r\n\r\n```'; };
const range = new vscode.Range(0, 5, 0, 5);
const smartPaste = checkSmartPaste(skinnyDocument, range);
assert.strictEqual(smartPaste.pasteAsMarkdownLink, false);
});
test('Should evaluate pasteAsMarkdownLink as false for pasting within a math block', () => {
const smartPaste = checkSmartPaste('$$$\r\n\r\n$$$', 5, 5);
skinnyDocument.getText = function () { return '$$$\r\n\r\n$$$'; };
const range = new vscode.Range(0, 5, 0, 5);
const smartPaste = checkSmartPaste(skinnyDocument, range);
assert.strictEqual(smartPaste.pasteAsMarkdownLink, false);
});
const linkSkinnyDoc: SkinnyTextDocument = {
uri: vscode.Uri.file('/path/to/your/file'),
offsetAt: function () { return 0; },
getText: function () { return '[a](bcdef)'; },
};
test('Should evaluate updateTitle as true for pasting over a Markdown link', () => {
const range = new vscode.Range(0, 0, 0, 10);
const smartPaste = checkSmartPaste(linkSkinnyDoc, range);
assert.strictEqual(smartPaste.updateTitle, true);
});
test('Should evaluate pasteAsMarkdownLink as false for pasting within a Markdown link', () => {
const range = new vscode.Range(0, 4, 0, 6);
const smartPaste = checkSmartPaste(linkSkinnyDoc, range);
assert.strictEqual(smartPaste.pasteAsMarkdownLink, false);
});
const imageLinkSkinnyDoc: SkinnyTextDocument = {
uri: vscode.Uri.file('/path/to/your/file'),
offsetAt: function () { return 0; },
getText: function () { return '![a](bcdef)'; },
};
test('Should evaluate updateTitle as true for pasting over a Markdown image link', () => {
const range = new vscode.Range(0, 0, 0, 11);
const smartPaste = checkSmartPaste(imageLinkSkinnyDoc, range);
assert.strictEqual(smartPaste.updateTitle, true);
});
test('Should evaluate pasteAsMarkdownLink as false for pasting within a Markdown image link', () => {
const range = new vscode.Range(0, 5, 0, 10);
const smartPaste = checkSmartPaste(imageLinkSkinnyDoc, range);
assert.strictEqual(smartPaste.pasteAsMarkdownLink, false);
});
const inlineCodeSkinnyCode: SkinnyTextDocument = {
uri: vscode.Uri.file('/path/to/your/file'),
offsetAt: function () { return 0; },
getText: function () { return '``'; },
};
test('Should evaluate pasteAsMarkdownLink as false for pasting within inline code', () => {
const range = new vscode.Range(0, 1, 0, 1);
const smartPaste = checkSmartPaste(inlineCodeSkinnyCode, range);
assert.strictEqual(smartPaste.pasteAsMarkdownLink, false);
});
const inlineMathSkinnyDoc: SkinnyTextDocument = {
uri: vscode.Uri.file('/path/to/your/file'),
offsetAt: function () { return 0; },
getText: function () { return '$$'; },
};
test('Should evaluate pasteAsMarkdownLink as false for pasting within inline math', () => {
const smartPaste = checkSmartPaste('$$', 1, 1);
const range = new vscode.Range(0, 1, 0, 1);
const smartPaste = checkSmartPaste(inlineMathSkinnyDoc, range);
assert.strictEqual(smartPaste.pasteAsMarkdownLink, false);
});
});