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

Use <...> style markdown links when needed #183876

Merged
merged 1 commit into from
May 30, 2023
Merged

Use <...> style markdown links when needed #183876

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 47 additions & 5 deletions 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 @@ -118,12 +118,12 @@ export function createUriListSnippet(

if (insertAsVideo) {
insertedAudioVideoCount++;
snippet.appendText(`<video src="${mdPath}" controls title="`);
snippet.appendText(`<video src="${escapeHtmlAttribute(mdPath)}" controls title="`);
snippet.appendPlaceholder('Title');
snippet.appendText('"></video>');
} else if (insertAsAudio) {
insertedAudioVideoCount++;
snippet.appendText(`<audio src="${mdPath}" controls title="`);
snippet.appendText(`<audio src="${escapeHtmlAttribute(mdPath)}" controls title="`);
snippet.appendPlaceholder('Title');
snippet.appendText('"></audio>');
} else {
Expand All @@ -139,7 +139,7 @@ export function createUriListSnippet(
const placeholderIndex = typeof options?.placeholderStartIndex !== 'undefined' ? options?.placeholderStartIndex + i : undefined;
snippet.appendPlaceholder(placeholderText, placeholderIndex);

snippet.appendText(`](${mdPath})`);
snippet.appendText(`](${escapeMarkdownLinkPath(mdPath)})`);
}

if (i < uris.length - 1 && uris.length > 1) {
Expand Down Expand Up @@ -246,11 +246,53 @@ function getMdPath(dir: vscode.Uri | undefined, file: vscode.Uri) {
// so that drive-letters are resolved cast insensitively. However we then want to
// convert back to a posix path to insert in to the document.
const relativePath = path.relative(dir.fsPath, file.fsPath);
return encodeURI(path.posix.normalize(relativePath.split(path.sep).join(path.posix.sep)));
return path.posix.normalize(relativePath.split(path.sep).join(path.posix.sep));
}

return encodeURI(path.posix.relative(dir.path, file.path));
return path.posix.relative(dir.path, file.path);
}

return file.toString(false);
}

function escapeHtmlAttribute(attr: string): string {
return encodeURI(attr).replaceAll('"', '&quot;');
}

function escapeMarkdownLinkPath(mdPath: string): string {
if (needsBracketLink(mdPath)) {
return '<' + mdPath.replace('<', '\\<').replace('>', '\\>') + '>';
}

return encodeURI(mdPath);
}

function needsBracketLink(mdPath: string) {
// Links with whitespace or control characters must be enclosed in brackets
if (mdPath.startsWith('<') || /\s|[\u007F\u0000-\u001f]/.test(mdPath)) {
return true;
}

// Check if the link has mis-matched parens
if (!/[\(\)]/.test(mdPath)) {
return false;
}

let previousChar = '';
let nestingCount = 0;
for (const char of mdPath) {
if (char === '(' && previousChar !== '\\') {
nestingCount++;
} else if (char === ')' && previousChar !== '\\') {
nestingCount--;
}

if (nestingCount < 0) {
return true;
}
previousChar = char;
}

return nestingCount > 0;
}