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.

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

generate copy without wikilinks #1365

Merged
merged 24 commits into from
Jul 10, 2024
Merged
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
60b4adf
inseart new test file
hereistheusername Jun 21, 2024
bab6cd7
add generate standalone note command
hereistheusername Jun 21, 2024
bcfde0e
vscode cmd configure
hereistheusername Jun 21, 2024
76ed1ad
fix embeded wikilinks
hereistheusername Jun 21, 2024
07702c2
refactor convertLinksFormat function & add 4 user command interfaces
hereistheusername Jun 23, 2024
62f458e
cleanup
hereistheusername Jun 23, 2024
0aefd72
add comments
hereistheusername Jun 23, 2024
2e350d7
change user interface
hereistheusername Jun 24, 2024
08451f1
del outdated comments
hereistheusername Jun 24, 2024
18dbbb5
fix typo
hereistheusername Jun 28, 2024
b384491
modify createUpdateLinkEdit to accomplish convert
hereistheusername Jun 28, 2024
7adf32f
only images can be embedded
hereistheusername Jun 29, 2024
4483132
move useAngles to if-branch uses it
hereistheusername Jun 29, 2024
8dd26c9
keey filename when using in page anchor
hereistheusername Jun 29, 2024
7732e4b
remove redundant procedure
hereistheusername Jun 29, 2024
8194b5c
give a default value to alias in link format combination branch
hereistheusername Jun 30, 2024
6765d52
add tests to createUpdateLinkEdit about changint links' type and isEmbed
hereistheusername Jun 30, 2024
1daf3be
follow prettier format
hereistheusername Jun 30, 2024
aaa8321
change to one line expression
hereistheusername Jun 30, 2024
bdfa676
get target from getIdentifier
hereistheusername Jul 1, 2024
7af316b
add tests for inserting angles
hereistheusername Jul 2, 2024
e8e3c2a
Merge pull request #1 from hereistheusername/test/modify-createUpdate…
hereistheusername Jul 4, 2024
b9775a3
fix typo
hereistheusername Jul 6, 2024
866a091
change require to import statement
hereistheusername Jul 7, 2024
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
Prev Previous commit
Next Next commit
refactor convertLinksFormat function & add 4 user command interfaces
hereistheusername committed Jun 23, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 07702c20d999fecaa237ea10629ba9626d69630b
16 changes: 14 additions & 2 deletions packages/foam-vscode/package.json
Original file line number Diff line number Diff line change
@@ -347,8 +347,20 @@
"title": "Foam: Open Resource"
},
{
"command": "foam-vscode.generate-standalone-note",
"title": "Foam: generate standalone copy without wikilinks"
"command": "foam-vscode.convert-wikilink-to-markdownlink-inplace",
"title": "Foam: convert wikilinks to markdown link format in place"
},
{
"command": "foam-vscode.convert-markdownlink-to-wikilink-inplace",
"title": "Foam: convert markdown links to wikilinks format in place"
},
{
"command": "foam-vscode.convert-wikilink-to-markdownlink-incopy",
"title": "Foam: convert wikilinks to markdown link format in copy"
},
{
"command": "foam-vscode.convert-markdownlink-to-wikilink-incopy",
"title": "Foam: convert markdown links to wikilinks format in copy"
},
{
"command": "foam-vscode.views.orphans.group-by:folder",
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { generateMarkdownLinks } from './generate-mdlinks';
import { convertLinkFormat } from '.';
import { TEST_DATA_DIR } from '../../test/test-utils';
import { MarkdownResourceProvider } from '../services/markdown-provider';
import { Resource } from '../model/note';
@@ -39,17 +39,33 @@ describe('generateStdMdLink', () => {

it('can generate markdown links correctly', async () => {
const note = findBySlug('file-with-different-link-formats');
const actual = await generateMarkdownLinks(note, _workspace);
const actual = note.links
.filter(link => link.type === 'wikilink')
.map(link => convertLinkFormat(link, 'link', _workspace, note));
const expected: string[] = [
'[first-document](first-document.md "First Document")',
'[second-document](second-document.md "Second Document")',
'[#one section](<#one section> "File with different link formats")',
'[another name](<#one section> "File with different link formats")',
'[an alias](first-document.md "First Document")',
'[first-document](first-document.md)',
'[second-document](second-document.md)',
'[[non-exist-file]]',
'[#one section](<#one section>)',
'[another name](<#one section>)',
'[an alias](first-document.md)',
'[first-document](first-document.md)',
];
expect(actual.length).toEqual(expected.length);
const _ = actual.map((textReplace, index) => {
expect(textReplace.to).toEqual(expected[index]);
const _ = actual.map((LinkReplace, index) => {
expect(LinkReplace.newText).toEqual(expected[index]);
});
});

it('can generate wikilinks correctly', async () => {
const note = findBySlug('file-with-different-link-formats');
const actual = note.links
.filter(link => link.type === 'link')
.map(link => convertLinkFormat(link, 'wikilink', _workspace, note));
const expected: string[] = ['[[first-document|file]]'];
expect(actual.length).toEqual(expected.length);
const _ = actual.map((LinkReplace, index) => {
expect(LinkReplace.newText).toEqual(expected[index]);
});
});
});
105 changes: 105 additions & 0 deletions packages/foam-vscode/src/core/janitor/convert-links-format.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
import { Resource, ResourceLink } from '../model/note';
import { URI } from '../model/uri';
import { Range } from '../model/range';
import { FoamWorkspace } from '../model/workspace';
import { isNone } from '../utils';
import { MarkdownLink } from '../services/markdown-link';

export interface LinkReplace {
newText: string;
range: Range /* old range */;
}

export function convertLinkFormat(
link: ResourceLink,
targetFormat: string,
workspace: FoamWorkspace,
note: Resource | URI
): LinkReplace {
const resource = note instanceof URI ? workspace.find(note) : note;
const targetUri = workspace.resolveLink(resource, link);
/* If it's already the target format or a placeholder, no transformation happens */
if (link.type === targetFormat || targetUri.scheme === 'placeholder') {
return {
newText: link.rawText,
range: link.range,
};
}

let { target, section, alias } = MarkdownLink.analyzeLink(link);
let sectionDivider = section ? '#' : '';
let aliasDivider = alias ? '|' : '';
let embed = link.isEmbed ? '!' : '';

if (isNone(targetUri)) {
throw new Error(
`Unexpected state: link to: "${link.rawText}" is not resolvable`
);
}

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,
};
}
throw new Error(
`Unexpected state: targetFormat: ${targetFormat} is not supported`
);
}

// export const generateMarkdownLinks = async (
// note: Resource,
// workspace: FoamWorkspace
// ): Promise<LinkReplace[]> => {
// if (!note) {
// return [] as LinkReplace[];
// }

// const toReplaceArray = note.links
// .filter(link => link.type === 'wikilink')
// .map(link => convertLinkFormat(link, 'link', workspace, note));

// return toReplaceArray;
// };
120 changes: 0 additions & 120 deletions packages/foam-vscode/src/core/janitor/generate-mdlinks.ts

This file was deleted.

2 changes: 1 addition & 1 deletion packages/foam-vscode/src/core/janitor/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
export { generateLinkReferences } from './generate-link-references';
export { generateHeading } from './generate-headings';
export { generateMarkdownLinks } from './generate-mdlinks';
export { convertLinkFormat } from './convert-links-format';
Loading