generate copy without wikilinks #1365

hereistheusername · 2024-06-21T12:52:20Z

Abstract

As mentioned in #1353 , #1319, and #791, many people got difficulties when working with other tools that don't support wikilinks. To tackle this problem, I add a function to convert link format.

Further Explanation

Implementation

Refactoring the MarkdownLink.createUpdateLinkEdit, the convertLinkFormat function resolves links based the note containing it and its workspace and combine components properly.

User Interface

4 commands:

foam-vscode.convert-wikilink-to-markdownlink-inplace
foam-vscode.convert-markdownlink-to-wikilink-inplace
foam-vscode.convert-wikilink-to-markdownlink-in-copy
foam-vscode.convert-markdownlink-to-wikilink-in-copy

to meets users' different needs.

Thanks to @riccardoferretti help.

riccardoferretti

Thanks for looking into this.
At a high level, have you looked at MarkdownLink.createUpdateLinkEdit? it should do most of what you need in terms of refactoring.

Can you also tell me your thinking about having this as a command vs a formatting setting (kinda like using wikilink definitions)?
I would like to understand the feature from the POV of the user: is this about having a documenta that is always md compatible (in which case the transformation would happen on save), or is it about being able to export the knowledge base for e.g. a static site generator (in which case do we need a command for that?), or about exporting a single file (which is what you are implementing IIUC) - thoughts?

packages/foam-vscode/src/features/commands/generate-standalone-note.ts

riccardoferretti · 2024-06-21T14:15:06Z

packages/foam-vscode/src/core/janitor/generate-mdlinks.ts

+    }
+    return '';
+  }
+  public toMarkdownLink(


You probably can reuse the mechanisms available in MarkdownLink to achieve the same in a more integrated way

hereistheusername · 2024-06-21T15:53:47Z

Thanks for looking into this. At a high level, have you looked at MarkdownLink.createUpdateLinkEdit? it should do most of what you need in terms of refactoring.

Can you also tell me your thinking about having this as a command vs a formatting setting (kinda like using wikilink definitions)? I would like to understand the feature from the POV of the user: is this about having a documenta that is always md compatible (in which case the transformation would happen on save), or is it about being able to export the knowledge base for e.g. a static site generator (in which case do we need a command for that?), or about exporting a single file (which is what you are implementing IIUC) - thoughts?

Thank you for the quick review. Currently, I ran into a bug that it cannot resolve the wikilink to embeded images URI through workspace.resolveLink(resource, link). I am working on it and I'll also check the MarkdownLink.createUpdateLinkEdit.

The reason for doing this is wikilinks are more flexible, which leaves the workspace to manage the resource path. For example, I usually start with a single draft, and with more resources are added in the idea gets mature. At some point, I would like to re-organize or archive a group of ideas. If files are linked by wikilinks, I can move them freely. So, I think keeping linkages as wikilink would be benefit for PKM. However, if choosing format, there could be chance that links get broken, and it will need efforts to fix them.

In my imagination, users are recommanded to use wikilinks and only need to generate a standalone copy when they want to "export" their ideas. After that, those copies can be wiped out, by manually or scripts. Single file is not neccessary. Providing options to export a list of selected files or a whole directory would be helpful.

riccardoferretti

PR is looking good, I left a few comments. Thanks for the explanation around the rationale, we are aligned and this feels like it's pushing things in the right direction

packages/foam-vscode/src/core/janitor/convert-links-format.ts

riccardoferretti · 2024-06-24T10:31:59Z

packages/foam-vscode/src/core/janitor/convert-links-format.ts

+  const targetRes = workspace.find(targetUri);
+  let relativeUri = targetRes.uri.relativeTo(resource.uri.getDirectory());
+
+  if (targetFormat === 'wikilink') {
+    /* remove extension if possible, then get the basename to prevent from filename conflict */
+    if (relativeUri.path.endsWith(workspace.defaultExtension)) {
+      relativeUri = relativeUri.changeExtension('*', '');
+    }
+    target = relativeUri.getBasename();
+
+    return {
+      newText: `${embed}[[${target}${sectionDivider}${section}${aliasDivider}${alias}]]`,
+      range: link.range,
+    };
+  }
+
+  if (targetFormat === 'link') {
+    /* if alias is empty, construct one as target#section */
+    if (alias === '') {
+      /* in page anchor have no filename */
+      if (relativeUri.getBasename() === resource.uri.getBasename()) {
+        target = '';
+      }
+      alias = `${target}${sectionDivider}${section}`;
+    }
+
+    /* construct url */
+    let url = relativeUri.path;
+    /* in page anchor have no filename */
+    if (relativeUri.getBasename() === resource.uri.getBasename()) {
+      url = '';
+    }
+    if (sectionDivider === '#') {
+      url = `${url}${sectionDivider}${section}`;
+    }
+    if (url.indexOf(' ') > 0) {
+      url = `<${url}>`;
+    }
+
+    /* if it's originally an embeded note, the markdown link shouldn't be embeded */
+    if (embed && targetRes.type === 'note') {
+      embed = '';
+    }
+    return {
+      newText: `${embed}[${alias}](${url})`,
+      range: link.range,
+    };
+  }


I haven't tested it locally, but I wonder if you could be able to replace this whole section with

const newLink = {...link, type: targetType} const edit = MarkdownLink.createUpdateLinkEdit(newLink)

I think it's impossible. The first line of MarkdownLink.createUpdateLinkEdit is

const { target, section, alias } = MarkdownLink.analyzeLink(link);

which extracts three components via regex from link.rawText based on link.type. If the pattern doesn't match, three of them may not be extracted correctly.

Moreover, when dealing with conversion from wikilink to link, we have to retrieve the relative path to target, which is usually a basename in wikilink's rawText. Therefore, we must have workspace and note: Resource | URI.

Yeah, good point. Basically instead increateUpdateLinkEdit we need to add type?: 'wikilink' | 'link' to the delta parameter, and take it from there. Does that sound good?

Here is one possible version. I added type and isEmbed to the delta, which slightly affacts how createUpdateLinkEdit composes newText. Please check it.

differ to current code
branch

packages/foam-vscode/src/features/commands/convert-links-format-in-note.ts

riccardoferretti · 2024-06-24T10:39:14Z

packages/foam-vscode/src/features/commands/convert-links-format-in-note.ts

+/**
+ * convert links based on its workspace and the note containing it.
+ * Changes happen in a copy
+ * 1. prepare a copy file, and makt it the activeTextEditor


riccardoferretti · 2024-06-24T10:41:27Z

packages/foam-vscode/src/features/commands/convert-links-format-in-note.ts

+  const resource = fParser.parse(fromVsCodeUri(doc.uri), text);
+
+  const textReplaceArr = resource.links
+    .filter(link => link.type === convertOption.from)


(note: in my proposed approach, this check would be link.type !== convertOption.to)

Co-authored-by: Riccardo <[email protected]>

…LinkEdit-accomplish-convert modify createUpdateLinkEdit to accomplish convert

riccardoferretti

Thanks @hereistheusername - it all looks good and I think it's good to go, except for the require use - can you please see if the proposed solutions work? I am not keen on introducing require

riccardoferretti · 2024-07-06T16:38:33Z

packages/foam-vscode/src/features/commands/convert-links-format-in-note.ts

+import { ResourceParser } from '../../core/model/note';
+import { IMatcher } from '../../core/services/datastore';
+import { convertLinkFormat } from '../../core/janitor';
+const vscode = require('vscode'); /* cannot import workspace from above statement and not sure what happened */


can you try again to import workspace from vscode, or use import * from vscode and use that?
I am not introducing the require

riccardoferretti

Great, thx!

riccardoferretti · 2024-07-10T18:39:07Z

@allcontributors add @hereistheusername for code

allcontributors · 2024-07-10T18:39:18Z

@riccardoferretti

I've put up a pull request to add @hereistheusername! 🎉

* add generate standalone note command * fix embeded wikilinks * refactor convertLinksFormat function & add 4 user command interfaces * change user interface * modify createUpdateLinkEdit to accomplish convert * only images can be embedded * keey filename when using in page anchor * give a default value to alias in link format combination branch * add tests to createUpdateLinkEdit about changint links' type and isEmbed * get target from getIdentifier --------- Co-authored-by: Riccardo <[email protected]>

hereistheusername added 4 commits June 21, 2024 18:12

inseart new test file

60b4adf

add generate standalone note command

bab6cd7

vscode cmd configure

bcfde0e

fix embeded wikilinks

76ed1ad

riccardoferretti reviewed Jun 21, 2024

View reviewed changes

hereistheusername added 3 commits June 23, 2024 22:38

refactor convertLinksFormat function & add 4 user command interfaces

07702c2

cleanup

62f458e

add comments

0aefd72

hereistheusername marked this pull request as ready for review June 23, 2024 15:19

riccardoferretti reviewed Jun 24, 2024

View reviewed changes

hereistheusername and others added 16 commits June 24, 2024 21:02

change user interface

2e350d7

del outdated comments

08451f1

fix typo

18dbbb5

modify createUpdateLinkEdit to accomplish convert

b384491

only images can be embedded

7adf32f

Co-authored-by: Riccardo <[email protected]>

move useAngles to if-branch uses it

4483132

keey filename when using in page anchor

8dd26c9

remove redundant procedure

7732e4b

give a default value to alias in link format combination branch

8194b5c

add tests to createUpdateLinkEdit about changint links' type and isEmbed

6765d52

follow prettier format

1daf3be

change to one line expression

aaa8321

get target from getIdentifier

bdfa676

add tests for inserting angles

7af316b

Merge pull request #1 from hereistheusername/test/modify-createUpdate…

e8e3c2a

…LinkEdit-accomplish-convert modify createUpdateLinkEdit to accomplish convert

fix typo

b9775a3

riccardoferretti reviewed Jul 6, 2024

View reviewed changes

change require to import statement

866a091

hereistheusername force-pushed the master branch from 80157a6 to 866a091 Compare July 7, 2024 05:07

riccardoferretti approved these changes Jul 10, 2024

View reviewed changes

riccardoferretti merged commit cef8d2a into foambubble:master Jul 10, 2024
3 checks passed

allcontributors bot mentioned this pull request Jul 10, 2024

add hereistheusername as a contributor for code #1367

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

generate copy without wikilinks #1365

generate copy without wikilinks #1365

hereistheusername commented Jun 21, 2024 •

edited

Loading

riccardoferretti left a comment

riccardoferretti Jun 21, 2024

hereistheusername commented Jun 21, 2024

riccardoferretti left a comment

riccardoferretti Jun 24, 2024

hereistheusername Jun 24, 2024

riccardoferretti Jun 26, 2024

hereistheusername Jun 28, 2024 •

edited

Loading

riccardoferretti Jun 24, 2024

riccardoferretti Jun 24, 2024

riccardoferretti left a comment

riccardoferretti Jul 6, 2024

hereistheusername Jul 7, 2024

riccardoferretti left a comment

riccardoferretti commented Jul 10, 2024

allcontributors bot commented Jul 10, 2024

generate copy without wikilinks #1365

generate copy without wikilinks #1365

Conversation

hereistheusername commented Jun 21, 2024 • edited Loading

Abstract

Further Explanation

Implementation

User Interface

riccardoferretti left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hereistheusername commented Jun 21, 2024

riccardoferretti left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hereistheusername Jun 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

riccardoferretti left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

riccardoferretti left a comment

Choose a reason for hiding this comment

riccardoferretti commented Jul 10, 2024

allcontributors bot commented Jul 10, 2024

hereistheusername commented Jun 21, 2024 •

edited

Loading

hereistheusername Jun 28, 2024 •

edited

Loading