Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Links are not automatically pasted as markdown over valid urls #189347

Merged
merged 5 commits into from
Jul 31, 2023
Merged

Links are not automatically pasted as markdown over valid urls #189347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7ce5dd8
check if selected text is link
MeghanKulkarni Jul 31, 2023
48846e4
Merge branch 'main' into MeghanKulkarni/existing-url
MeghanKulkarni Jul 31, 2023
9681167
Merge branch 'main' into MeghanKulkarni/existing-url
MeghanKulkarni Jul 31, 2023
9bc60f6
Merge branch 'main' into MeghanKulkarni/existing-url
MeghanKulkarni Jul 31, 2023
40f669e
add to validateLink
MeghanKulkarni Jul 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 1 addition & 17 deletions extensions/markdown-language-features/src/languageFeatures/copyFiles/copyPasteLinks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*--------------------------------------------------------------------------------------------*/

import * as vscode from 'vscode';
import { externalUriSchemes, createEditAddingLinksForUriList, getPasteUrlAsFormattedLinkSetting, PasteUrlAsFormattedLink } from './shared';
import { createEditAddingLinksForUriList, getPasteUrlAsFormattedLinkSetting, PasteUrlAsFormattedLink, validateLink } from './shared';
class PasteLinkEditProvider implements vscode.DocumentPasteEditProvider {

readonly id = 'insertMarkdownLink';
Expand Down Expand Up @@ -46,22 +46,6 @@ class PasteLinkEditProvider implements vscode.DocumentPasteEditProvider {
}
}

export function validateLink(urlList: string): { isValid: boolean; cleanedUrlList: string } {
let isValid = false;
let uri = undefined;
const trimmedUrlList = urlList?.trim(); //remove leading and trailing whitespace and new lines
try {
uri = vscode.Uri.parse(trimmedUrlList);
} catch (error) {
return { isValid: false, cleanedUrlList: urlList };
}
const splitUrlList = trimmedUrlList.split(' ').filter(item => item !== ''); //split on spaces and remove empty strings
if (uri) {
isValid = splitUrlList.length === 1 && !splitUrlList[0].includes('\n') && externalUriSchemes.includes(vscode.Uri.parse(splitUrlList[0]).scheme) && !!vscode.Uri.parse(splitUrlList[0]).authority;
}
return { isValid, cleanedUrlList: splitUrlList[0] };
}

export function registerLinkPasteSupport(selector: vscode.DocumentSelector,) {
return vscode.languages.registerDocumentPasteEditProvider(selector, new PasteLinkEditProvider(), {
pasteMimeTypes: [
Expand Down
18 changes: 17 additions & 1 deletion extensions/markdown-language-features/src/languageFeatures/copyFiles/shared.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ export async function createEditAddingLinksForUriList(

export function checkSmartPaste(document: SkinnyTextDocument, selectedRange: vscode.Range): SmartPaste {
const SmartPaste: SmartPaste = { pasteAsMarkdownLink: true, updateTitle: false };
if (selectedRange.isEmpty || /^[\s\n]*$/.test(document.getText(selectedRange))) {
if (selectedRange.isEmpty || /^[\s\n]*$/.test(document.getText(selectedRange)) || validateLink(document.getText(selectedRange)).isValid) {
return { pasteAsMarkdownLink: false, updateTitle: false };
}
for (const regex of smartPasteRegexes) {
Expand All @@ -170,6 +170,22 @@ export function checkSmartPaste(document: SkinnyTextDocument, selectedRange: vsc
return SmartPaste;
}

export function validateLink(urlList: string): { isValid: boolean; cleanedUrlList: string } {
let isValid = false;
let uri = undefined;
const trimmedUrlList = urlList?.trim(); //remove leading and trailing whitespace and new lines
try {
uri = vscode.Uri.parse(trimmedUrlList);
} catch (error) {
return { isValid: false, cleanedUrlList: urlList };
}
const splitUrlList = trimmedUrlList.split(' ').filter(item => item !== ''); //split on spaces and remove empty strings
if (uri) {
isValid = splitUrlList.length === 1 && !splitUrlList[0].includes('\n') && externalUriSchemes.includes(vscode.Uri.parse(splitUrlList[0]).scheme) && !!vscode.Uri.parse(splitUrlList[0]).authority;
}
return { isValid, cleanedUrlList: splitUrlList[0] };
}

export async function tryGetUriListSnippet(document: SkinnyTextDocument, urlList: String, token: vscode.CancellationToken, title = '', placeHolderValue = 0, pasteAsMarkdownLink = true, isExternalLink = false): Promise<{ snippet: vscode.SnippetString; label: string } | undefined> {
if (token.isCancellationRequested) {
return undefined;
Expand Down
17 changes: 15 additions & 2 deletions extensions/markdown-language-features/src/test/markdownLink.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
import * as vscode from 'vscode';
import * as assert from 'assert';
import 'mocha';
import { SkinnyTextDocument, checkSmartPaste, createEditAddingLinksForUriList, appendToLinkSnippet } from '../languageFeatures/copyFiles/shared';
import { validateLink } from '../languageFeatures/copyFiles/copyPasteLinks';
import { SkinnyTextDocument, checkSmartPaste, createEditAddingLinksForUriList, appendToLinkSnippet, validateLink } from '../languageFeatures/copyFiles/shared';
suite('createEditAddingLinksForUriList', () => {

test('Markdown Link Pasting should occur for a valid link (end to end)', async () => {
Expand Down Expand Up @@ -170,6 +169,20 @@ suite('createEditAddingLinksForUriList', () => {
assert.strictEqual(smartPaste.pasteAsMarkdownLink, true);
});

test('Should evaluate pasteAsMarkdownLink as false for a valid selected link', () => {
skinnyDocument.getText = function () { return 'https://www.microsoft.com'; };
const range = new vscode.Range(0, 0, 0, 25);
const smartPaste = checkSmartPaste(skinnyDocument, range);
assert.strictEqual(smartPaste.pasteAsMarkdownLink, false);
});

test('Should evaluate pasteAsMarkdownLink as false for a valid selected link with trailing whitespace', () => {
skinnyDocument.getText = function () { return ' https://www.microsoft.com '; };
const range = new vscode.Range(0, 0, 0, 30);
const smartPaste = checkSmartPaste(skinnyDocument, range);
assert.strictEqual(smartPaste.pasteAsMarkdownLink, false);
});

test('Should evaluate pasteAsMarkdownLink as false for no selection', () => {
const range = new vscode.Range(0, 0, 0, 0);
const smartPaste = checkSmartPaste(skinnyDocument, range);
Expand Down