Skip to content

Commit 055564e

Browse files
authored
Merge pull request #3557 from obsidian-tasks-group/rename-isLinkTo
refactor: Rename `Link.isLinkTo()` to `Link.linksTo()`
2 parents a6ef18b + f75ea48 commit 055564e

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

resources/sample_vaults/Tasks-Demo/How To/Access links.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,12 +104,12 @@ This should match one task, in [[Link to Access links file]].
104104

105105
````text
106106
```tasks
107-
filter by function task.outlinks.some(link => link.isLinkTo(query.file))
107+
filter by function task.outlinks.some(link => link.linksTo(query.file))
108108
```
109109
````
110110

111111
```tasks
112-
filter by function task.outlinks.some(link => link.isLinkTo(query.file))
112+
filter by function task.outlinks.some(link => link.linksTo(query.file))
113113
```
114114

115115
#### Dataview version

src/Task/Link.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ export class Link {
7676
return this.rawLink.displayText;
7777
}
7878

79-
public isLinkTo(destination: string | TasksFile): boolean {
79+
public linksTo(destination: string | TasksFile): boolean {
8080
if (typeof destination === 'string') {
8181
const removeMd = /\.md$/;
8282
const thisDestinationWithoutMd = this.destination.replace(removeMd, '');

tests/Task/Link.test.ts

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ describe('linkClass', () => {
3232
expect(link.destination).toEqual('link_in_file_body');
3333
expect(link.displayText).toEqual('link_in_file_body');
3434
expect(link.markdown).toEqual(link.originalMarkdown);
35-
expect(link.isLinkTo('link_in_file_body')).toEqual(true);
36-
expect(link.isLinkTo('link_in_file_body.md')).toEqual(true);
35+
expect(link.linksTo('link_in_file_body')).toEqual(true);
36+
expect(link.linksTo('link_in_file_body.md')).toEqual(true);
3737
});
3838

3939
describe('getLink() configures Link.destinationPath automatically', () => {
@@ -286,43 +286,43 @@ describe('linkClass', () => {
286286
});
287287
});
288288

289-
describe('isLinkTo() tests', () => {
289+
describe('linksTo() tests', () => {
290290
it('matches filenames', () => {
291291
const link = getLink(links_everywhere, 0);
292292

293-
expect(link.isLinkTo('link_in_file_body')).toEqual(true);
294-
expect(link.isLinkTo('link_in_file_body.md')).toEqual(true);
293+
expect(link.linksTo('link_in_file_body')).toEqual(true);
294+
expect(link.linksTo('link_in_file_body.md')).toEqual(true);
295295

296-
expect(link.isLinkTo('somewhere_else')).toEqual(false);
296+
expect(link.linksTo('somewhere_else')).toEqual(false);
297297

298-
expect(link.isLinkTo('link_in_file_body_but_different')).toEqual(false);
299-
expect(link.isLinkTo('link_in_file_')).toEqual(false);
298+
expect(link.linksTo('link_in_file_body_but_different')).toEqual(false);
299+
expect(link.linksTo('link_in_file_')).toEqual(false);
300300
});
301301

302302
it('matches without folders', () => {
303303
const linkToAFile = getLink(link_in_task_wikilink, 0);
304304
expect(linkToAFile.originalMarkdown).toMatchInlineSnapshot('"[[link_in_task_wikilink]]"');
305305

306-
expect(linkToAFile.isLinkTo('link_in_task_wikilink')).toEqual(true);
306+
expect(linkToAFile.linksTo('link_in_task_wikilink')).toEqual(true);
307307
});
308308

309309
it('matches with folders', () => {
310310
const linkToAFolder = getLink(link_in_task_wikilink, 2);
311311
expect(linkToAFolder.originalMarkdown).toMatchInlineSnapshot('"[[Test Data/link_in_task_wikilink]]"');
312312

313-
expect(linkToAFolder.isLinkTo('link_in_task_wikilink')).toEqual(true);
314-
expect(linkToAFolder.isLinkTo('Test Data/link_in_task_wikilink')).toEqual(true);
315-
expect(linkToAFolder.isLinkTo('Test Data/link_in_task_wikilink.md')).toEqual(true);
313+
expect(linkToAFolder.linksTo('link_in_task_wikilink')).toEqual(true);
314+
expect(linkToAFolder.linksTo('Test Data/link_in_task_wikilink')).toEqual(true);
315+
expect(linkToAFolder.linksTo('Test Data/link_in_task_wikilink.md')).toEqual(true);
316316
});
317317

318318
it('matches TasksFile - only exact paths match', () => {
319319
const linkToAFolder = getLink(link_in_task_wikilink, 2);
320320
expect(linkToAFolder.originalMarkdown).toMatchInlineSnapshot('"[[Test Data/link_in_task_wikilink]]"');
321321

322-
expect(linkToAFolder.isLinkTo(new TasksFile('Test Data/link_in_task_wikilink.md'))).toEqual(true);
323-
expect(linkToAFolder.isLinkTo(new TasksFile('link_in_task_wikilink.md'))).toEqual(false);
324-
expect(linkToAFolder.isLinkTo(new TasksFile('Wrong Test Data/link_in_task_wikilink.md'))).toEqual(false);
325-
expect(linkToAFolder.isLinkTo(new TasksFile('something_obviously_different.md'))).toEqual(false);
322+
expect(linkToAFolder.linksTo(new TasksFile('Test Data/link_in_task_wikilink.md'))).toEqual(true);
323+
expect(linkToAFolder.linksTo(new TasksFile('link_in_task_wikilink.md'))).toEqual(false);
324+
expect(linkToAFolder.linksTo(new TasksFile('Wrong Test Data/link_in_task_wikilink.md'))).toEqual(false);
325+
expect(linkToAFolder.linksTo(new TasksFile('something_obviously_different.md'))).toEqual(false);
326326
});
327327
});
328328
});

0 commit comments

Comments
 (0)