Don't interpret escaped links as backlinks

svsool · Jul 30, 2020 · b7df0d5 · b7df0d5
1 parent 9860a98
commit b7df0d5
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 1 deletion.
diff --git a/src/extensions/BacklinksTreeDataProvider.spec.ts b/src/extensions/BacklinksTreeDataProvider.spec.ts
@@ -301,6 +301,41 @@ describe('BacklinksTreeDataProvider()', () => {
  ]);
  });
 
+ it('should not provide backlinks for link within code span', async () => {
+ const link = rndName();
+ const name0 = rndName();
+
+ await createFile(`${link}.md`);
+ await createFile(`a-${name0}.md`, `\`[[${link}]]\``);
+
+ const doc = await openTextDocument(`${link}.md`);
+ await window.showTextDocument(doc);
+
+ expect(toPlainObject(await getChildren())).toHaveLength(0);
+ });
+
+ it('should not provide backlinks for link within fenced code block', async () => {
+ const link = rndName();
+ const name0 = rndName();
+
+ await createFile(`${link}.md`);
+ await createFile(
+ `a-${name0}.md`,
+ `
+ \`\`\`
+ Preceding text
+ [[${link}]]
+ Following text
+ \`\`\`
+ `,
+ );
+
+ const doc = await openTextDocument(`${link}.md`);
+ await window.showTextDocument(doc);
+
+ expect(toPlainObject(await getChildren())).toHaveLength(0);
+ });
+
  it('should collapse parent items according to configuration', async () => {
  const link = rndName();
  const name0 = rndName();

diff --git a/src/extensions/DocumentLinkProvider.ts b/src/extensions/DocumentLinkProvider.ts
@@ -8,6 +8,7 @@ export default class DocumentLinkProvider implements vscode.DocumentLinkProvider
  public provideDocumentLinks(document: vscode.TextDocument): vscode.DocumentLink[] {
  const results: vscode.DocumentLink[] = [];
 
+ // TODO: Refactor to use ref utils
  document
  .getText()
  .split(/\r?\n/g)

diff --git a/src/extensions/newVersionNotifier.spec.ts b/src/extensions/newVersionNotifier.spec.ts
@@ -11,7 +11,6 @@ describe('newVersionNotifier extension', () => {
 
  it('should not fail on activate', () => {
  expect(() => {
- console.log('test', path.resolve(path.join(__dirname, '..', '..')));
  const mockContext = ({
  subscriptions: [],
  extensionPath: path.resolve(path.join(__dirname, '..', '..')),

diff --git a/src/utils/utils.ts b/src/utils/utils.ts
@@ -180,6 +180,14 @@ export const findReferences = async (
 
  const refStart = currentDocument.positionAt(offset);
  const lineStart = currentDocument.lineAt(refStart);
+
+ if (
+ isInFencedCodeBlock(currentDocument, lineStart.lineNumber) ||
+ isInCodeSpan(currentDocument, lineStart.lineNumber, offset)
+ ) {
+ return;
+ }
+
  const matchText = lineStart.text.slice(
  Math.max(refStart.character - 2, 0),
  lineStart.text.length,
@@ -246,6 +254,7 @@ export const findUriByRef = (uris: vscode.Uri[], ref: string): vscode.Uri | unde
  return containsMarkdownExt(path.basename(uri.fsPath)) && name === ref.toLowerCase();
  });
 
+// TODO: Rename to ensureDirectoryExists
 export const ensureDirectoryExistence = (filePath: string) => {
  const dirname = path.dirname(filePath);
  if (!fs.existsSync(dirname)) {