mirror of
https://github.com/foambubble/foam.git
synced 2026-04-24 03:01:01 -04:00
Compare commits
16 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3876811fb6 | ||
|
|
d9299ee9d4 | ||
|
|
23e21a62f3 | ||
|
|
e7c8d5a4eb | ||
|
|
3ef1b69b2e | ||
|
|
5859b2a9c6 | ||
|
|
54086fdd7e | ||
|
|
a308dfd109 | ||
|
|
e327115673 | ||
|
|
c019767476 | ||
|
|
5e8b817a82 | ||
|
|
e0acc0ba8c | ||
|
|
df4efc5138 | ||
|
|
1e2b3b1bc3 | ||
|
|
eee364de50 | ||
|
|
3ed2bcd37b |
@@ -1049,6 +1049,15 @@
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "thara",
|
||||
"name": "Tomochika Hara",
|
||||
"avatar_url": "https://avatars.githubusercontent.com/u/1532891?v=4",
|
||||
"profile": "https://thara.dev",
|
||||
"contributions": [
|
||||
"doc"
|
||||
]
|
||||
}
|
||||
],
|
||||
"contributorsPerLine": 7,
|
||||
|
||||
2
.github/workflows/update-docs.yml
vendored
2
.github/workflows/update-docs.yml
vendored
@@ -24,7 +24,9 @@ jobs:
|
||||
id: copy
|
||||
run: |
|
||||
rm -r foam-template/docs
|
||||
rm -r foam-template/assets
|
||||
cp -r foam/docs/user foam-template/docs
|
||||
cp -r foam/docs/assets foam-template/assets
|
||||
|
||||
# Strip autogenerated wikileaks references because
|
||||
# they are not an appropriate default user experience.
|
||||
|
||||
BIN
docs/assets/images/note-embed-type-demo.gif
Normal file
BIN
docs/assets/images/note-embed-type-demo.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 568 KiB |
@@ -93,7 +93,7 @@ After you have made your changes to your copy of the project, it is time to try
|
||||
|
||||
1. Return to the project's [home repository page](https://github.com/foambubble/foam).
|
||||
2. Github should show you an button called "Compare & pull request" linking your forked repository to the community repository.
|
||||
3. Click that button and confirm that your repository is going to be merged into the community repository. See [this guide](https://sqldbawithabeard.com/2019/11/29/how-to-fork-a-github-repository-and-contribute-to-an-open-source-project/) for more specifics.
|
||||
3. Click that button and confirm that your repository is going to be merged into the community repository. See [this guide](https://blog.robsewell.com/blog/how-to-fork-a-github-repository-and-contribute-to-an-open-source-project/) for more specifics.
|
||||
4. Add as many relevant details to the PR message to make it clear to the project maintainers and other members of the community what you have accomplished with your new changes. Link to any issues the changes are related to.
|
||||
5. Your PR will then need to be reviewed and accepted by the other members of the community. Any discussion about the changes will occur in your PR thread.
|
||||
6. Once reviewed and accept you can complete the merge request!
|
||||
|
||||
@@ -254,6 +254,7 @@ If that sounds like something you're interested in, I'd love to have you along o
|
||||
<tr>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://amnesiak.org/me"><img src="https://avatars.githubusercontent.com/u/952059?v=4?s=60" width="60px;" alt="Tony Cheneau"/><br /><sub><b>Tony Cheneau</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=tcheneau" title="Documentation">📖</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/nicholas-l"><img src="https://avatars.githubusercontent.com/u/12977174?v=4?s=60" width="60px;" alt="Nicholas Latham"/><br /><sub><b>Nicholas Latham</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=nicholas-l" title="Code">💻</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://thara.dev"><img src="https://avatars.githubusercontent.com/u/1532891?v=4?s=60" width="60px;" alt="Tomochika Hara"/><br /><sub><b>Tomochika Hara</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=thara" title="Documentation">📖</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
29
docs/user/features/built-in-note-embedding-types.md
Normal file
29
docs/user/features/built-in-note-embedding-types.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Built-In Note Embedding Types
|
||||
|
||||
When embedding a note, there are a few ways to modify the scope of the content as well as its display style. The following are Foam keywords that are used to describe note embedding.
|
||||
|
||||
Note, this only applies to note embedding, not embedding of attachments or images.
|
||||
|
||||

|
||||
|
||||
## Scope
|
||||
|
||||
- `full` - the entire note in the case of `![[note]]` or the entire section in the case of `![[note#section1]]`
|
||||
- `content` - everything excluding the title of the section. So the entire note minus the title for `![[note]]`, or the entire section minus the section header for `![[note#section1]]`
|
||||
|
||||
## Style
|
||||
|
||||
- `card` - outlines the embedded note with a border
|
||||
- `inline` - adds the note continuously as if the text were part of the calling note
|
||||
|
||||
## Default Setting
|
||||
|
||||
Foam expresses note display type as `<scope>-<style>`.
|
||||
|
||||
By default, Foam configures note embedding to be `full-card`. That is, whenever the standard embedding syntax is used, `![[note]]`, the note will have `full` scope and `card` style display. This setting is stored under `foam.preview.embedNoteStyle` and can be modified.
|
||||
|
||||
## Explicit Modifiers
|
||||
|
||||
Prepend the wikilink with one of the scope or style keywords, or a combination of the two to explicitly modify a note embedding if you would like to override the default setting.
|
||||
|
||||
For example, given your `foam.embedNoteStyle` is set to `content-card`, embedding a note with standard syntax `![[note-a]]` would show a bordered note without its title. Say, for a specific `note-b` you would like to display the title. You can simply use one of the above keywords to override your default setting like so: `full![[note-b]]`. In this case, `full` overrides the default `content` scope and because a style is not specified, it falls back to the default style setting, `card`. If you would like it to be inline, override that as well: `full-inline![[note-b]]`.
|
||||
@@ -8,13 +8,16 @@ Including a note can be done by adding an `!` before a wikilink definition. For
|
||||
|
||||
## Custom styling
|
||||
|
||||
Displaying the inclusion of notes allows for some custom styling, see [[custom-markdown-preview-styles]]
|
||||
To modify how an embedded note looks and the scope of its content, see [[built-in-note-embedding-types]]
|
||||
|
||||
For more fine-grained custom styling, see [[custom-markdown-preview-styles]]
|
||||
|
||||
## Future possibilities
|
||||
|
||||
Work on this feature is evolving and progressing. See the [[inclusion-of-notes]] proposal for the current discussion.
|
||||
|
||||
[//begin]: # "Autogenerated link references for markdown compatibility"
|
||||
[custom-markdown-preview-styles]: custom-markdown-preview-styles.md "Custom Markdown Preview Styles"
|
||||
[inclusion-of-notes]: ../../dev/proposals/inclusion-of-notes.md "Inclusion of notes Proposal "
|
||||
[//end]: # "Autogenerated link references"
|
||||
[//begin]: # 'Autogenerated link references for markdown compatibility'
|
||||
[built-in-note-embedding-types]: built-in-note-embedding-types.md 'Built-In Note Embedding Types'
|
||||
[custom-markdown-preview-styles]: custom-markdown-preview-styles.md 'Custom Markdown Preview Styles'
|
||||
[inclusion-of-notes]: ../../dev/proposals/inclusion-of-notes.md 'Inclusion of notes Proposal '
|
||||
[//end]: # 'Autogenerated link references'
|
||||
|
||||
@@ -4,5 +4,5 @@
|
||||
],
|
||||
"npmClient": "yarn",
|
||||
"useWorkspaces": true,
|
||||
"version": "0.25.1"
|
||||
"version": "0.25.4"
|
||||
}
|
||||
|
||||
@@ -4,6 +4,28 @@ All notable changes to the "foam-vscode" extension will be documented in this fi
|
||||
|
||||
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
|
||||
|
||||
## [0.25.4] - 2023-09-19
|
||||
|
||||
Fixes and Improvements:
|
||||
|
||||
- Added support for linking sections within same document (#1289)
|
||||
- Fixed note embedding bug (#1286 - thanks @badsketch)
|
||||
|
||||
## [0.25.3] - 2023-09-07
|
||||
|
||||
Fixes and Improvements:
|
||||
|
||||
- Fixed incorrect handling of embedding of non-existing notes (#1283 - thanks @badsketch)
|
||||
- Introduced Note Embedding Sytanx (#1281 - thanks @badsketch)
|
||||
- Attachments are not considered when computing orphan notes (#1242)
|
||||
|
||||
## [0.25.2] - 2023-09-02
|
||||
|
||||
Fixes and Improvements:
|
||||
|
||||
- Added content-only embed styles (#1279 - thanks @badsketch)
|
||||
- Added expand-all button to tree views (#1276)
|
||||
|
||||
## [0.25.1] - 2023-08-23
|
||||
|
||||
Fixes and Improvements:
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
"type": "git"
|
||||
},
|
||||
"homepage": "https://github.com/foambubble/foam",
|
||||
"version": "0.25.1",
|
||||
"version": "0.25.4",
|
||||
"license": "MIT",
|
||||
"publisher": "foam",
|
||||
"engines": {
|
||||
@@ -152,6 +152,11 @@
|
||||
"when": "view == foam-vscode.tags-explorer && foam-vscode.views.tags-explorer.group-by == 'folder'",
|
||||
"group": "navigation"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.views.tags-explorer.expand-all",
|
||||
"when": "view == foam-vscode.tags-explorer",
|
||||
"group": "navigation"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.views.placeholders.show:for-current-file",
|
||||
"when": "view == foam-vscode.placeholders && foam-vscode.views.placeholders.show == 'all'",
|
||||
@@ -172,6 +177,11 @@
|
||||
"when": "view == foam-vscode.placeholders && foam-vscode.views.placeholders.group-by == 'folder'",
|
||||
"group": "navigation"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.views.placeholders.expand-all",
|
||||
"when": "view == foam-vscode.placeholders",
|
||||
"group": "navigation"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.views.notes-explorer.show:notes",
|
||||
"when": "view == foam-vscode.notes-explorer && foam-vscode.views.notes-explorer.show == 'all'",
|
||||
@@ -181,6 +191,11 @@
|
||||
"command": "foam-vscode.views.notes-explorer.show:all",
|
||||
"when": "view == foam-vscode.notes-explorer && foam-vscode.views.notes-explorer.show == 'notes-only'",
|
||||
"group": "navigation"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.views.notes-explorer.expand-all",
|
||||
"when": "view == foam-vscode.notes-explorer",
|
||||
"group": "navigation"
|
||||
}
|
||||
],
|
||||
"commandPalette": [
|
||||
@@ -228,6 +243,10 @@
|
||||
"command": "foam-vscode.views.tags-explorer.group-by:off",
|
||||
"when": "false"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.views.tags-explorer.expand-all",
|
||||
"when": "false"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.views.placeholders.show:for-current-file",
|
||||
"when": "false"
|
||||
@@ -244,6 +263,10 @@
|
||||
"command": "foam-vscode.views.placeholders.group-by:off",
|
||||
"when": "false"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.views.placeholders.expand-all",
|
||||
"when": "false"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.views.notes-explorer.show:all",
|
||||
"when": "false"
|
||||
@@ -252,6 +275,10 @@
|
||||
"command": "foam-vscode.views.notes-explorer.show:notes",
|
||||
"when": "false"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.views.notes-explorer.expand-all",
|
||||
"when": "false"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.open-resource",
|
||||
"when": "false"
|
||||
@@ -364,6 +391,11 @@
|
||||
"title": "Flat list",
|
||||
"icon": "$(list-flat)"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.views.tags-explorer.expand-all",
|
||||
"title": "Expand all",
|
||||
"icon": "$(expand-all)"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.views.placeholders.show:for-current-file",
|
||||
"title": "Show placeholders in current file",
|
||||
@@ -384,11 +416,21 @@
|
||||
"title": "Flat list",
|
||||
"icon": "$(list-flat)"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.views.placeholders.expand-all",
|
||||
"title": "Expand all",
|
||||
"icon": "$(expand-all)"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.views.notes-explorer.show:all",
|
||||
"title": "Show all resources",
|
||||
"icon": "$(files)"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.views.notes-explorer.expand-all",
|
||||
"title": "Expand all",
|
||||
"icon": "$(expand-all)"
|
||||
},
|
||||
{
|
||||
"command": "foam-vscode.views.notes-explorer.show:notes",
|
||||
"title": "Show only notes",
|
||||
@@ -567,22 +609,20 @@
|
||||
],
|
||||
"description": "Whether or not to navigate to the target daily note when a daily note snippet is selected."
|
||||
},
|
||||
"foam.preview.embedNoteInContainer": {
|
||||
"type": "boolean",
|
||||
"default": true,
|
||||
"description": "Wrap embedded notes in a container when displayed in preview panel",
|
||||
"deprecationMessage": "*DEPRECATED* use foam.preview.embedNoteType instead."
|
||||
},
|
||||
"foam.preview.embedNoteType": {
|
||||
"type": "string",
|
||||
"default": "full-card",
|
||||
"enum": [
|
||||
"full-inline",
|
||||
"full-card"
|
||||
"full-card",
|
||||
"content-inline",
|
||||
"content-card"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Include the section with title and style inline",
|
||||
"Include the section with title and style it within a container"
|
||||
"Include the section with title and style it within a container",
|
||||
"Include the section without title and style inline",
|
||||
"Include the section without title and style it within a container"
|
||||
]
|
||||
},
|
||||
"foam.graph.titleMaxLength": {
|
||||
|
||||
@@ -4,7 +4,14 @@ import { FoamWorkspace } from '../model/workspace';
|
||||
import { IDisposable } from '../common/lifecycle';
|
||||
import { ResourceProvider } from '../model/provider';
|
||||
|
||||
const imageExtensions = ['.png', '.jpg', '.jpeg', '.gif', '.svg', '.webp'];
|
||||
export const imageExtensions = [
|
||||
'.png',
|
||||
'.jpg',
|
||||
'.jpeg',
|
||||
'.gif',
|
||||
'.svg',
|
||||
'.webp',
|
||||
];
|
||||
|
||||
const asResource = (uri: URI): Resource => {
|
||||
const type = imageExtensions.includes(uri.getExtension())
|
||||
|
||||
@@ -316,4 +316,40 @@ describe('Generation of markdown references', () => {
|
||||
'../dir3/page-c.md',
|
||||
]);
|
||||
});
|
||||
|
||||
it('should generate links for embedded notes that are formatted properly', () => {
|
||||
const workspace = createTestWorkspace();
|
||||
const noteA = createNoteFromMarkdown(
|
||||
'Link to ![[page-b]] and [[page-c]]',
|
||||
'/dir1/page-a.md'
|
||||
);
|
||||
workspace
|
||||
.set(noteA)
|
||||
.set(createNoteFromMarkdown('Content of note B', '/dir2/page-b.md'))
|
||||
.set(createNoteFromMarkdown('Content of note C', '/dir3/page-c.md'));
|
||||
|
||||
const references = createMarkdownReferences(workspace, noteA.uri, true);
|
||||
expect(references.map(r => [r.url, r.label])).toEqual([
|
||||
['../dir2/page-b.md', 'page-b'],
|
||||
['../dir3/page-c.md', 'page-c'],
|
||||
]);
|
||||
});
|
||||
|
||||
it('should not generate links for placeholders', () => {
|
||||
const workspace = createTestWorkspace();
|
||||
const noteA = createNoteFromMarkdown(
|
||||
'Link to ![[page-b]] and [[page-c]] and [[does-not-exist]] and ![[does-not-exist-either]]',
|
||||
'/dir1/page-a.md'
|
||||
);
|
||||
workspace
|
||||
.set(noteA)
|
||||
.set(createNoteFromMarkdown('Content of note B', '/dir2/page-b.md'))
|
||||
.set(createNoteFromMarkdown('Content of note C', '/dir3/page-c.md'));
|
||||
|
||||
const references = createMarkdownReferences(workspace, noteA.uri, true);
|
||||
expect(references.map(r => r.url)).toEqual([
|
||||
'../dir2/page-b.md',
|
||||
'../dir3/page-c.md',
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -139,10 +139,12 @@ export function createMarkdownReferences(
|
||||
|
||||
// [wikilink-text]: path/to/file.md "Page title"
|
||||
return {
|
||||
label:
|
||||
link.rawText.indexOf('[[') > -1
|
||||
? link.rawText.substring(2, link.rawText.length - 2)
|
||||
: link.rawText,
|
||||
// embedded looks like ![[note-a]]
|
||||
// regular note looks like [[note-a]]
|
||||
label: link.rawText.substring(
|
||||
link.isEmbed ? 3 : 2,
|
||||
link.rawText.length - 2
|
||||
),
|
||||
url: relativeUri.path,
|
||||
title: target.title,
|
||||
};
|
||||
|
||||
@@ -5,6 +5,7 @@ import {
|
||||
ResourceRangeTreeItem,
|
||||
ResourceTreeItem,
|
||||
createBacklinkItemsForResource as createBacklinkTreeItemsForResource,
|
||||
expandAll,
|
||||
} from './utils/tree-view-utils';
|
||||
import { Resource } from '../../core/model/note';
|
||||
import { FoamGraph } from '../../core/model/graph';
|
||||
@@ -60,6 +61,11 @@ export default async function activate(
|
||||
foam.graph.onDidUpdate(() => {
|
||||
provider.refresh();
|
||||
}),
|
||||
vscode.commands.registerCommand(
|
||||
`foam-vscode.views.notes-explorer.expand-all`,
|
||||
(...args) =>
|
||||
expandAll(treeView, provider, node => node.contextValue === 'folder')
|
||||
),
|
||||
vscode.window.onDidChangeActiveTextEditor(revealTextEditorItem),
|
||||
treeView.onDidChangeVisibility(revealTextEditorItem)
|
||||
);
|
||||
@@ -138,18 +144,19 @@ export class NotesProvider extends FolderTreeProvider<
|
||||
value: Resource,
|
||||
parent: FolderTreeItem<Resource>
|
||||
): NotesTreeItems {
|
||||
const res = new ResourceTreeItem(value, this.workspace, {
|
||||
const item = new ResourceTreeItem(value, this.workspace, {
|
||||
parent,
|
||||
collapsibleState:
|
||||
this.graph.getBacklinks(value.uri).length > 0
|
||||
? vscode.TreeItemCollapsibleState.Collapsed
|
||||
: vscode.TreeItemCollapsibleState.None,
|
||||
});
|
||||
res.getChildren = async () => {
|
||||
item.id = value.uri.toString();
|
||||
item.getChildren = async () => {
|
||||
const backlinks = await createBacklinkTreeItemsForResource(
|
||||
this.workspace,
|
||||
this.graph,
|
||||
res.uri
|
||||
item.uri
|
||||
);
|
||||
backlinks.forEach(item => {
|
||||
item.description = item.label;
|
||||
@@ -157,11 +164,11 @@ export class NotesProvider extends FolderTreeProvider<
|
||||
});
|
||||
return backlinks;
|
||||
};
|
||||
res.description =
|
||||
item.description =
|
||||
value.uri.getName().toLocaleLowerCase() ===
|
||||
value.title.toLocaleLowerCase()
|
||||
? undefined
|
||||
: value.uri.getBasename();
|
||||
return res;
|
||||
return item;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,12 +1,14 @@
|
||||
import * as vscode from 'vscode';
|
||||
import { Foam } from '../../core/model/foam';
|
||||
import { createMatcherAndDataStore } from '../../services/editor';
|
||||
import { getOrphansConfig } from '../../settings';
|
||||
import { getAttachmentsExtensions, getOrphansConfig } from '../../settings';
|
||||
import { GroupedResourcesTreeDataProvider } from './utils/grouped-resources-tree-data-provider';
|
||||
import { ResourceTreeItem, UriTreeItem } from './utils/tree-view-utils';
|
||||
import { IMatcher } from '../../core/services/datastore';
|
||||
import { FoamWorkspace } from '../../core/model/workspace';
|
||||
import { FoamGraph } from '../../core/model/graph';
|
||||
import { URI } from '../../core/model/uri';
|
||||
import { imageExtensions } from '../../core/services/attachment-provider';
|
||||
|
||||
const EXCLUDE_TYPES = ['image', 'attachment'];
|
||||
export default async function activate(
|
||||
@@ -66,6 +68,13 @@ export class OrphanTreeView extends GroupedResourcesTreeDataProvider {
|
||||
.filter(
|
||||
uri =>
|
||||
!EXCLUDE_TYPES.includes(this.workspace.find(uri)?.type) &&
|
||||
this.graph.getConnections(uri).length === 0
|
||||
this.graph.getBacklinks(uri).length === 0 &&
|
||||
this.graph.getLinks(uri).filter(c => !isAttachment(c.target))
|
||||
.length === 0
|
||||
);
|
||||
}
|
||||
|
||||
function isAttachment(uri: URI) {
|
||||
const ext = [...getAttachmentsExtensions(), ...imageExtensions];
|
||||
return ext.includes(uri.getExtension());
|
||||
}
|
||||
|
||||
@@ -6,6 +6,7 @@ import { GroupedResourcesTreeDataProvider } from './utils/grouped-resources-tree
|
||||
import {
|
||||
UriTreeItem,
|
||||
createBacklinkItemsForResource,
|
||||
expandAll,
|
||||
groupRangesByResource,
|
||||
} from './utils/tree-view-utils';
|
||||
import { IMatcher } from '../../core/services/datastore';
|
||||
@@ -47,6 +48,17 @@ export default async function activate(
|
||||
provider.onDidChangeTreeData(() => {
|
||||
treeView.title = baseTitle + ` (${provider.nValues})`;
|
||||
}),
|
||||
vscode.commands.registerCommand(
|
||||
`foam-vscode.views.placeholders.expand-all`,
|
||||
() =>
|
||||
expandAll(
|
||||
treeView,
|
||||
provider,
|
||||
node =>
|
||||
node.contextValue === 'placeholder' ||
|
||||
node.contextValue === 'folder'
|
||||
)
|
||||
),
|
||||
vscode.window.onDidChangeActiveTextEditor(() => {
|
||||
if (provider.show.get() === 'for-current-file') {
|
||||
provider.refresh();
|
||||
@@ -92,6 +104,8 @@ export class PlaceholderTreeView extends GroupedResourcesTreeDataProvider {
|
||||
parent,
|
||||
collapsibleState: vscode.TreeItemCollapsibleState.Collapsed,
|
||||
});
|
||||
item.contextValue = 'placeholder';
|
||||
item.id = uri.toString();
|
||||
item.getChildren = async () => {
|
||||
return groupRangesByResource(
|
||||
this.workspace,
|
||||
|
||||
@@ -6,6 +6,7 @@ import { FoamTags } from '../../core/model/tags';
|
||||
import {
|
||||
ResourceRangeTreeItem,
|
||||
ResourceTreeItem,
|
||||
expandAll,
|
||||
groupRangesByResource,
|
||||
} from './utils/tree-view-utils';
|
||||
import {
|
||||
@@ -44,12 +45,21 @@ export default async function activate(
|
||||
if (provider.show.get() === 'for-current-file') {
|
||||
provider.refresh();
|
||||
}
|
||||
})
|
||||
}),
|
||||
vscode.commands.registerCommand(
|
||||
`foam-vscode.views.${provider.providerId}.expand-all`,
|
||||
() =>
|
||||
expandAll(
|
||||
treeView,
|
||||
provider,
|
||||
node => node.contextValue === 'tag' || node.contextValue === 'folder'
|
||||
)
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
export class TagsProvider extends FolderTreeProvider<TagTreeItem, string> {
|
||||
private providerId = 'tags-explorer';
|
||||
public providerId = 'tags-explorer';
|
||||
public show = new ContextMemento<'all' | 'for-current-file'>(
|
||||
new MapBasedMemento(),
|
||||
`foam-vscode.views.${this.providerId}.show`,
|
||||
@@ -178,7 +188,12 @@ export class TagsProvider extends FolderTreeProvider<TagTreeItem, string> {
|
||||
);
|
||||
return [...acc, ...items];
|
||||
}, []);
|
||||
const resources = await groupRangesByResource(this.workspace, resourceTags);
|
||||
const resources = (
|
||||
await groupRangesByResource(this.workspace, resourceTags)
|
||||
).map(item => {
|
||||
item.id = element.tag + ' / ' + item.uri.toString();
|
||||
return item;
|
||||
});
|
||||
|
||||
return [...subtags, ...resources];
|
||||
}
|
||||
@@ -197,6 +212,7 @@ export class TagItem extends FolderTreeItem<string> {
|
||||
) {
|
||||
super(node, node.path.slice(-1)[0], parentElement);
|
||||
this.tag = node.path.join(TAG_SEPARATOR);
|
||||
this.id = this.tag;
|
||||
this.description = `${nResourcesInSubtree} reference${
|
||||
nResourcesInSubtree !== 1 ? 's' : ''
|
||||
}`;
|
||||
|
||||
@@ -9,6 +9,7 @@ import { getNoteTooltip } from '../../../utils';
|
||||
import { isSome } from '../../../core/utils';
|
||||
import { getBlockFor } from '../../../core/services/markdown-parser';
|
||||
import { Connection, FoamGraph } from '../../../core/model/graph';
|
||||
import { Logger } from '../../../core/utils/log';
|
||||
|
||||
export class BaseTreeItem extends vscode.TreeItem {
|
||||
resolveTreeItem(): Promise<vscode.TreeItem> {
|
||||
@@ -227,3 +228,57 @@ export function createConnectionItemsForResource(
|
||||
});
|
||||
return Promise.all(backlinkItems);
|
||||
}
|
||||
|
||||
/**
|
||||
* Expands a node and its children in a tree view that match a given predicate
|
||||
*
|
||||
* @param treeView - The tree view to expand nodes in
|
||||
* @param provider - The tree data provider for the view
|
||||
* @param element - The element to expand
|
||||
* @param when - A function that returns true if the node should be expanded
|
||||
*/
|
||||
export async function expandNode<T>(
|
||||
treeView: vscode.TreeView<any>,
|
||||
provider: vscode.TreeDataProvider<T>,
|
||||
element: T,
|
||||
when: (element: T) => boolean
|
||||
) {
|
||||
try {
|
||||
if (when(element)) {
|
||||
await treeView.reveal(element, {
|
||||
select: false,
|
||||
focus: false,
|
||||
expand: true,
|
||||
});
|
||||
}
|
||||
} catch (e) {
|
||||
const obj = element as any;
|
||||
const label = obj.label ?? obj.toString();
|
||||
Logger.warn(
|
||||
`Could not expand element: ${label}. Try setting the ID property of the TreeItem`
|
||||
);
|
||||
}
|
||||
|
||||
const children = await provider.getChildren(element);
|
||||
for (const child of children) {
|
||||
await expandNode(treeView, provider, child, when);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Expands all items in a tree view that match a given predicate
|
||||
*
|
||||
* @param treeView - The tree view to expand items in
|
||||
* @param provider - The tree data provider for the view
|
||||
* @param when - A function that returns true if the node should be expanded
|
||||
*/
|
||||
export async function expandAll<T>(
|
||||
treeView: vscode.TreeView<T>,
|
||||
provider: vscode.TreeDataProvider<T>,
|
||||
when: (element: T) => boolean = () => true
|
||||
) {
|
||||
const elements = await provider.getChildren(undefined);
|
||||
for (const element of elements) {
|
||||
await expandNode(treeView, provider, element, when);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -9,45 +9,38 @@ import {
|
||||
import {
|
||||
default as markdownItWikilinkEmbed,
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
CONFIG_EMBED_NOTE_IN_CONTAINER,
|
||||
} from './wikilink-embed';
|
||||
|
||||
const parser = createMarkdownParser();
|
||||
|
||||
describe('Displaying included notes in preview', () => {
|
||||
it('should render an included note in flat mode', async () => {
|
||||
it('should render an included note in full inline mode', async () => {
|
||||
const note = await createFile('This is the text of note A', [
|
||||
'preview',
|
||||
'note-a.md',
|
||||
]);
|
||||
const ws = new FoamWorkspace().set(parser.parse(note.uri, note.content));
|
||||
await withModifiedFoamConfiguration(
|
||||
CONFIG_EMBED_NOTE_IN_CONTAINER,
|
||||
null,
|
||||
async () => {
|
||||
await withModifiedFoamConfiguration(
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
'full-inline',
|
||||
() => {
|
||||
const md = markdownItWikilinkEmbed(MarkdownIt(), ws, parser);
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
'full-inline',
|
||||
() => {
|
||||
const md = markdownItWikilinkEmbed(MarkdownIt(), ws, parser);
|
||||
|
||||
expect(
|
||||
md.render(`This is the root node.
|
||||
expect(
|
||||
md.render(`This is the root node.
|
||||
|
||||
![[note-a]]`)
|
||||
).toMatch(
|
||||
`<p>This is the root node.</p>
|
||||
).toMatch(
|
||||
`<p>This is the root node.</p>
|
||||
<p><p>This is the text of note A</p>
|
||||
</p>`
|
||||
);
|
||||
}
|
||||
);
|
||||
}
|
||||
);
|
||||
await deleteFile(note);
|
||||
});
|
||||
|
||||
it('should render an included note in container mode', async () => {
|
||||
it('should render an included note in full card mode', async () => {
|
||||
const note = await createFile('This is the text of note A', [
|
||||
'preview',
|
||||
'note-a.md',
|
||||
@@ -55,27 +48,21 @@ describe('Displaying included notes in preview', () => {
|
||||
const ws = new FoamWorkspace().set(parser.parse(note.uri, note.content));
|
||||
|
||||
await withModifiedFoamConfiguration(
|
||||
CONFIG_EMBED_NOTE_IN_CONTAINER,
|
||||
null,
|
||||
async () => {
|
||||
await withModifiedFoamConfiguration(
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
'full-card',
|
||||
() => {
|
||||
const md = markdownItWikilinkEmbed(MarkdownIt(), ws, parser);
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
'full-card',
|
||||
() => {
|
||||
const md = markdownItWikilinkEmbed(MarkdownIt(), ws, parser);
|
||||
|
||||
const res = md.render(`This is the root node. ![[note-a]]`);
|
||||
expect(res).toContain('This is the root node');
|
||||
expect(res).toContain('embed-container-note');
|
||||
expect(res).toContain('This is the text of note A');
|
||||
}
|
||||
);
|
||||
const res = md.render(`This is the root node. ![[note-a]]`);
|
||||
expect(res).toContain('This is the root node');
|
||||
expect(res).toContain('embed-container-note');
|
||||
expect(res).toContain('This is the text of note A');
|
||||
}
|
||||
);
|
||||
await deleteFile(note);
|
||||
});
|
||||
|
||||
it('should render an included section', async () => {
|
||||
it('should render an included section in full inline mode', async () => {
|
||||
// here we use createFile as the test note doesn't fill in
|
||||
// all the metadata we need
|
||||
const note = await createFile(
|
||||
@@ -96,24 +83,18 @@ This is the third section of note E
|
||||
const md = markdownItWikilinkEmbed(MarkdownIt(), ws, parser);
|
||||
|
||||
await withModifiedFoamConfiguration(
|
||||
CONFIG_EMBED_NOTE_IN_CONTAINER,
|
||||
null,
|
||||
async () => {
|
||||
await withModifiedFoamConfiguration(
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
'full-inline',
|
||||
() => {
|
||||
expect(
|
||||
md.render(`This is the root node.
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
'full-inline',
|
||||
() => {
|
||||
expect(
|
||||
md.render(`This is the root node.
|
||||
|
||||
![[note-e#Section 2]]`)
|
||||
).toMatch(
|
||||
`<p>This is the root node.</p>
|
||||
).toMatch(
|
||||
`<p>This is the root node.</p>
|
||||
<p><h1>Section 2</h1>
|
||||
<p>This is the second section of note E</p>
|
||||
</p>`
|
||||
);
|
||||
}
|
||||
);
|
||||
}
|
||||
);
|
||||
@@ -121,7 +102,7 @@ This is the third section of note E
|
||||
await deleteFile(note);
|
||||
});
|
||||
|
||||
it('should render an included section in container mode', async () => {
|
||||
it('should render an included section in full card mode', async () => {
|
||||
const note = await createFile(
|
||||
`
|
||||
# Section 1
|
||||
@@ -139,24 +120,232 @@ This is the third section of note E
|
||||
const ws = new FoamWorkspace().set(parser.parse(note.uri, note.content));
|
||||
|
||||
await withModifiedFoamConfiguration(
|
||||
CONFIG_EMBED_NOTE_IN_CONTAINER,
|
||||
null,
|
||||
async () => {
|
||||
await withModifiedFoamConfiguration(
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
'full-card',
|
||||
() => {
|
||||
const md = markdownItWikilinkEmbed(MarkdownIt(), ws, parser);
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
'full-card',
|
||||
() => {
|
||||
const md = markdownItWikilinkEmbed(MarkdownIt(), ws, parser);
|
||||
|
||||
const res = md.render(
|
||||
`This is the root node. ![[note-e-container#Section 3]]`
|
||||
);
|
||||
expect(res).toContain('This is the root node');
|
||||
expect(res).toContain('embed-container-note');
|
||||
expect(res).toContain('Section 3');
|
||||
expect(res).toContain('This is the third section of note E');
|
||||
}
|
||||
const res = md.render(
|
||||
`This is the root node. ![[note-e-container#Section 3]]`
|
||||
);
|
||||
expect(res).toContain('This is the root node');
|
||||
expect(res).toContain('embed-container-note');
|
||||
expect(res).toContain('Section 3');
|
||||
expect(res).toContain('This is the third section of note E');
|
||||
}
|
||||
);
|
||||
|
||||
await deleteFile(note);
|
||||
});
|
||||
|
||||
it('should not render the title of a note in content inline mode', async () => {
|
||||
const note = await createFile(
|
||||
`
|
||||
# Title
|
||||
## Section 1
|
||||
|
||||
This is the first section of note E`,
|
||||
['note-e.md']
|
||||
);
|
||||
const parser = createMarkdownParser([]);
|
||||
const ws = new FoamWorkspace().set(parser.parse(note.uri, note.content));
|
||||
|
||||
await withModifiedFoamConfiguration(
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
'content-inline',
|
||||
() => {
|
||||
const md = markdownItWikilinkEmbed(MarkdownIt(), ws, parser);
|
||||
|
||||
expect(
|
||||
md.render(`This is the root node.
|
||||
|
||||
![[note-e]]`)
|
||||
).toMatch(
|
||||
`<p>This is the root node.</p>
|
||||
<p><h2>Section 1</h2>
|
||||
<p>This is the first section of note E</p>
|
||||
</p>`
|
||||
);
|
||||
}
|
||||
);
|
||||
|
||||
await deleteFile(note);
|
||||
});
|
||||
|
||||
it('should not render the title of a note in content card mode', async () => {
|
||||
const note = await createFile(
|
||||
`# Title
|
||||
## Section 1
|
||||
|
||||
This is the first section of note E
|
||||
`,
|
||||
['note-e.md']
|
||||
);
|
||||
const parser = createMarkdownParser([]);
|
||||
const ws = new FoamWorkspace().set(parser.parse(note.uri, note.content));
|
||||
|
||||
await withModifiedFoamConfiguration(
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
'content-card',
|
||||
() => {
|
||||
const md = markdownItWikilinkEmbed(MarkdownIt(), ws, parser);
|
||||
|
||||
const res = md.render(`This is the root node. ![[note-e.md]]`);
|
||||
|
||||
expect(res).toContain('This is the root node');
|
||||
expect(res).toContain('embed-container-note');
|
||||
expect(res).toContain('Section 1');
|
||||
expect(res).toContain('This is the first section of note E');
|
||||
expect(res).not.toContain('Title');
|
||||
}
|
||||
);
|
||||
|
||||
await deleteFile(note);
|
||||
});
|
||||
|
||||
it('should not render the section title, but still render subsection titles in content inline mode', async () => {
|
||||
const note = await createFile(
|
||||
`# Title
|
||||
|
||||
|
||||
## Section 1
|
||||
This is the first section of note E
|
||||
|
||||
### Subsection a
|
||||
This is the first subsection of note E
|
||||
`,
|
||||
['note-e.md']
|
||||
);
|
||||
const parser = createMarkdownParser([]);
|
||||
const ws = new FoamWorkspace().set(parser.parse(note.uri, note.content));
|
||||
|
||||
await withModifiedFoamConfiguration(
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
'content-inline',
|
||||
() => {
|
||||
const md = markdownItWikilinkEmbed(MarkdownIt(), ws, parser);
|
||||
|
||||
expect(
|
||||
md.render(`This is the root node.
|
||||
|
||||
![[note-e#Section 1]]`)
|
||||
).toMatch(
|
||||
`<p>This is the root node.</p>
|
||||
<p><p>This is the first section of note E</p>
|
||||
<h3>Subsection a</h3>
|
||||
<p>This is the first subsection of note E</p>
|
||||
</p>`
|
||||
);
|
||||
}
|
||||
);
|
||||
|
||||
await deleteFile(note);
|
||||
});
|
||||
|
||||
it('should not render the subsection title in content mode if you link to it and regardless of its level', async () => {
|
||||
const note = await createFile(
|
||||
`# Title
|
||||
## Section 1
|
||||
This is the first section of note E
|
||||
|
||||
### Subsection a
|
||||
This is the first subsection of note E`,
|
||||
['note-e.md']
|
||||
);
|
||||
const parser = createMarkdownParser([]);
|
||||
const ws = new FoamWorkspace().set(parser.parse(note.uri, note.content));
|
||||
|
||||
await withModifiedFoamConfiguration(
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
'content-inline',
|
||||
() => {
|
||||
const md = markdownItWikilinkEmbed(MarkdownIt(), ws, parser);
|
||||
|
||||
expect(
|
||||
md.render(`This is the root node.
|
||||
|
||||
![[note-e#Subsection a]]`)
|
||||
).toMatch(
|
||||
`<p>This is the root node.</p>
|
||||
<p><p>This is the first subsection of note E</p>
|
||||
</p>`
|
||||
);
|
||||
}
|
||||
);
|
||||
|
||||
await deleteFile(note);
|
||||
});
|
||||
|
||||
it('should allow a note embedding type to be overridden if a modifier is passed in', async () => {
|
||||
const note = await createFile(
|
||||
`
|
||||
# Section 1
|
||||
This is the first section of note E
|
||||
|
||||
# Section 2
|
||||
This is the second section of note E
|
||||
|
||||
# Section 3
|
||||
This is the third section of note E
|
||||
`,
|
||||
['note-e.md']
|
||||
);
|
||||
const parser = createMarkdownParser([]);
|
||||
const ws = new FoamWorkspace().set(parser.parse(note.uri, note.content));
|
||||
const md = markdownItWikilinkEmbed(MarkdownIt(), ws, parser);
|
||||
|
||||
await withModifiedFoamConfiguration(
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
'full-inline',
|
||||
() => {
|
||||
expect(
|
||||
md.render(`This is the root node.
|
||||
|
||||
content![[note-e#Section 2]]
|
||||
|
||||
full![[note-e#Section 3]]`)
|
||||
).toMatch(
|
||||
`<p>This is the root node.</p>
|
||||
<p><p>This is the second section of note E</p>
|
||||
</p>
|
||||
<p><h1>Section 3</h1>
|
||||
<p>This is the third section of note E</p>
|
||||
</p>
|
||||
`
|
||||
);
|
||||
}
|
||||
);
|
||||
|
||||
await deleteFile(note);
|
||||
});
|
||||
|
||||
it('should allow a note embedding type to be overridden if two modifiers are passed in', async () => {
|
||||
const note = await createFile(
|
||||
`
|
||||
# Section 1
|
||||
This is the first section of note E
|
||||
|
||||
# Section 2
|
||||
This is the second section of note E
|
||||
`,
|
||||
['note-e.md']
|
||||
);
|
||||
const parser = createMarkdownParser([]);
|
||||
const ws = new FoamWorkspace().set(parser.parse(note.uri, note.content));
|
||||
const md = markdownItWikilinkEmbed(MarkdownIt(), ws, parser);
|
||||
|
||||
await withModifiedFoamConfiguration(
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
'full-inline',
|
||||
() => {
|
||||
const res = md.render(`This is the root node.
|
||||
|
||||
content-card![[note-e#Section 2]]`);
|
||||
|
||||
expect(res).toContain('This is the root node');
|
||||
expect(res).toContain('embed-container-note');
|
||||
expect(res).toContain('This is the second section of note E');
|
||||
expect(res).not.toContain('Section 2');
|
||||
}
|
||||
);
|
||||
|
||||
@@ -175,6 +364,27 @@ This is the third section of note E
|
||||
);
|
||||
});
|
||||
|
||||
it('should render the bare text for an embedded note that is embedding a note that is not found', async () => {
|
||||
const note = await createFile(
|
||||
'This is the text of note A which includes ![[does-not-exist]]',
|
||||
['note.md']
|
||||
);
|
||||
|
||||
const ws = new FoamWorkspace().set(parser.parse(note.uri, note.content));
|
||||
|
||||
await withModifiedFoamConfiguration(
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
'full-inline',
|
||||
() => {
|
||||
const md = markdownItWikilinkEmbed(MarkdownIt(), ws, parser);
|
||||
expect(md.render(`This is the root node. ![[note]]`)).toMatch(
|
||||
`<p>This is the root node. <p>This is the text of note A which includes ![[does-not-exist]]</p>
|
||||
</p>`
|
||||
);
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
it('should display a warning in case of cyclical inclusions', async () => {
|
||||
const noteA = await createFile(
|
||||
'This is the text of note A which includes ![[note-b]]',
|
||||
@@ -187,14 +397,21 @@ This is the third section of note E
|
||||
const ws = new FoamWorkspace()
|
||||
.set(parser.parse(noteA.uri, noteA.content))
|
||||
.set(parser.parse(noteB.uri, noteB.content));
|
||||
const md = markdownItWikilinkEmbed(MarkdownIt(), ws, parser);
|
||||
const res = md.render(noteBText);
|
||||
|
||||
expect(res).toContain('This is the text of note B which includes');
|
||||
expect(res).toContain('This is the text of note A which includes');
|
||||
expect(res).toContain('Cyclic link detected for wikilink');
|
||||
await withModifiedFoamConfiguration(
|
||||
CONFIG_EMBED_NOTE_TYPE,
|
||||
'full-card',
|
||||
() => {
|
||||
const md = markdownItWikilinkEmbed(MarkdownIt(), ws, parser);
|
||||
const res = md.render(noteBText);
|
||||
|
||||
deleteFile(noteA);
|
||||
deleteFile(noteB);
|
||||
expect(res).toContain('This is the text of note B which includes');
|
||||
expect(res).toContain('This is the text of note A which includes');
|
||||
expect(res).toContain('Cyclic link detected for wikilink');
|
||||
}
|
||||
);
|
||||
|
||||
await deleteFile(noteA);
|
||||
await deleteFile(noteB);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
import { retrieveNoteConfig } from './wikilink-embed';
|
||||
import {
|
||||
WIKILINK_EMBED_REGEX,
|
||||
WIKILINK_EMBED_REGEX_GROUPS,
|
||||
retrieveNoteConfig,
|
||||
} from './wikilink-embed';
|
||||
import * as config from '../../services/config';
|
||||
|
||||
describe('Wikilink Note Embedding', () => {
|
||||
@@ -6,25 +10,81 @@ describe('Wikilink Note Embedding', () => {
|
||||
jest.clearAllMocks();
|
||||
});
|
||||
|
||||
describe('Wikilink Parsing', () => {
|
||||
it('should match a wikilink item including a modifier and wikilink', () => {
|
||||
// no configuration
|
||||
expect('![[note-a]]').toMatch(WIKILINK_EMBED_REGEX);
|
||||
|
||||
// one of the configurations
|
||||
expect('full![[note-a]]').toMatch(WIKILINK_EMBED_REGEX);
|
||||
expect('content![[note-a]]').toMatch(WIKILINK_EMBED_REGEX);
|
||||
expect('inline![[note-a]]').toMatch(WIKILINK_EMBED_REGEX);
|
||||
expect('card![[note-a]]').toMatch(WIKILINK_EMBED_REGEX);
|
||||
|
||||
// any combination of configurations
|
||||
expect('full-inline![[note-a]]').toMatch(WIKILINK_EMBED_REGEX);
|
||||
expect('full-card![[note-a]]').toMatch(WIKILINK_EMBED_REGEX);
|
||||
expect('content-inline![[note-a]]').toMatch(WIKILINK_EMBED_REGEX);
|
||||
expect('content-card![[note-a]]').toMatch(WIKILINK_EMBED_REGEX);
|
||||
});
|
||||
|
||||
it('should only match the wikilink if there are unrecognized keywords', () => {
|
||||
const match1 = 'random-word![[note-a]]'.match(WIKILINK_EMBED_REGEX);
|
||||
expect(match1[0]).toEqual('![[note-a]]');
|
||||
expect(match1[1]).toEqual('![[note-a]]');
|
||||
|
||||
const match2 = 'foo![[note-a#section 1]]'.match(WIKILINK_EMBED_REGEX);
|
||||
expect(match2[0]).toEqual('![[note-a#section 1]]');
|
||||
expect(match2[1]).toEqual('![[note-a#section 1]]');
|
||||
});
|
||||
|
||||
it('should group the wikilink into modifier and wikilink', () => {
|
||||
const match1 = 'content![[note-a]]'.match(WIKILINK_EMBED_REGEX_GROUPS);
|
||||
expect(match1[0]).toEqual('content![[note-a]]');
|
||||
expect(match1[1]).toEqual('content');
|
||||
expect(match1[2]).toEqual('note-a');
|
||||
|
||||
const match2 = 'full-inline![[note-a#section 1]]'.match(
|
||||
WIKILINK_EMBED_REGEX_GROUPS
|
||||
);
|
||||
expect(match2[0]).toEqual('full-inline![[note-a#section 1]]');
|
||||
expect(match2[1]).toEqual('full-inline');
|
||||
expect(match2[2]).toEqual('note-a#section 1');
|
||||
|
||||
const match3 = '![[note-a#section 1]]'.match(WIKILINK_EMBED_REGEX_GROUPS);
|
||||
expect(match3[0]).toEqual('![[note-a#section 1]]');
|
||||
expect(match3[1]).toEqual(undefined);
|
||||
expect(match3[2]).toEqual('note-a#section 1');
|
||||
});
|
||||
});
|
||||
|
||||
describe('Config Parsing', () => {
|
||||
it('should use preview.embedNoteType if deprecated preview.embedNoteInContainer not used', () => {
|
||||
it('should use preview.embedNoteType if an explicit modifier is not passed in', () => {
|
||||
jest
|
||||
.spyOn(config, 'getFoamVsCodeConfig')
|
||||
.mockReturnValueOnce('full-card')
|
||||
.mockReturnValueOnce(false);
|
||||
.mockReturnValueOnce('full-card');
|
||||
|
||||
const { noteScope, noteStyle } = retrieveNoteConfig();
|
||||
const { noteScope, noteStyle } = retrieveNoteConfig(undefined);
|
||||
expect(noteScope).toEqual('full');
|
||||
expect(noteStyle).toEqual('card');
|
||||
});
|
||||
|
||||
it('should use preview.embedNoteInContainer if set', () => {
|
||||
it('should use explicit modifier over user settings if passed in', () => {
|
||||
jest
|
||||
.spyOn(config, 'getFoamVsCodeConfig')
|
||||
.mockReturnValueOnce('full-inline')
|
||||
.mockReturnValueOnce(true);
|
||||
.mockReturnValueOnce('full-inline')
|
||||
.mockReturnValueOnce('full-inline');
|
||||
|
||||
const { noteScope, noteStyle } = retrieveNoteConfig();
|
||||
let { noteScope, noteStyle } = retrieveNoteConfig('content-card');
|
||||
expect(noteScope).toEqual('content');
|
||||
expect(noteStyle).toEqual('card');
|
||||
|
||||
({ noteScope, noteStyle } = retrieveNoteConfig('content'));
|
||||
expect(noteScope).toEqual('content');
|
||||
expect(noteStyle).toEqual('inline');
|
||||
|
||||
({ noteScope, noteStyle } = retrieveNoteConfig('card'));
|
||||
expect(noteScope).toEqual('full');
|
||||
expect(noteStyle).toEqual('card');
|
||||
});
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
import { readFileSync } from 'fs';
|
||||
import { workspace as vsWorkspace } from 'vscode';
|
||||
import markdownItRegex from 'markdown-it-regex';
|
||||
import { isSome } from '../../utils';
|
||||
import { isSome, isNone } from '../../utils';
|
||||
import { FoamWorkspace } from '../../core/model/workspace';
|
||||
import { Logger } from '../../core/utils/log';
|
||||
import { Resource, ResourceParser } from '../../core/model/note';
|
||||
@@ -14,7 +14,13 @@ import { MarkdownLink } from '../../core/services/markdown-link';
|
||||
import { Position } from '../../core/model/position';
|
||||
import { TextEdit } from '../../core/services/text-edit';
|
||||
|
||||
export const CONFIG_EMBED_NOTE_IN_CONTAINER = 'preview.embedNoteInContainer';
|
||||
export const WIKILINK_EMBED_REGEX =
|
||||
/((?:(?:full|content)-(?:inline|card)|full|content|inline|card)?!\[\[[^[\]]+?\]\])/;
|
||||
// we need another regex because md.use(regex, replace) only permits capturing one group
|
||||
// so we capture the entire possible wikilink item (ex. content-card![[note]]) using WIKILINK_EMBED_REGEX and then
|
||||
// use WIKILINK_EMBED_REGEX_GROUPER to parse it into the modifier(content-card) and the wikilink(note)
|
||||
export const WIKILINK_EMBED_REGEX_GROUPS =
|
||||
/((?:\w+)|(?:(?:\w+)-(?:\w+)))?!\[\[([^[\]]+?)\]\]/;
|
||||
export const CONFIG_EMBED_NOTE_TYPE = 'preview.embedNoteType';
|
||||
const refsStack: string[] = [];
|
||||
|
||||
@@ -25,9 +31,13 @@ export const markdownItWikilinkEmbed = (
|
||||
) => {
|
||||
return md.use(markdownItRegex, {
|
||||
name: 'embed-wikilinks',
|
||||
regex: /!\[\[([^[\]]+?)\]\]/,
|
||||
replace: (wikilink: string) => {
|
||||
regex: WIKILINK_EMBED_REGEX,
|
||||
replace: (wikilinkItem: string) => {
|
||||
try {
|
||||
const [_, noteEmbedModifier, wikilink] = wikilinkItem.match(
|
||||
WIKILINK_EMBED_REGEX_GROUPS
|
||||
);
|
||||
|
||||
const includedNote = workspace.find(wikilink);
|
||||
|
||||
if (!includedNote) {
|
||||
@@ -50,9 +60,15 @@ export const markdownItWikilinkEmbed = (
|
||||
|
||||
switch (includedNote.type) {
|
||||
case 'note': {
|
||||
const { noteScope: _, noteStyle } = retrieveNoteConfig();
|
||||
const { noteScope, noteStyle } =
|
||||
retrieveNoteConfig(noteEmbedModifier);
|
||||
|
||||
const extractor: EmbedNoteExtractor = fullExtractor;
|
||||
const extractor: EmbedNoteExtractor =
|
||||
noteScope === 'full'
|
||||
? fullExtractor
|
||||
: noteScope === 'content'
|
||||
? contentExtractor
|
||||
: fullExtractor;
|
||||
|
||||
const formatter: EmbedNoteFormatter =
|
||||
noteStyle === 'card'
|
||||
@@ -84,7 +100,7 @@ Embed for attachments is not supported
|
||||
return html;
|
||||
} catch (e) {
|
||||
Logger.error(
|
||||
`Error while including [[${wikilink}]] into the current document of the Preview panel`,
|
||||
`Error while including ${wikilinkItem} into the current document of the Preview panel`,
|
||||
e
|
||||
);
|
||||
return '';
|
||||
@@ -106,6 +122,11 @@ function withLinksRelativeToWorkspaceRoot(
|
||||
.map(link => {
|
||||
const info = MarkdownLink.analyzeLink(link);
|
||||
const resource = workspace.find(info.target);
|
||||
// embedded notes that aren't created are still collected
|
||||
// return null so it can be filtered in the next step
|
||||
if (isNone(resource)) {
|
||||
return null;
|
||||
}
|
||||
const pathFromRoot = vsWorkspace.asRelativePath(
|
||||
toVsCodeUri(resource.uri)
|
||||
);
|
||||
@@ -113,6 +134,7 @@ function withLinksRelativeToWorkspaceRoot(
|
||||
target: pathFromRoot,
|
||||
});
|
||||
})
|
||||
.filter(linkEdits => !isNone(linkEdits))
|
||||
.sort((a, b) => Position.compareTo(b.range.start, a.range.start));
|
||||
const text = edits.reduce(
|
||||
(text, edit) => TextEdit.apply(text, edit),
|
||||
@@ -121,17 +143,22 @@ function withLinksRelativeToWorkspaceRoot(
|
||||
return text;
|
||||
}
|
||||
|
||||
export function retrieveNoteConfig(): {
|
||||
export function retrieveNoteConfig(explicitModifier: string | undefined): {
|
||||
noteScope: string;
|
||||
noteStyle: string;
|
||||
} {
|
||||
let config = getFoamVsCodeConfig<string>(CONFIG_EMBED_NOTE_TYPE); // ex. full-inline
|
||||
let [noteScope, noteStyle] = config.split('-');
|
||||
|
||||
// **DEPRECATED** setting to be removed
|
||||
// for now it overrides the above to preserve user settings if they have it set
|
||||
if (getFoamVsCodeConfig<boolean>(CONFIG_EMBED_NOTE_IN_CONTAINER, false)) {
|
||||
noteStyle = 'card';
|
||||
// an explicit modifier will always override corresponding user setting
|
||||
if (explicitModifier !== undefined) {
|
||||
if (['full', 'content'].includes(explicitModifier)) {
|
||||
noteScope = explicitModifier;
|
||||
} else if (['card', 'inline'].includes(explicitModifier)) {
|
||||
noteStyle = explicitModifier;
|
||||
} else {
|
||||
[noteScope, noteStyle] = explicitModifier.split('-');
|
||||
}
|
||||
}
|
||||
return { noteScope, noteStyle };
|
||||
}
|
||||
@@ -162,6 +189,32 @@ function fullExtractor(
|
||||
return noteText;
|
||||
}
|
||||
|
||||
function contentExtractor(
|
||||
note: Resource,
|
||||
parser: ResourceParser,
|
||||
workspace: FoamWorkspace
|
||||
): string {
|
||||
let noteText = readFileSync(note.uri.toFsPath()).toString();
|
||||
let section = Resource.findSection(note, note.uri.fragment);
|
||||
if (!note.uri.fragment) {
|
||||
// if there's no fragment(section), the wikilink is linking to the entire note,
|
||||
// in which case we need to remove the title. We could just use rows.shift()
|
||||
// but should the note start with blank lines, it will only remove the first blank line
|
||||
// leaving the title
|
||||
// A better way is to find where the actual title starts by assuming it's at section[0]
|
||||
// then we treat it as the same case as link to a section
|
||||
section = note.sections.length ? note.sections[0] : null;
|
||||
}
|
||||
let rows = noteText.split('\n');
|
||||
if (isSome(section)) {
|
||||
rows = rows.slice(section.range.start.line, section.range.end.line);
|
||||
}
|
||||
rows.shift();
|
||||
noteText = rows.join('\n');
|
||||
noteText = withLinksRelativeToWorkspaceRoot(noteText, parser, workspace);
|
||||
return noteText;
|
||||
}
|
||||
|
||||
/**
|
||||
* A type of function that renders note content with the desired style in html
|
||||
*/
|
||||
|
||||
@@ -52,6 +52,15 @@ describe('Link generation in preview', () => {
|
||||
);
|
||||
});
|
||||
|
||||
it('generates a link to a section within the note', () => {
|
||||
expect(md.render(`[[#sec]]`)).toEqual(
|
||||
`<p><a class='foam-note-link' title='sec' href='#sec' data-href='#sec'>#sec</a></p>\n`
|
||||
);
|
||||
expect(md.render(`[[#Section Name]]`)).toEqual(
|
||||
`<p><a class='foam-note-link' title='Section Name' href='#section-name' data-href='#section-name'>#Section Name</a></p>\n`
|
||||
);
|
||||
});
|
||||
|
||||
it('generates a link to a note with a specific section', () => {
|
||||
expect(md.render(`[[note-b#sec2]]`)).toEqual(
|
||||
`<p><a class='foam-note-link' title='My second note#sec2' href='/path2/to/note-b.md#sec2' data-href='/path2/to/note-b.md#sec2'>note-b#sec2</a></p>\n`
|
||||
|
||||
@@ -9,6 +9,7 @@ import { toVsCodeUri } from '../../utils/vsc-utils';
|
||||
import { MarkdownLink } from '../../core/services/markdown-link';
|
||||
import { Range } from '../../core/model/range';
|
||||
import { isEmpty } from 'lodash';
|
||||
import { toSlug } from '../../utils/slug';
|
||||
|
||||
export const markdownItWikilinkNavigation = (
|
||||
md: markdownit,
|
||||
@@ -26,18 +27,29 @@ export const markdownItWikilinkNavigation = (
|
||||
isEmbed: false,
|
||||
});
|
||||
const formattedSection = section ? `#${section}` : '';
|
||||
const linkSection = section ? `#${toSlug(section)}` : '';
|
||||
const label = isEmpty(alias) ? `${target}${formattedSection}` : alias;
|
||||
|
||||
// [[#section]] links
|
||||
if (target.length === 0) {
|
||||
// we don't have a good way to check if the section exists within the
|
||||
// open file, so we just create a regular link for it
|
||||
return getResourceLink(section, linkSection, label);
|
||||
}
|
||||
|
||||
const resource = workspace.find(target);
|
||||
if (isNone(resource)) {
|
||||
return getPlaceholderLink(label);
|
||||
}
|
||||
|
||||
const link = `${vscode.workspace.asRelativePath(
|
||||
const resourceLink = `/${vscode.workspace.asRelativePath(
|
||||
toVsCodeUri(resource.uri)
|
||||
)}${formattedSection}`;
|
||||
const title = `${resource.title}${formattedSection}`;
|
||||
return `<a class='foam-note-link' title='${title}' href='/${link}' data-href='/${link}'>${label}</a>`;
|
||||
)}`;
|
||||
return getResourceLink(
|
||||
`${resource.title}${formattedSection}`,
|
||||
`${resourceLink}${linkSection}`,
|
||||
label
|
||||
);
|
||||
} catch (e) {
|
||||
Logger.error(
|
||||
`Error while creating link for [[${wikilink}]] in Preview panel`,
|
||||
@@ -52,4 +64,7 @@ export const markdownItWikilinkNavigation = (
|
||||
const getPlaceholderLink = (content: string) =>
|
||||
`<a class='foam-placeholder-link' title="Link to non-existing resource" href="javascript:void(0);">${content}</a>`;
|
||||
|
||||
const getResourceLink = (title: string, link: string, label: string) =>
|
||||
`<a class='foam-note-link' title='${title}' href='${link}' data-href='${link}'>${label}</a>`;
|
||||
|
||||
export default markdownItWikilinkNavigation;
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
👀*This is an early stage project under rapid development. For updates join the [Foam community Discord](https://foambubble.github.io/join-discord/g)! 💬*
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
||||
[](#contributors-)
|
||||
[](#contributors-)
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||||
|
||||
[](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode)
|
||||
@@ -346,6 +346,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
||||
<tr>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://amnesiak.org/me"><img src="https://avatars.githubusercontent.com/u/952059?v=4?s=60" width="60px;" alt="Tony Cheneau"/><br /><sub><b>Tony Cheneau</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=tcheneau" title="Documentation">📖</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/nicholas-l"><img src="https://avatars.githubusercontent.com/u/12977174?v=4?s=60" width="60px;" alt="Nicholas Latham"/><br /><sub><b>Nicholas Latham</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=nicholas-l" title="Code">💻</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://thara.dev"><img src="https://avatars.githubusercontent.com/u/1532891?v=4?s=60" width="60px;" alt="Tomochika Hara"/><br /><sub><b>Tomochika Hara</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=thara" title="Documentation">📖</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
Reference in New Issue
Block a user