Compare commits

...

15 Commits

Author SHA1 Message Date
Riccardo Ferretti
d0b3d5ff11 v0.24.0 2023-05-19 11:07:30 +02:00
Riccardo Ferretti
34fb62bb0b Preparation for next release 2023-05-19 11:07:02 +02:00
Riccardo Ferretti
f297139e0c getBlock supports sections 2023-05-19 11:04:32 +02:00
Riccardo
09e13f77b0 Connections panel (#1230)
* Turning backlinks panel to connections panel

* Added support for filter commands

* Fixed broken imports that were driving tests nuts

* Do not register connections.* commands during test
2023-05-19 09:52:54 +02:00
allcontributors[bot]
56d8c4c7a0 add hezhizhen as a contributor for tool (#1229)
* update docs/index.md [skip ci]

* update readme.md [skip ci]

* update .all-contributorsrc [skip ci]

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
2023-05-14 18:18:21 +02:00
Zhizhen He
626a323193 Add GH Action workflow to check spell (#1221) 2023-05-14 18:16:08 +02:00
Riccardo
25d9b5e459 Chore: improve janitor code (#1228)
* Refactor: improved generate link references code

* Cleaned up update-wikilink module

* update-wikilink command uses janitor code

* Moved NoteLinkDefinition code in own class, and fixed duplication error

* Renamed command

* Testing on linux only...while I figure out the issue with the other systems
2023-05-11 17:56:21 +02:00
Riccardo
c2241f16de Refactoring of Backlinks, Placeholder and Orphan panels (#1226)
- Placeholder and Orphan panels using the Folder hierarchy

- Backlinks using the same pattern as the other tree views
2023-05-07 22:06:22 +02:00
Riccardo Ferretti
5dee7cb2c0 Fixed link in documentation (#1225) 2023-05-07 21:40:14 +02:00
Riccardo
154ded382b Lint and cleanup (#1224)
* Simplified feature activation API

* Moved tree view util modules and added comments to classes

* Removed deprecated command foam-vscode.create-note-from-default-template
2023-05-06 15:37:00 +02:00
Riccardo Ferretti
5de69ff3c3 v0.23.0 2023-05-06 15:33:46 +02:00
Riccardo Ferretti
8aefcfd515 Preparation for 0.23.0 release 2023-05-06 15:33:22 +02:00
Riccardo
e0e08a2a0f Notes explorer (#1223)
* Added notes explorer

* Fixed line reference in range tree items

Thanks to Wikilens extensions for the high level inspiration (and the choice for the backlink tree item icon, as I find it just perfect)
2023-05-06 14:49:19 +02:00
Riccardo
93c5d2f80c Improvements in tree views (#1220) 2023-05-02 10:36:50 +02:00
Jim Graham
1c294d84c5 Enable tag completion in front matter (#1191)
* Addresses #1184

Currently tag completion only works in the front matter if you type a `#`
character. Adding the suggested tag will then mark the tag as a comment

```markdown
---
tags: #foo #bar
---
```

Update the tag completion provider to recognize if we are in the
front-matter, by using adding two functions to utils.ts. Because the
tag completion intellisense must be summoned with either the `#`
character or the keybinding (typically `ctrl+space`), allow
for 2 outcomes

1. if the tag is prefixed in the front matter with a `#`, remove it when
   substituting the tag.
2. If `ctrl-space` is used, recognize we are on the `tags: ` line and
   allow for non-`#` prefaced words.

The tag provider only works on the `tags: ` within the `tags: ` key of
the frontmatter. For example

```markdown
---
title: A title
tags:
 - foo
 - bar
 - |
```
(where `|` is the cursor) will provide suggestions for tags.

Outside the `tags:` element, suggestions will not be provided.
```markdown
---
title: A title
tags:
 - foo
 - bar
dates:
 - 2023-01-1
 - |
```

* Refactor into functions for front matter & content

Refactor the main provider method into two
sub-functions, one for front matter, one for
regular content. Add helper functions to generate
the `CompletionItems` and to find the start & end
indices of the last match to `#{tag}`.
2023-05-02 06:11:06 +02:00
91 changed files with 2610 additions and 1954 deletions

View File

@@ -1022,6 +1022,15 @@
"contributions": [
"code"
]
},
{
"login": "hezhizhen",
"name": "Zhizhen He",
"avatar_url": "https://avatars.githubusercontent.com/u/7611700?v=4",
"profile": "https://t.me/littlepoint",
"contributions": [
"tool"
]
}
],
"contributorsPerLine": 7,

View File

@@ -9,6 +9,16 @@ on:
- master
jobs:
typos-check:
name: Spell Check with Typos
runs-on: ubuntu-latest
steps:
- name: Checkout Actions Repository
uses: actions/checkout@v3
- name: Check spelling with custom config file
uses: crate-ci/typos@v1.14.8
with:
config: ./typos.toml
lint:
name: Lint
runs-on: ubuntu-22.04
@@ -34,12 +44,13 @@ jobs:
test:
name: Build and Test
strategy:
matrix:
os: [macos-12, ubuntu-22.04, windows-2022]
runs-on: ${{ matrix.os }}
env:
OS: ${{ matrix.os }}
# strategy:
# matrix:
# os: [macos-12, ubuntu-22.04, windows-2022]
# runs-on: ${{ matrix.os }}
runs-on: ubuntu-22.04
# env:
# OS: ${{ matrix.os }}
timeout-minutes: 15
steps:
- uses: actions/checkout@v1

View File

@@ -14,7 +14,7 @@ Currently it is not possible within Foam to include other notes into a note. Nex
Initial work and thought on including a note was ignited by issue [#652](https://github.com/foambubble/foam/issues/652). Requested by a user was a likewise functionality as offered in Obsidian. This was simply the ability to include a note.
Whilst researching digital gardening for my own setup, I came across an in-depth overview by [Maggie Appleton](https://maggieappleton.com/roam-garden). Showing examples of her personal Roam Research I see valuable possibilites to connect more information, if we would add additional functionalities to the possibility of including a note. This proposal displays these possible functionalities and markup.
Whilst researching digital gardening for my own setup, I came across an in-depth overview by [Maggie Appleton](https://maggieappleton.com/roam-garden). Showing examples of her personal Roam Research I see valuable possibilities to connect more information, if we would add additional functionalities to the possibility of including a note. This proposal displays these possible functionalities and markup.
## New features
@@ -29,7 +29,7 @@ The minimal functionality is the ability to fully include a note. Markup used in
### Include a section of a note
It could be interesting to only include a section of a note instead of the entire note. In order to do so thse user should be able to use the following syntax:
It could be interesting to only include a section of a note instead of the entire note. In order to do so the user should be able to use the following syntax:
`![[wikilink#section-b]]`
@@ -37,11 +37,11 @@ As a result it will include the section title + section content until the next s
### Include an attribute of a file (note property or frontmatter)
As a user I could be interested in collecting the value of any given proeprty for a note. For example, I might want to include the tags as defined in the frontmatter of note A. This should be possible via the syntax:
As a user I could be interested in collecting the value of any given property for a note. For example, I might want to include the tags as defined in the frontmatter of note A. This should be possible via the syntax:
`![[wikilink:<property>]]`
The property value should be lookedup by foam defined properties, e.g. title, **or** any property defined in the frontmatter of a note.
The property value should be looked up by foam defined properties, e.g. title, **or** any property defined in the frontmatter of a note.
So, the example of including the tags of a note should be:

View File

@@ -117,7 +117,7 @@ The potential solution:
enum LinkReferenceDefinitions {
Off, // link reference definitions are not generated
WithExtensions, // link reference definitions contain .md (or similar) file extensions
WithoutExtensions // link reference definitions do not contain file extenions
WithoutExtensions // link reference definitions do not contain file extensions
}
```

View File

@@ -20,6 +20,6 @@
- select "tags" in top left
- select the tag that was just released, click "edit" and copy release information from changelog
- publish (no need to attach artifacts)
8. Annouce on Discord
8. Announce on Discord
Steps 1 to 6 should really be replaced by a GitHub action...
Steps 1 to 6 should really be replaced by a GitHub action...

View File

@@ -249,6 +249,7 @@ If that sounds like something you're interested in, I'd love to have you along o
<td align="center" valign="top" width="14.28%"><a href="http://yongliangliu.com"><img src="https://avatars.githubusercontent.com/u/41845017?v=4?s=60" width="60px;" alt="Liu YongLiang"/><br /><sub><b>Liu YongLiang</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=tlylt" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://scottakerman.com"><img src="https://avatars.githubusercontent.com/u/15224439?v=4?s=60" width="60px;" alt="Scott Akerman"/><br /><sub><b>Scott Akerman</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=Skakerman" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://www.jim-graham.net/"><img src="https://avatars.githubusercontent.com/u/430293?v=4?s=60" width="60px;" alt="Jim Graham"/><br /><sub><b>Jim Graham</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jimgraham" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://t.me/littlepoint"><img src="https://avatars.githubusercontent.com/u/7611700?v=4?s=60" width="60px;" alt="Zhizhen He"/><br /><sub><b>Zhizhen He</b></sub></a><br /><a href="#tool-hezhizhen" title="Tools">🔧</a></td>
</tr>
</tbody>
</table>

View File

@@ -2,7 +2,7 @@
Foam has various commands that you can explore by calling the command palette and typing "Foam".
In particular, some commands can be very customizible and can help with custom workflows and use cases.
In particular, some commands can be very customizable and can help with custom workflows and use cases.
## foam-vscode.create-note command

View File

@@ -62,7 +62,7 @@ It is possible to customize the style of a node based on the `type` property in
There are a few default node types defined by Foam that are displayed in the graph:
- `note` defines the color for regular nodes whose documents have not overriden the `type` property.
- `note` defines the color for regular nodes whose documents have not overridden the `type` property.
- `placeholder` defines the color for links that don't match any existing note. This is a [[placeholder]] because no file with such name exists.
- see [[wikilinks]] for more info <!--NOTE: this placeholder link should NOT have an associated file. This is to demonstrate the custom coloring-->
- `tag` defines the color for nodes representing #tags, allowing tags to be used as graph nodes similar to backlinks.

View File

@@ -4,7 +4,7 @@ In some situations it might be useful to include the content of another note in
## Including a note
Including a note can be done by adding an `!` before a wikilink defintion. For example `![[wikilink]]`.
Including a note can be done by adding an `!` before a wikilink definition. For example `![[wikilink]]`.
## Custom styling

View File

@@ -19,6 +19,7 @@ The following example:
```
You can open the [raw markdown](https://foambubble.github.io/foam/features/link-reference-definitions.md) to see them at the bottom of this file
You can open the [raw markdown](https://foambubble.github.io/foam/user/features/link-reference-definitions.md) to see them at the bottom of this file
## Specification

View File

@@ -19,7 +19,7 @@ keywords: hello world, bonjour
---
```
This sets the `type` of this document to `feature` and sets **three** keywords for the document: `hello`, `world`, and `bonjour`. The YAML parser will treat both spaces and commas as the seperators for these YAML properties. If you want to use multi-word values for these properties, you will need to combine the words with dashes or underscores (i.e. instead of `hello world`, use `hello_world` or `hello-world`).
This sets the `type` of this document to `feature` and sets **three** keywords for the document: `hello`, `world`, and `bonjour`. The YAML parser will treat both spaces and commas as the separators for these YAML properties. If you want to use multi-word values for these properties, you will need to combine the words with dashes or underscores (i.e. instead of `hello world`, use `hello_world` or `hello-world`).
> You can set as many custom properties for a document as you like, but there are a few [special properties](#special-properties) defined by Foam.
@@ -27,11 +27,11 @@ This sets the `type` of this document to `feature` and sets **three** keywords f
Some properties have special meaning for Foam:
| Name | Description |
| -------------------- | ------------------- |
| `title` | will assign the name to the note that you will see in the graph, regardless of the filename or the first heading (also see how to [[write-notes-in-foam]]) |
| `type` | can be used to style notes differently in the graph (also see [[graph-visualization]]). The default type for a document is `note` unless otherwise specified with this property. |
| `tags` | can be used to add tags to a note (see [[tags]]) |
| Name | Description |
| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `title` | will assign the name to the note that you will see in the graph, regardless of the filename or the first heading (also see how to [[write-notes-in-foam]]) |
| `type` | can be used to style notes differently in the graph (also see [[graph-visualization]]). The default type for a document is `note` unless otherwise specified with this property. |
| `tags` | can be used to add tags to a note (see [[tags]]) |
For example:

View File

@@ -15,6 +15,10 @@ There are two ways of creating a tag:
Tags can also be hierarchical, so you can have `#parent/child` such as #my-tag3/info.
### Tag completion
Typing the `#` character will launch VS Code's "Intellisense." This provider will show a list of possible tags that match the character. If you are editing in the frontmatter [[note-properties|note property]], you can invoke tag completion on the `tags:` line by either typing the `#` character, or using the ["trigger suggest"](https://code.visualstudio.com/docs/editor/intellisense) keybinding (usually `ctrl+space`). If the `#` is used in the frontmatter, it will be removed when the tag is inserted.
## Using *Tag Explorer*
It's possible to navigate tags via the Tag Explorer panel. Expand the Tag Explorer view in the left side bar which will list all the tags found in current Foam environment. Then, each level of tags can be expanded until the options to search by tag and a list of all files containing a particular tag are shown.
@@ -33,7 +37,7 @@ It is possible to customize the way that tags look in the Markdown Preview panel
> Note: the file path for the stylesheet will be relative to the currently open folder in the workspace when changing this setting for the current workspace. If changing this setting for the user, then the file path will be relative to your global [VSCode settings](https://code.visualstudio.com/docs/getstarted/settings).
The end result will be a CSS file that looks similiar to the content below. Now you can make your tags standout in your note previews.
The end result will be a CSS file that looks similar to the content below. Now you can make your tags standout in your note previews.
```css
.foam-tag{
@@ -49,7 +53,10 @@ The end result will be a CSS file that looks similiar to the content below. Now
Given the power of backlinks, some people prefer to use them as tags.
For example you can tag your notes about books with [[book]].
[note-properties|note property]: note-properties.md "Note Properties"
[graph-visualization]: graph-visualization.md "Graph Visualization"
[//begin]: # "Autogenerated link references for markdown compatibility"
[note-properties|note property]: note-properties.md "Note Properties"
[graph-visualization]: graph-visualization.md "Graph Visualization"
[//end]: # "Autogenerated link references"
[//end]: # "Autogenerated link references"

View File

@@ -14,7 +14,7 @@ strategies for getting the most out of Foam. The full docs are included in the
- [[recommended-extensions]]
- [[creating-new-notes]]
- [[write-notes-in-foam]]
- [[sync-notes-with-soruce-control]]
- [[sync-notes-with-source-control]]
- [[keyboard-shortcuts]]
## Features
@@ -57,7 +57,7 @@ See [[publishing]] for more details.
[recommended-extensions]: getting-started/recommended-extensions.md "Recommended Extensions"
[creating-new-notes]: getting-started/creating-new-notes.md "Creating New Notes"
[write-notes-in-foam]: getting-started/write-notes-in-foam.md "Writing Notes"
[sync-notes-with-soruce-control]: getting-started/sync-notes-with-soruce-control.md "Sync notes with source control"
[sync-notes-with-source-control]: getting-started/sync-notes-with-source-control.md "Sync notes with source control"
[keyboard-shortcuts]: getting-started/keyboard-shortcuts.md "Keyboard Shortcuts"
[wikilinks]: features/wikilinks.md "Wikilinks"
[tags]: features/tags.md "Tags"

View File

@@ -50,7 +50,7 @@ In our case, we'll be using the latter tag to wrap our {% raw %}`{{ content }}`{
You may have noticed that we only made modifications to the template `_layouts/page.html`, which means that `_layouts/home.html` won't have KaTeX support. If you wan't to render math in Foam's home page, you'll need to make the same modifications to `_layouts/home.html` as well.
Finally, if all goes well, then our site hosted on Vercel will support rendering math equations with KaTeX after commiting these changes to GitHub. Here's a demo of the default template with KaTeX support: [Foam Template with KaTeX support](https://foam-template.vercel.app/).
Finally, if all goes well, then our site hosted on Vercel will support rendering math equations with KaTeX after committing these changes to GitHub. Here's a demo of the default template with KaTeX support: [Foam Template with KaTeX support](https://foam-template.vercel.app/).
[//begin]: # "Autogenerated link references for markdown compatibility"
[math-support-with-mathjax]: math-support-with-mathjax.md "Math Support"

View File

@@ -65,7 +65,7 @@ gem "jekyll-katex" # Optional, the package that enables KaTeX math rendering
Besides adding the plugin `jekyll-katex` in `_config.yml` and `Gemfile`, we'll also have to follow the guides in [[math-support-with-katex]] to let our site fully support using KaTeX to render math equations.
### Commiting changes to GitHub repo
### Committing changes to GitHub repo
Finally, commit the newly created files to GitHub.

View File

@@ -6,7 +6,7 @@ With this #recipe you can create notes on your iOS device, which will automatica
* You use [Foam for VSCode](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode) to manage your notes
* You wish to adopt a practice such as [A writing inbox for transient and incomplete notes](https://notes.andymatuschak.org/A%20writing%20inbox%20for%20transient%20and%20incomplete%20notes)
* You wish to use [Shorcuts](https://support.apple.com/guide/shortcuts/welcome/ios) to capture quick notes into your Foam notes from your iOS device
* You wish to use [Shortcuts](https://support.apple.com/guide/shortcuts/welcome/ios) to capture quick notes into your Foam notes from your iOS device
## Other tools

View File

@@ -53,7 +53,7 @@ If such an app was worth building, it would have to have the following features:
- Instant loading and syncing for quick notes
- Sleek, simple, beautifully designed user experience.
- Ability to search and navigate forward links and back links (onlly in paid GitJournal version)
- Ability to search and navigate forward links and back links (only in paid GitJournal version)
- Killer feature that makes it the best note taking tool for Foam (?)
Given the effort vs reward ratio, it's a low priority for core team, but if someone wants to work on this, we can provide support! Talk to us on the #mobile-apps channel on [Foam Discord](https://foambubble.github.io/join-discord/w).

View File

@@ -44,7 +44,7 @@ When editing a file, you can easily navigate `[[links]]` by hovering over them t
You can view a page's backlinks using either of the following techniques:
1. Expanding the file's node in the `Repositories` tree, since it's child nodes will represent backlinks. This makes it easy to browse your pages and their backlinks in a single hierachical view.
1. Expanding the file's node in the `Repositories` tree, since it's child nodes will represent backlinks. This makes it easy to browse your pages and their backlinks in a single hierarchical view.
1. Opening a file, and then viewing it's backlinks list at the bottom of the editor view. This makes it easy to read a page and then see its backlinks in a contextually rich way.

View File

@@ -4,5 +4,5 @@
],
"npmClient": "yarn",
"useWorkspaces": true,
"version": "0.22.2"
"version": "0.24.0"
}

View File

@@ -4,6 +4,29 @@ 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.24.0] - 2023-05-19
Features:
- Converted backlinks panel into more general connections panel (#1230)
Internal:
- Improved janitor code (#1228)
- Refactored code related to tree view panels (#1226)
- Lint and cleanup (#1224)
## [0.23.0] - 2023-05-06
Features:
- Added notes explorer (#1223)
Fixes and Improvements:
- Enabled tag completion in front matter (#1191 - thanks @jimgraham)
- Various improvements to tree views (#1220)
## [0.22.2] - 2023-04-20
Fixes and Improvements:

View File

@@ -8,7 +8,7 @@
"type": "git"
},
"homepage": "https://github.com/foambubble/foam",
"version": "0.22.2",
"version": "0.24.0",
"license": "MIT",
"publisher": "foam",
"engines": {
@@ -56,28 +56,34 @@
"views": {
"explorer": [
{
"id": "foam-vscode.backlinks",
"name": "Backlinks",
"id": "foam-vscode.connections",
"name": "Connections",
"icon": "$(references)",
"contextualTitle": "Backlinks"
"contextualTitle": "Foam"
},
{
"id": "foam-vscode.tags-explorer",
"name": "Tag Explorer",
"icon": "$(tag)",
"contextualTitle": "Tags Explorer"
"contextualTitle": "Foam"
},
{
"id": "foam-vscode.notes-explorer",
"name": "Notes",
"icon": "$(notebook)",
"contextualTitle": "Foam"
},
{
"id": "foam-vscode.orphans",
"name": "Orphans",
"icon": "$(debug-gripper)",
"contextualTitle": "Orphans"
"contextualTitle": "Foam"
},
{
"id": "foam-vscode.placeholders",
"name": "Placeholders",
"icon": "$(debug-disconnect)",
"contextualTitle": "Placeholders"
"contextualTitle": "Foam"
}
]
},
@@ -87,8 +93,8 @@
"contents": "No tags found. Notes that contain tags will show up here. You may add tags to a note with a hashtag (#tag) or by adding a tag list to the front matter (tags: tag1, tag2)."
},
{
"view": "foam-vscode.backlinks",
"contents": "No backlinks found for selected resource."
"view": "foam-vscode.connections",
"contents": "Nothing found for the selected resource and the current filter."
},
{
"view": "foam-vscode.orphans",
@@ -101,6 +107,21 @@
],
"menus": {
"view/title": [
{
"command": "foam-vscode.views.connections.show:backlinks",
"when": "view == foam-vscode.connections && foam-vscode.views.connections.show == 'connections'",
"group": "navigation"
},
{
"command": "foam-vscode.views.connections.show:links",
"when": "view == foam-vscode.connections && foam-vscode.views.connections.show == 'backlinks'",
"group": "navigation"
},
{
"command": "foam-vscode.views.connections.show:connections",
"when": "view == foam-vscode.connections && foam-vscode.views.connections.show == 'links'",
"group": "navigation"
},
{
"command": "foam-vscode.views.orphans.group-by:folder",
"when": "view == foam-vscode.orphans && foam-vscode.views.orphans.group-by == 'off'",
@@ -130,6 +151,16 @@
"command": "foam-vscode.views.placeholders.group-by:off",
"when": "view == foam-vscode.placeholders && foam-vscode.views.placeholders.group-by == 'folder'",
"group": "navigation"
},
{
"command": "foam-vscode.views.notes-explorer.show:notes",
"when": "view == foam-vscode.notes-explorer && foam-vscode.views.notes-explorer.show == 'all'",
"group": "navigation"
},
{
"command": "foam-vscode.views.notes-explorer.show:all",
"when": "view == foam-vscode.notes-explorer && foam-vscode.views.notes-explorer.show == 'notes-only'",
"group": "navigation"
}
],
"commandPalette": [
@@ -141,6 +172,18 @@
"command": "foam-vscode.update-graph",
"when": "false"
},
{
"command": "foam-vscode.views.connections.show:connections",
"when": "false"
},
{
"command": "foam-vscode.views.connections.show:backlinks",
"when": "false"
},
{
"command": "foam-vscode.views.connections.show:links",
"when": "false"
},
{
"command": "foam-vscode.views.orphans.group-by:folder",
"when": "false"
@@ -165,6 +208,14 @@
"command": "foam-vscode.views.placeholders.group-by:off",
"when": "false"
},
{
"command": "foam-vscode.views.notes-explorer.show:all",
"when": "false"
},
{
"command": "foam-vscode.views.notes-explorer.show:notes",
"when": "false"
},
{
"command": "foam-vscode.open-resource",
"when": "false"
@@ -197,8 +248,8 @@
"title": "Foam: Show graph"
},
{
"command": "foam-vscode.update-wikilinks",
"title": "Foam: Update Markdown Reference List"
"command": "foam-vscode.update-wikilink-definitions",
"title": "Foam: Update wikilink definitions"
},
{
"command": "foam-vscode.open-daily-note",
@@ -237,6 +288,21 @@
"title": "Group By Folder",
"icon": "$(list-tree)"
},
{
"command": "foam-vscode.views.connections.show:backlinks",
"title": "Show Backlinks",
"icon": "$(arrow-left)"
},
{
"command": "foam-vscode.views.connections.show:links",
"title": "Show Links",
"icon": "$(arrow-right)"
},
{
"command": "foam-vscode.views.connections.show:connections",
"title": "Show All",
"icon": "$(arrow-swap)"
},
{
"command": "foam-vscode.views.orphans.group-by:off",
"title": "Flat list",
@@ -262,6 +328,16 @@
"title": "Flat list",
"icon": "$(list-flat)"
},
{
"command": "foam-vscode.views.notes-explorer.show:all",
"title": "Show all resources",
"icon": "$(files)"
},
{
"command": "foam-vscode.views.notes-explorer.show:notes",
"title": "Show only notes",
"icon": "$(file)"
},
{
"command": "foam-vscode.create-new-template",
"title": "Foam: Create New Template"

View File

@@ -361,7 +361,7 @@ describe('SnippetParser', () => {
assertIdent('this ${1:is ${2:nested with $var}} and repeating $1');
});
test('Parser, choise marker', () => {
test('Parser, choice marker', () => {
const { placeholders } = new SnippetParser().parse('${1|one,two,three|}');
assert.strictEqual(placeholders.length, 1);

View File

@@ -141,7 +141,7 @@ describe('generateLinkReferences', () => {
newText: textForNote(
`
[//begin]: # "Autogenerated link references for markdown compatibility"
[Note being refered as angel]: <Note being refered as angel> "Note being refered as angel"
[Note being referred as angel]: <Note being referred as angel> "Note being referred as angel"
[//end]: # "Autogenerated link references"`
),
range: Range.create(3, 0, 3, 0),
@@ -183,13 +183,11 @@ describe('generateLinkReferences', () => {
const note = findBySlug('file-with-explicit-and-implicit-link-references');
const expected = {
newText: textForNote(
`[^footerlink]: https://foambubble.github.io/
[linkrefenrece]: https://foambubble.github.io/
[//begin]: # "Autogenerated link references for markdown compatibility"
`[//begin]: # "Autogenerated link references for markdown compatibility"
[first-document]: first-document "First Document"
[//end]: # "Autogenerated link references"`
),
range: Range.create(5, 0, 10, 42),
range: Range.create(8, 0, 10, 42),
};
const noteText = await _workspace.readAsMarkdown(note.uri);

View File

@@ -1,12 +1,9 @@
import { Resource } from '../model/note';
import { NoteLinkDefinition, Resource } from '../model/note';
import { Range } from '../model/range';
import {
createMarkdownReferences,
stringifyMarkdownLinkReferenceDefinition,
} from '../services/markdown-provider';
import { createMarkdownReferences } from '../services/markdown-provider';
import { FoamWorkspace } from '../model/workspace';
import { Position } from '../model/position';
import { TextEdit } from '../services/text-edit';
import { Position } from '../model/position';
export const LINK_REFERENCE_DEFINITION_HEADER = `[//begin]: # "Autogenerated link references for markdown compatibility"`;
export const LINK_REFERENCE_DEFINITION_FOOTER = `[//end]: # "Autogenerated link references"`;
@@ -22,112 +19,62 @@ export const generateLinkReferences = async (
return null;
}
const markdownReferences = createMarkdownReferences(
const newWikilinkDefinitions = createMarkdownReferences(
workspace,
note.uri,
note,
includeExtensions
);
const beginDelimiterDef = note.definitions.find(
({ label }) => label === '//begin'
);
const endDelimiterDef = note.definitions.find(
({ label }) => label === '//end'
);
const lines = text.split(eol);
const targetRange =
beginDelimiterDef && endDelimiterDef
? Range.createFromPosition(
beginDelimiterDef.range.start,
endDelimiterDef.range.end
)
: Range.create(
lines.length - 1,
lines[lines.length - 1].length,
lines.length - 1,
lines[lines.length - 1].length
);
const newReferences =
markdownReferences.length === 0
newWikilinkDefinitions.length === 0
? ''
: [
LINK_REFERENCE_DEFINITION_HEADER,
...markdownReferences.map(stringifyMarkdownLinkReferenceDefinition),
...newWikilinkDefinitions.map(NoteLinkDefinition.format),
LINK_REFERENCE_DEFINITION_FOOTER,
].join(eol);
if (note.definitions.length === 0) {
if (newReferences.length === 0) {
return null;
}
// check if the new references match the existing references
const existingReferences = lines
.slice(targetRange.start.line, targetRange.end.line + 1)
.join(eol);
const lines = text.split(eol);
const end = Position.create(
lines.length - 1,
lines[lines.length - 1].length
);
const padding = end.character === 0 ? eol : `${eol}${eol}`;
return {
newText: `${padding}${newReferences}`,
range: Range.createFromPosition(end, end),
};
} else {
const first = note.definitions[0];
const last = note.definitions[note.definitions.length - 1];
// adjust padding based on whether there are existing definitions
// and, if not, whether we are on an empty line at the end of the file
const padding =
newWikilinkDefinitions.length === 0 || // no definitions
!Position.isEqual(targetRange.start, targetRange.end) // replace existing definitions
? ''
: targetRange.start.character > 0 // not an empty line
? `${eol}${eol}`
: eol;
let nonGeneratedReferenceDefinitions = note.definitions;
// if we have more definitions then referenced pages AND the page refers to a page
// we expect non-generated link definitions to be present
// Collect all non-generated definitions, by removing the generated ones
if (
note.definitions.length > markdownReferences.length &&
markdownReferences.length > 0
) {
// remove all autogenerated definitions
const beginIndex = note.definitions.findIndex(
({ label }) => label === '//begin'
);
const endIndex = note.definitions.findIndex(
({ label }) => label === '//end'
);
const generatedDefinitions = [...note.definitions].splice(
beginIndex,
endIndex - beginIndex + 1
);
nonGeneratedReferenceDefinitions = note.definitions.filter(
x => !generatedDefinitions.includes(x)
);
}
// When we only have explicitly defined link definitions &&
// no indication of previously defined generated links &&
// there is no reference to another page, return null
if (
nonGeneratedReferenceDefinitions.length > 0 &&
note.definitions.findIndex(({ label }) => label === '//begin') < 0 &&
markdownReferences.length === 0
) {
return null;
}
// Format link definitions for non-generated links
const nonGeneratedReferences = nonGeneratedReferenceDefinitions
.map(stringifyMarkdownLinkReferenceDefinition)
.join(eol);
const oldReferences = note.definitions
.map(stringifyMarkdownLinkReferenceDefinition)
.join(eol);
// When the newly formatted references match the old ones, OR
// when non-generated references are present, but no new ones are generated
// return null
if (
oldReferences === newReferences ||
(nonGeneratedReferenceDefinitions.length > 0 &&
newReferences === '' &&
markdownReferences.length > 0)
) {
return null;
}
let fullReferences = `${newReferences}`;
// If there are any non-generated definitions, add those to the output as well
if (
nonGeneratedReferenceDefinitions.length > 0 &&
markdownReferences.length > 0
) {
fullReferences = `${nonGeneratedReferences}${eol}${newReferences}`;
}
return {
// @todo: do we need to ensure new lines?
newText: `${fullReferences}`,
range: Range.createFromPosition(first.range!.start, last.range!.end),
};
}
return existingReferences === newReferences
? null
: {
newText: `${padding}${newReferences}`,
range: targetRange,
};
};

View File

@@ -15,6 +15,19 @@ export interface NoteLinkDefinition {
range?: Range;
}
export abstract class NoteLinkDefinition {
static format(definition: NoteLinkDefinition) {
const url =
definition.url.indexOf(' ') > 0 ? `<${definition.url}>` : definition.url;
let text = `[${definition.label}]: ${url}`;
if (definition.title) {
text = `${text} "${definition.title}"`;
}
return text;
}
}
export interface Tag {
label: string;
range: Range;

View File

@@ -86,7 +86,7 @@ export class GenericDataStore implements IDataStore {
/**
* A matcher that instead of using globs uses a list of files to
* check the matches.
* The {@link refresh} function has been added to the interface to accomodate
* The {@link refresh} function has been added to the interface to accommodate
* this matcher, far from ideal but to be refactored later
*/
export class FileListBasedMatcher implements IMatcher {

View File

@@ -7,6 +7,7 @@ import { Logger } from '../utils/log';
import { URI } from '../model/uri';
import { Range } from '../model/range';
import { getRandomURI } from '../../test/test-utils';
import { Position } from '../model/position';
Logger.setLevel('error');
@@ -464,7 +465,7 @@ But with some content.
});
});
describe('Block detection', () => {
describe('Block detection for lists', () => {
const md = `
- this is block 1
- this is [[block]] 2
@@ -508,3 +509,76 @@ this is another simple line
- this is block 2.1`);
});
});
describe('block detection for sections', () => {
const markdown = `
# Section 1
- this is block 1
- this is [[block]] 2
- this is block 2.1
# Section 2
this is a simple line
this is another simple line
## Section 2.1
- this is block 3.1
- this is block 3.1.1
- this is block 3.2
# Section 3
# Section 4
some text
some text
`;
it('should return correct block for valid markdown string with line number', () => {
const { block, nLines } = getBlockFor(markdown, 1);
expect(block).toEqual(`# Section 1
- this is block 1
- this is [[block]] 2
- this is block 2.1
`);
expect(nLines).toEqual(5);
});
it('should return correct block for valid markdown string with position', () => {
const { block, nLines } = getBlockFor(markdown, 6);
expect(block).toEqual(`# Section 2
this is a simple line
this is another simple line
## Section 2.1
- this is block 3.1
- this is block 3.1.1
- this is block 3.2
`);
expect(nLines).toEqual(9);
});
it('should return single line for section with no content', () => {
const { block, nLines } = getBlockFor(markdown, 15);
expect(block).toEqual('# Section 3');
expect(nLines).toEqual(1);
});
it('should return till end of file for last section', () => {
const { block, nLines } = getBlockFor(markdown, 16);
expect(block).toEqual(`# Section 4
some text
some text`);
expect(nLines).toEqual(3);
});
it('should return single line for non-existing line number', () => {
const { block, nLines } = getBlockFor(markdown, 100);
expect(block).toEqual('');
expect(nLines).toEqual(1);
});
it('should return single line for non-existing position', () => {
const { block, nLines } = getBlockFor(markdown, Position.create(100, 2));
expect(block).toEqual('');
expect(nLines).toEqual(1);
});
});

View File

@@ -241,7 +241,7 @@ const sectionsPlugin: ParserPlugin = {
astPointToFoamPosition(tree.position.end).line + 1,
0
);
// Close all the remainig sections
// Close all the remaining sections
while (sectionStack.length > 0) {
const section = sectionStack.pop();
note.sections.push({
@@ -268,7 +268,7 @@ const titlePlugin: ParserPlugin = {
}
},
onDidFindProperties: (props, note) => {
// Give precendence to the title from the frontmatter if it exists
// Give precedence to the title from the frontmatter if it exists
note.title = props.title?.toString() ?? note.title;
},
onDidVisitTree: (tree, note) => {
@@ -433,19 +433,37 @@ export const getBlockFor = (
const searchLine = typeof line === 'number' ? line : line.line;
const tree = blockParser.parse(markdown);
const lines = markdown.split('\n');
let block = null;
let nLines = 0;
let startLine = -1;
let endLine = -1;
// For list items, we also include the sub-lists
visit(tree, ['listItem'], (node: any) => {
if (node.position.start.line === searchLine + 1) {
block = lines
.slice(node.position.start.line - 1, node.position.end.line)
.join('\n');
nLines = node.position.end.line - node.position.start.line;
startLine = node.position.start.line - 1;
endLine = node.position.end.line;
return visit.EXIT;
}
});
if (block == null) {
block = lines[searchLine];
}
// For headings, we also include the sub-sections
let headingLevel = -1;
visit(tree, ['heading'], (node: any) => {
if (startLine > -1 && node.depth <= headingLevel) {
endLine = node.position.start.line - 1;
return visit.EXIT;
}
if (node.position.start.line === searchLine + 1) {
headingLevel = node.depth;
startLine = node.position.start.line - 1;
endLine = lines.length - 1; // in case it's the last section
}
});
let nLines = startLine == -1 ? 1 : endLine - startLine;
let block =
startLine == -1
? lines[searchLine] ?? ''
: lines.slice(startLine, endLine).join('\n');
return { block, nLines };
};

View File

@@ -12,6 +12,7 @@ import { IDisposable } from '../common/lifecycle';
import { ResourceProvider } from '../model/provider';
import { MarkdownLink } from './markdown-link';
import { IDataStore } from './datastore';
import { uniqBy } from 'lodash';
export class MarkdownResourceProvider implements ResourceProvider {
private disposables: IDisposable[] = [];
@@ -106,27 +107,19 @@ export class MarkdownResourceProvider implements ResourceProvider {
export function createMarkdownReferences(
workspace: FoamWorkspace,
noteUri: URI,
source: Resource | URI,
includeExtension: boolean
): NoteLinkDefinition[] {
const source = workspace.find(noteUri);
// Should never occur since we're already in a file,
if (source?.type !== 'note') {
console.warn(
`Note ${noteUri.toString()} note found in workspace when attempting \
to generate markdown reference list`
);
return [];
}
const resource = source instanceof URI ? workspace.find(source) : source;
return source.links
const definitions = resource.links
.filter(link => link.type === 'wikilink')
.map(link => {
const targetUri = workspace.resolveLink(source, link);
const targetUri = workspace.resolveLink(resource, link);
const target = workspace.find(targetUri);
if (isNone(target)) {
Logger.warn(
`Link ${targetUri.toString()} in ${noteUri.toString()} is not valid.`
`Link ${targetUri.toString()} in ${resource.uri.toString()} is not valid.`
);
return null;
}
@@ -135,7 +128,7 @@ to generate markdown reference list`
return null;
}
let relativeUri = target.uri.relativeTo(noteUri.getDirectory());
let relativeUri = target.uri.relativeTo(resource.uri.getDirectory());
if (!includeExtension && relativeUri.path.endsWith('.md')) {
relativeUri = relativeUri.changeExtension('*', '');
}
@@ -152,17 +145,5 @@ to generate markdown reference list`
})
.filter(isSome)
.sort();
}
export function stringifyMarkdownLinkReferenceDefinition(
definition: NoteLinkDefinition
) {
const url =
definition.url.indexOf(' ') > 0 ? `<${definition.url}>` : definition.url;
let text = `[${definition.label}]: ${url}`;
if (definition.title) {
text = `${text} "${definition.title}"`;
}
return text;
return uniqBy(definitions, def => NoteLinkDefinition.format(def));
}

View File

@@ -1,8 +1,6 @@
import { workspace } from 'vscode';
import dateFormat from 'dateformat';
import { focusNote } from './utils';
import { URI } from './core/model/uri';
import { toVsCodeUri } from './utils/vsc-utils';
import { NoteFactory } from './services/templates';
import { getFoamVsCodeConfig } from './services/config';
import { asAbsoluteWorkspaceUri } from './services/editor';
@@ -76,7 +74,7 @@ export function getDailyNoteFileName(date: Date): string {
* this function will create all folders in the path.
*
* @param currentDate The current date, to be used as a title.
* @returns Wether the file was created.
* @returns Whether the file was created.
*/
export async function createDailyNoteIfNotExists(targetDate: Date) {
const pathFromLegacyConfiguration = getDailyNotePath(targetDate);

View File

@@ -54,7 +54,7 @@ export async function activate(context: ExtensionContext) {
]);
// Load the features
const resPromises = features.map(f => f.activate(context, foamPromise));
const resPromises = features.map(feature => feature(context, foamPromise));
const foam = await foamPromise;
Logger.info(`Loaded ${foam.workspace.list().length} resources`);

View File

@@ -1,17 +1,14 @@
import { window, env, ExtensionContext, commands } from 'vscode';
import { FoamFeature } from '../../types';
import { removeBrackets } from '../../utils';
const feature: FoamFeature = {
activate: (context: ExtensionContext) => {
context.subscriptions.push(
commands.registerCommand(
'foam-vscode.copy-without-brackets',
copyWithoutBrackets
)
);
},
};
export default async function activate(context: ExtensionContext) {
context.subscriptions.push(
commands.registerCommand(
'foam-vscode.copy-without-brackets',
copyWithoutBrackets
)
);
}
async function copyWithoutBrackets() {
// Get the active text editor
@@ -34,5 +31,3 @@ async function copyWithoutBrackets() {
window.showInformationMessage('Successfully copied to clipboard!');
}
}
export default feature;

View File

@@ -1,28 +0,0 @@
import { commands, window } from 'vscode';
import * as editor from '../../services/editor';
describe('create-note-from-default-template command', () => {
afterEach(() => {
jest.clearAllMocks();
});
it('can be cancelled while resolving FOAM_TITLE', async () => {
const spy = jest
.spyOn(window, 'showInputBox')
.mockImplementation(jest.fn(() => Promise.resolve(undefined)));
const docCreatorSpy = jest.spyOn(editor, 'createDocAndFocus');
await commands.executeCommand(
'foam-vscode.create-note-from-default-template'
);
expect(spy).toHaveBeenCalledWith({
prompt: `Enter a title for the new note`,
value: 'Title of my New Note',
validateInput: expect.anything(),
});
expect(docCreatorSpy).toHaveBeenCalledTimes(0);
});
});

View File

@@ -1,16 +1,8 @@
import { commands, ExtensionContext } from 'vscode';
import { FoamFeature } from '../../types';
import { createTemplate } from '../../services/templates';
const feature: FoamFeature = {
activate: (context: ExtensionContext) => {
context.subscriptions.push(
commands.registerCommand(
'foam-vscode.create-new-template',
createTemplate
)
);
},
};
export default feature;
export default async function activate(context: ExtensionContext) {
context.subscriptions.push(
commands.registerCommand('foam-vscode.create-new-template', createTemplate)
);
}

View File

@@ -1,28 +0,0 @@
import { commands, window } from 'vscode';
import * as editor from '../../services/editor';
describe('create-note-from-default-template command', () => {
afterEach(() => {
jest.clearAllMocks();
});
it('can be cancelled while resolving FOAM_TITLE', async () => {
const spy = jest
.spyOn(window, 'showInputBox')
.mockImplementation(jest.fn(() => Promise.resolve(undefined)));
const docCreatorSpy = jest.spyOn(editor, 'createDocAndFocus');
await commands.executeCommand(
'foam-vscode.create-note-from-default-template'
);
expect(spy).toHaveBeenCalledWith({
prompt: `Enter a title for the new note`,
value: 'Title of my New Note',
validateInput: expect.anything(),
});
expect(docCreatorSpy).toHaveBeenCalledTimes(0);
});
});

View File

@@ -1,42 +0,0 @@
import { commands, window, ExtensionContext } from 'vscode';
import { FoamFeature } from '../../types';
import { getDefaultTemplateUri, NoteFactory } from '../../services/templates';
import { Resolver } from '../../services/variable-resolver';
/**
* Create a new note from the default template.
*
* @deprecated use 'foam-vscode.create-note' instead
*/
const feature: FoamFeature = {
activate: (context: ExtensionContext) => {
context.subscriptions.push(
commands.registerCommand(
'foam-vscode.create-note-from-default-template',
() => {
window.showWarningMessage(
"This command is deprecated, use 'Foam: Create Note' (foam-vscode.create-note) instead"
);
const resolver = new Resolver(new Map(), new Date());
return NoteFactory.createFromTemplate(
getDefaultTemplateUri(),
resolver,
undefined,
`---
foam_template:
name: New Note
description: Foam's default new note template
---
# \${FOAM_TITLE}
\${FOAM_SELECTED_TEXT}
`
);
}
)
);
},
};
export default feature;

View File

@@ -1,25 +1,20 @@
import { commands, ExtensionContext } from 'vscode';
import { FoamFeature } from '../../types';
import { askUserForTemplate, NoteFactory } from '../../services/templates';
import { Resolver } from '../../services/variable-resolver';
const feature: FoamFeature = {
activate: (context: ExtensionContext) => {
context.subscriptions.push(
commands.registerCommand(
'foam-vscode.create-note-from-template',
async () => {
const templateUri = await askUserForTemplate();
export default async function activate(context: ExtensionContext) {
context.subscriptions.push(
commands.registerCommand(
'foam-vscode.create-note-from-template',
async () => {
const templateUri = await askUserForTemplate();
if (templateUri) {
const resolver = new Resolver(new Map(), new Date());
if (templateUri) {
const resolver = new Resolver(new Map(), new Date());
await NoteFactory.createFromTemplate(templateUri, resolver);
}
await NoteFactory.createFromTemplate(templateUri, resolver);
}
)
);
},
};
export default feature;
}
)
);
}

View File

@@ -1,5 +1,4 @@
import * as vscode from 'vscode';
import { FoamFeature } from '../../types';
import { URI } from '../../core/model/uri';
import {
askUserForTemplate,
@@ -7,12 +6,17 @@ import {
getPathFromTitle,
NoteFactory,
} from '../../services/templates';
import { Foam } from '../../core/model/foam';
import { Resolver } from '../../services/variable-resolver';
import { asAbsoluteWorkspaceUri, fileExists } from '../../services/editor';
import { isSome } from '../../core/utils';
import { CommandDescriptor } from '../../utils/commands';
export default async function activate(context: vscode.ExtensionContext) {
context.subscriptions.push(
vscode.commands.registerCommand(CREATE_NOTE_COMMAND.command, createNote)
);
}
interface CreateNoteArgs {
/**
* The path of the note to create.
@@ -130,13 +134,3 @@ export const CREATE_NOTE_COMMAND = {
};
},
};
const feature: FoamFeature = {
activate: (context: vscode.ExtensionContext, foamPromise: Promise<Foam>) => {
context.subscriptions.push(
vscode.commands.registerCommand(CREATE_NOTE_COMMAND.command, createNote)
);
},
};
export default feature;

View File

@@ -1,5 +1,4 @@
export { default as copyWithoutBracketsCommand } from './copy-without-brackets';
export { default as createFromDefaultTemplateCommand } from './create-note-from-default-template';
export { default as createFromTemplateCommand } from './create-note-from-template';
export { default as createNewTemplate } from './create-new-template';
export { default as janitorCommand } from './janitor';

View File

@@ -5,12 +5,7 @@ import {
commands,
ProgressLocation,
} from 'vscode';
import { FoamFeature } from '../../types';
import {
getWikilinkDefinitionSetting,
LinkReferenceDefinitionsSetting,
} from '../../settings';
import { getWikilinkDefinitionSetting } from '../../settings';
import {
toVsCodePosition,
toVsCodeRange,
@@ -23,15 +18,16 @@ import { Range } from '../../core/model/range';
import detectNewline from 'detect-newline';
import { TextEdit } from '../../core/services/text-edit';
const feature: FoamFeature = {
activate: (context: ExtensionContext, foamPromise: Promise<Foam>) => {
context.subscriptions.push(
commands.registerCommand('foam-vscode.janitor', async () =>
janitor(await foamPromise)
)
);
},
};
export default async function activate(
context: ExtensionContext,
foamPromise: Promise<Foam>
) {
context.subscriptions.push(
commands.registerCommand('foam-vscode.janitor', async () =>
janitor(await foamPromise)
)
);
}
async function janitor(foam: Foam) {
try {
@@ -109,14 +105,14 @@ async function runJanitor(foam: Foam) {
}
const definitions =
wikilinkSetting === LinkReferenceDefinitionsSetting.off
wikilinkSetting === 'off'
? null
: await generateLinkReferences(
note,
noteText,
noteEol,
foam.workspace,
wikilinkSetting === LinkReferenceDefinitionsSetting.withExtensions
wikilinkSetting === 'withExtensions'
);
if (definitions) {
updatedDefinitionListCount += 1;
@@ -151,14 +147,14 @@ async function runJanitor(foam: Foam) {
// Get edits
const heading = await generateHeading(note, noteText, eol);
const definitions =
wikilinkSetting === LinkReferenceDefinitionsSetting.off
wikilinkSetting === 'off'
? null
: await generateLinkReferences(
note,
noteText,
eol,
foam.workspace,
wikilinkSetting === LinkReferenceDefinitionsSetting.withExtensions
wikilinkSetting === 'withExtensions'
);
if (heading || definitions) {
@@ -192,5 +188,3 @@ async function runJanitor(foam: Foam) {
changedAnyFiles: updatedHeadingCount + updatedDefinitionListCount,
};
}
export default feature;

View File

@@ -1,32 +1,33 @@
import { ExtensionContext, commands, window, QuickPickItem } from 'vscode';
import { FoamFeature } from '../../types';
import { openDailyNoteFor } from '../../dated-notes';
import { FoamWorkspace } from '../../core/model/workspace';
import { range } from 'lodash';
import dateFormat from 'dateformat';
import { Foam } from '../../core/model/foam';
const feature: FoamFeature = {
activate: (context: ExtensionContext, foamPromise) => {
context.subscriptions.push(
commands.registerCommand(
'foam-vscode.open-daily-note-for-date',
async () => {
const ws = (await foamPromise).workspace;
const date = await window
.showQuickPick<DateItem>(generateDateItems(ws), {
placeHolder: 'Choose or type a date (YYYY-MM-DD)',
matchOnDescription: true,
matchOnDetail: true,
})
.then(item => {
return item?.date;
});
return openDailyNoteFor(date);
}
)
);
},
};
export default async function activate(
context: ExtensionContext,
foamPromise: Promise<Foam>
) {
context.subscriptions.push(
commands.registerCommand(
'foam-vscode.open-daily-note-for-date',
async () => {
const ws = (await foamPromise).workspace;
const date = await window
.showQuickPick<DateItem>(generateDateItems(ws), {
placeHolder: 'Choose or type a date (YYYY-MM-DD)',
matchOnDescription: true,
matchOnDetail: true,
})
.then(item => {
return item?.date;
});
return openDailyNoteFor(date);
}
)
);
}
class DateItem implements QuickPickItem {
public label: string;
@@ -68,5 +69,3 @@ function generateDateItems(ws: FoamWorkspace): DateItem[] {
return items;
}
export default feature;

View File

@@ -1,20 +1,15 @@
import { ExtensionContext, commands } from 'vscode';
import { FoamFeature } from '../../types';
import { getFoamVsCodeConfig } from '../../services/config';
import { openDailyNoteFor } from '../../dated-notes';
const feature: FoamFeature = {
activate: (context: ExtensionContext, foamPromise) => {
context.subscriptions.push(
commands.registerCommand('foam-vscode.open-daily-note', () =>
openDailyNoteFor(new Date())
)
);
export default async function activate(context: ExtensionContext) {
context.subscriptions.push(
commands.registerCommand('foam-vscode.open-daily-note', () =>
openDailyNoteFor(new Date())
)
);
if (getFoamVsCodeConfig('openDailyNote.onStartup', false)) {
commands.executeCommand('foam-vscode.open-daily-note');
}
},
};
export default feature;
if (getFoamVsCodeConfig('openDailyNote.onStartup', false)) {
commands.executeCommand('foam-vscode.open-daily-note');
}
}

View File

@@ -1,24 +1,19 @@
import { ExtensionContext, commands } from 'vscode';
import { FoamFeature } from '../../types';
import { getFoamVsCodeConfig } from '../../services/config';
import {
createDailyNoteIfNotExists,
openDailyNoteFor,
} from '../../dated-notes';
const feature: FoamFeature = {
activate: (context: ExtensionContext) => {
context.subscriptions.push(
commands.registerCommand('foam-vscode.open-dated-note', date => {
switch (getFoamVsCodeConfig('dateSnippets.afterCompletion')) {
case 'navigateToNote':
return openDailyNoteFor(date);
case 'createNote':
return createDailyNoteIfNotExists(date);
}
})
);
},
};
export default feature;
export default async function activate(context: ExtensionContext) {
context.subscriptions.push(
commands.registerCommand('foam-vscode.open-dated-note', date => {
switch (getFoamVsCodeConfig('dateSnippets.afterCompletion')) {
case 'navigateToNote':
return openDailyNoteFor(date);
case 'createNote':
return createDailyNoteIfNotExists(date);
}
})
);
}

View File

@@ -1,31 +1,29 @@
import { ExtensionContext, commands, window } from 'vscode';
import { FoamFeature } from '../../types';
import { focusNote } from '../../utils';
import { Foam } from '../../core/model/foam';
const feature: FoamFeature = {
activate: (context: ExtensionContext, foamPromise: Promise<Foam>) => {
context.subscriptions.push(
commands.registerCommand('foam-vscode.open-random-note', async () => {
const foam = await foamPromise;
const currentFile = window.activeTextEditor?.document.uri.path;
const notes = foam.workspace.list().filter(r => r.uri.isMarkdown());
if (notes.length <= 1) {
window.showInformationMessage(
'Could not find another note to open. If you believe this is a bug, please file an issue.'
);
return;
}
export default async function activate(
context: ExtensionContext,
foamPromise: Promise<Foam>
) {
context.subscriptions.push(
commands.registerCommand('foam-vscode.open-random-note', async () => {
const foam = await foamPromise;
const currentFile = window.activeTextEditor?.document.uri.path;
const notes = foam.workspace.list().filter(r => r.uri.isMarkdown());
if (notes.length <= 1) {
window.showInformationMessage(
'Could not find another note to open. If you believe this is a bug, please file an issue.'
);
return;
}
let randomNoteIndex = Math.floor(Math.random() * notes.length);
if (notes[randomNoteIndex].uri.path === currentFile) {
randomNoteIndex = (randomNoteIndex + 1) % notes.length;
}
let randomNoteIndex = Math.floor(Math.random() * notes.length);
if (notes[randomNoteIndex].uri.path === currentFile) {
randomNoteIndex = (randomNoteIndex + 1) % notes.length;
}
focusNote(notes[randomNoteIndex].uri, false);
})
);
},
};
export default feature;
focusNote(notes[randomNoteIndex].uri, false);
})
);
}

View File

@@ -1,4 +1,3 @@
import dateFormat from 'dateformat';
import { commands, window } from 'vscode';
import { CommandDescriptor } from '../../utils/commands';
import { OpenResourceArgs, OPEN_COMMAND } from './open-resource';

View File

@@ -1,5 +1,4 @@
import * as vscode from 'vscode';
import { FoamFeature } from '../../types';
import { URI } from '../../core/model/uri';
import { toVsCodeUri } from '../../utils/vsc-utils';
import { Foam } from '../../core/model/foam';
@@ -11,7 +10,18 @@ import { CommandDescriptor } from '../../utils/commands';
import { FoamWorkspace } from '../../core/model/workspace';
import { Resource } from '../../core/model/note';
import { isSome, isNone } from '../../core/utils';
import { Logger } from '../../core/utils/log';
export default async function activate(
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) {
const foam = await foamPromise;
context.subscriptions.push(
vscode.commands.registerCommand(OPEN_COMMAND.command, args => {
return openResource(foam.workspace, args);
})
);
}
export interface OpenResourceArgs {
/**
@@ -81,20 +91,6 @@ async function openResource(workspace: FoamWorkspace, args?: OpenResourceArgs) {
}
}
const feature: FoamFeature = {
activate: async (
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) => {
const foam = await foamPromise;
context.subscriptions.push(
vscode.commands.registerCommand(OPEN_COMMAND.command, args => {
return openResource(foam.workspace, args);
})
);
},
};
interface ResourceItem extends vscode.QuickPickItem {
label: string;
description: string;
@@ -115,5 +111,3 @@ const createQuickPickItemForResource = (resource: Resource): ResourceItem => {
detail: detail,
};
};
export default feature;

View File

@@ -1,17 +1,16 @@
import { commands, ExtensionContext } from 'vscode';
import { FoamFeature } from '../../types';
import { Foam } from '../../core/model/foam';
export const UPDATE_GRAPH_COMMAND_NAME = 'foam-vscode.update-graph';
const feature: FoamFeature = {
activate: (context: ExtensionContext, foamPromise) => {
context.subscriptions.push(
commands.registerCommand(UPDATE_GRAPH_COMMAND_NAME, async () => {
const foam = await foamPromise;
return foam.graph.update();
})
);
},
};
export default feature;
export default async function activate(
context: ExtensionContext,
foamPromise: Promise<Foam>
) {
context.subscriptions.push(
commands.registerCommand(UPDATE_GRAPH_COMMAND_NAME, async () => {
const foam = await foamPromise;
return foam.graph.update();
})
);
}

View File

@@ -1,4 +1,3 @@
import { uniq } from 'lodash';
import {
CancellationToken,
CodeLens,
@@ -12,209 +11,164 @@ import {
workspace,
Position,
} from 'vscode';
import {
hasEmptyTrailing,
docConfig,
loadDocConfig,
isMdEditor,
mdDocSelector,
getText,
} from '../../utils';
import { FoamFeature } from '../../types';
import {
getWikilinkDefinitionSetting,
LinkReferenceDefinitionsSetting,
} from '../../settings';
import { isMdEditor, mdDocSelector } from '../../utils';
import { Foam } from '../../core/model/foam';
import { FoamWorkspace } from '../../core/model/workspace';
import {
createMarkdownReferences,
stringifyMarkdownLinkReferenceDefinition,
} from '../../core/services/markdown-provider';
import {
LINK_REFERENCE_DEFINITION_FOOTER,
LINK_REFERENCE_DEFINITION_HEADER,
generateLinkReferences,
} from '../../core/janitor/generate-link-references';
import { fromVsCodeUri } from '../../utils/vsc-utils';
import { fromVsCodeUri, toVsCodeRange } from '../../utils/vsc-utils';
import { getEditorEOL } from '../../services/editor';
import { ResourceParser } from '../../core/model/note';
import { getWikilinkDefinitionSetting } from '../../settings';
import { IMatcher } from '../../core/services/datastore';
const feature: FoamFeature = {
activate: async (context: ExtensionContext, foamPromise: Promise<Foam>) => {
const foam = await foamPromise;
export default async function activate(
context: ExtensionContext,
foamPromise: Promise<Foam>
) {
const foam = await foamPromise;
context.subscriptions.push(
commands.registerCommand('foam-vscode.update-wikilinks', () =>
updateReferenceList(foam.workspace)
),
workspace.onWillSaveTextDocument(e => {
if (
e.document.languageId === 'markdown' &&
foam.services.matcher.isMatch(fromVsCodeUri(e.document.uri))
) {
e.waitUntil(updateReferenceList(foam.workspace));
}
}),
languages.registerCodeLensProvider(
mdDocSelector,
new WikilinkReferenceCodeLensProvider(foam.workspace)
context.subscriptions.push(
commands.registerCommand('foam-vscode.update-wikilink-definitions', () => {
return updateWikilinkDefinitions(
foam.workspace,
foam.services.parser,
foam.services.matcher
);
}),
workspace.onWillSaveTextDocument(e => {
e.waitUntil(
updateWikilinkDefinitions(
foam.workspace,
foam.services.parser,
foam.services.matcher
)
);
}),
languages.registerCodeLensProvider(
mdDocSelector,
new WikilinkReferenceCodeLensProvider(
foam.workspace,
foam.services.parser
)
);
},
};
async function createReferenceList(foam: FoamWorkspace) {
const editor = window.activeTextEditor;
if (!editor || !isMdEditor(editor)) {
return;
}
const refs = await generateReferenceList(foam, editor.document);
if (refs && refs.length) {
await editor.edit(function (editBuilder) {
if (editor) {
const spacing = hasEmptyTrailing(editor.document)
? docConfig.eol
: docConfig.eol + docConfig.eol;
editBuilder.insert(
new Position(editor.document.lineCount, 0),
spacing + refs.join(docConfig.eol)
);
}
});
}
)
);
}
async function updateReferenceList(foam: FoamWorkspace) {
async function updateWikilinkDefinitions(
fWorkspace: FoamWorkspace,
fParser: ResourceParser,
fMatcher: IMatcher
) {
const editor = window.activeTextEditor;
if (!editor || !isMdEditor(editor)) {
return;
}
loadDocConfig();
const doc = editor.document;
const range = detectReferenceListRange(doc);
if (!range) {
await createReferenceList(foam);
} else {
const refs = generateReferenceList(foam, doc);
// references must always be preceded by an empty line
const spacing = doc.lineAt(range.start.line - 1).isEmptyOrWhitespace
? ''
: docConfig.eol;
await editor.edit(editBuilder => {
editBuilder.replace(range, spacing + refs.join(docConfig.eol));
});
}
}
function generateReferenceList(
foam: FoamWorkspace,
doc: TextDocument
): string[] {
const wikilinkSetting = getWikilinkDefinitionSetting();
if (wikilinkSetting === LinkReferenceDefinitionsSetting.off) {
return [];
if (!isMdEditor(editor) || !fMatcher.isMatch(fromVsCodeUri(doc.uri))) {
return;
}
const note = foam.get(fromVsCodeUri(doc.uri));
const setting = getWikilinkDefinitionSetting();
const eol = getEditorEOL();
const text = doc.getText();
// Should never happen as `doc` is usually given by `editor.document`, which
// binds to an opened note.
if (!note) {
console.warn(
`Can't find note for URI ${doc.uri.path} before attempting to generate its markdown reference list`
);
return [];
if (setting === 'off') {
const { range } = detectDocumentWikilinkDefinitions(text, eol);
if (range) {
await editor.edit(editBuilder => {
editBuilder.delete(toVsCodeRange(range));
});
}
return;
}
const references = uniq(
createMarkdownReferences(
foam,
note.uri,
wikilinkSetting === LinkReferenceDefinitionsSetting.withExtensions
).map(stringifyMarkdownLinkReferenceDefinition)
const resource = fParser.parse(fromVsCodeUri(doc.uri), text);
const update = await generateLinkReferences(
resource,
text,
eol,
fWorkspace,
setting === 'withExtensions'
);
if (references.length) {
return [
LINK_REFERENCE_DEFINITION_HEADER,
...references,
LINK_REFERENCE_DEFINITION_FOOTER,
];
if (update) {
await editor.edit(editBuilder => {
const gap = doc.lineAt(update.range.start.line - 1).isEmptyOrWhitespace
? ''
: eol;
editBuilder.replace(toVsCodeRange(update.range), gap + update.newText);
});
}
return [];
}
/**
* Find the range of existing reference list
* @param doc
* Detects the range of the wikilink definitions in the document.
*/
function detectReferenceListRange(doc: TextDocument): Range | null {
const fullText = doc.getText();
function detectDocumentWikilinkDefinitions(text: string, eol: string) {
const lines = text.split(eol);
const headerIndex = fullText.indexOf(LINK_REFERENCE_DEFINITION_HEADER);
const footerIndex = fullText.lastIndexOf(LINK_REFERENCE_DEFINITION_FOOTER);
if (headerIndex < 0) {
return null;
}
const headerLine =
fullText.substring(0, headerIndex).split(docConfig.eol).length - 1;
const footerLine =
fullText.substring(0, footerIndex).split(docConfig.eol).length - 1;
if (headerLine >= footerLine) {
return null;
}
return new Range(
new Position(headerLine, 0),
new Position(footerLine, LINK_REFERENCE_DEFINITION_FOOTER.length)
const headerLine = lines.findIndex(
line => line === LINK_REFERENCE_DEFINITION_HEADER
);
const footerLine = lines.findIndex(
line => line === LINK_REFERENCE_DEFINITION_FOOTER
);
if (headerLine < 0 || footerLine < 0 || headerLine >= footerLine) {
return { range: null, definitions: null };
}
const range = new Range(
new Position(headerLine, 0),
new Position(footerLine, lines[footerLine].length)
);
const definitions = lines.slice(headerLine, footerLine).join(eol);
return { range, definitions };
}
/**
* Provides a code lens to update the wikilink definitions in the document.
*/
class WikilinkReferenceCodeLensProvider implements CodeLensProvider {
private foam: FoamWorkspace;
constructor(
private fWorkspace: FoamWorkspace,
private fParser: ResourceParser
) {}
constructor(foam: FoamWorkspace) {
this.foam = foam;
}
public provideCodeLenses(
public async provideCodeLenses(
document: TextDocument,
_: CancellationToken
): CodeLens[] | Promise<CodeLens[]> {
loadDocConfig();
): Promise<CodeLens[]> {
const eol = getEditorEOL();
const text = document.getText();
const range = detectReferenceListRange(document);
const { range } = detectDocumentWikilinkDefinitions(text, eol);
if (!range) {
return [];
}
const setting = getWikilinkDefinitionSetting();
const refs = generateReferenceList(this.foam, document);
const oldRefs = getText(range).replace(/\r?\n|\r/g, docConfig.eol);
const newRefs = refs.join(docConfig.eol);
const resource = this.fParser.parse(fromVsCodeUri(document.uri), text);
const update = await generateLinkReferences(
resource,
text,
eol,
this.fWorkspace,
setting === 'withExtensions'
);
const status = oldRefs === newRefs ? 'up to date' : 'out of date';
const status = update == null ? 'up to date' : 'out of date';
return [
new CodeLens(range, {
command:
update == null ? '' : 'foam-vscode.update-wikilink-definitions',
title: `Wikilink definitions (${status})`,
arguments: [],
title: `Link references (${status})`,
command: '',
}),
];
}
}
export default feature;

View File

@@ -9,7 +9,17 @@ import {
} from 'vscode';
import { getDailyNoteFileName } from '../dated-notes';
import { getFoamVsCodeConfig } from '../services/config';
import { FoamFeature } from '../types';
export default async function activate(context: ExtensionContext) {
context.subscriptions.push(
languages.registerCompletionItemProvider('markdown', completions, '/'),
languages.registerCompletionItemProvider(
'markdown',
datesCompletionProvider,
'/'
)
);
}
interface DateSnippet {
snippet: string;
@@ -198,18 +208,3 @@ export const datesCompletionProvider: CompletionItemProvider = {
return new CompletionList(completionItems, true);
},
};
const feature: FoamFeature = {
activate: (context: ExtensionContext) => {
context.subscriptions.push(
languages.registerCompletionItemProvider('markdown', completions, '/'),
languages.registerCompletionItemProvider(
'markdown',
datesCompletionProvider,
'/'
)
);
},
};
export default feature;

View File

@@ -1,6 +1,5 @@
import { debounce } from 'lodash';
import * as vscode from 'vscode';
import { FoamFeature } from '../types';
import { ResourceParser } from '../core/model/note';
import { FoamWorkspace } from '../core/model/workspace';
import { Foam } from '../core/model/foam';
@@ -41,39 +40,35 @@ const updateDecorations =
editor.setDecorations(placeholderDecoration, placeholderRanges);
};
const feature: FoamFeature = {
activate: async (
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) => {
const foam = await foamPromise;
let activeEditor = vscode.window.activeTextEditor;
export default async function activate(
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) {
const foam = await foamPromise;
let activeEditor = vscode.window.activeTextEditor;
const immediatelyUpdateDecorations = updateDecorations(
foam.services.parser,
foam.workspace
);
const immediatelyUpdateDecorations = updateDecorations(
foam.services.parser,
foam.workspace
);
const debouncedUpdateDecorations = debounce(
immediatelyUpdateDecorations,
500
);
const debouncedUpdateDecorations = debounce(
immediatelyUpdateDecorations,
500
);
immediatelyUpdateDecorations(activeEditor);
immediatelyUpdateDecorations(activeEditor);
context.subscriptions.push(
placeholderDecoration,
vscode.window.onDidChangeActiveTextEditor(editor => {
activeEditor = editor;
immediatelyUpdateDecorations(activeEditor);
}),
vscode.workspace.onDidChangeTextDocument(event => {
if (activeEditor && event.document === activeEditor.document) {
debouncedUpdateDecorations(activeEditor);
}
})
);
},
};
export default feature;
context.subscriptions.push(
placeholderDecoration,
vscode.window.onDidChangeActiveTextEditor(editor => {
activeEditor = editor;
immediatelyUpdateDecorations(activeEditor);
}),
vscode.workspace.onDidChangeTextDocument(event => {
if (activeEditor && event.document === activeEditor.document) {
debouncedUpdateDecorations(activeEditor);
}
})
);
}

View File

@@ -1,6 +1,5 @@
import { uniqWith } from 'lodash';
import * as vscode from 'vscode';
import { FoamFeature } from '../types';
import { getNoteTooltip, mdDocSelector, isSome } from '../utils';
import { fromVsCodeUri, toVsCodeRange } from '../utils/vsc-utils';
import {
@@ -18,30 +17,28 @@ import { commandAsURI } from '../utils/commands';
export const CONFIG_KEY = 'links.hover.enable';
const feature: FoamFeature = {
activate: async (
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) => {
const isHoverEnabled: ConfigurationMonitor<boolean> =
monitorFoamVsCodeConfig(CONFIG_KEY);
export default async function activate(
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) {
const isHoverEnabled: ConfigurationMonitor<boolean> =
monitorFoamVsCodeConfig(CONFIG_KEY);
const foam = await foamPromise;
const foam = await foamPromise;
context.subscriptions.push(
isHoverEnabled,
vscode.languages.registerHoverProvider(
mdDocSelector,
new HoverProvider(
isHoverEnabled,
foam.workspace,
foam.graph,
foam.services.parser
)
context.subscriptions.push(
isHoverEnabled,
vscode.languages.registerHoverProvider(
mdDocSelector,
new HoverProvider(
isHoverEnabled,
foam.workspace,
foam.graph,
foam.services.parser
)
);
},
};
)
);
}
export class HoverProvider implements vscode.HoverProvider {
constructor(
@@ -131,5 +128,3 @@ export class HoverProvider implements vscode.HoverProvider {
return hover;
}
}
export default feature;

View File

@@ -4,7 +4,7 @@ import * as panels from './panels';
import dateSnippets from './date-snippets';
import hoverProvider from './hover-provider';
import preview from './preview';
import completionProvider, { completionCursorMove } from './link-completion';
import completionProvider from './link-completion';
import tagCompletionProvider from './tag-completion';
import linkDecorations from './document-decorator';
import navigationProviders from './navigation-provider';
@@ -23,5 +23,4 @@ export const features: FoamFeature[] = [
preview,
completionProvider,
tagCompletionProvider,
completionCursorMove,
];

View File

@@ -5,7 +5,6 @@ import { Resource } from '../core/model/note';
import { URI } from '../core/model/uri';
import { FoamWorkspace } from '../core/model/workspace';
import { getFoamVsCodeConfig } from '../services/config';
import { FoamFeature } from '../types';
import { getNoteTooltip, mdDocSelector } from '../utils';
import { fromVsCodeUri, toVsCodeUri } from '../utils/vsc-utils';
@@ -21,81 +20,72 @@ const COMPLETION_CURSOR_MOVE = {
export const WIKILINK_REGEX = /\[\[[^[\]]*(?!.*\]\])/;
export const SECTION_REGEX = /\[\[([^[\]]*#(?!.*\]\]))/;
const feature: FoamFeature = {
activate: async (
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) => {
const foam = await foamPromise;
context.subscriptions.push(
vscode.languages.registerCompletionItemProvider(
mdDocSelector,
new WikilinkCompletionProvider(foam.workspace, foam.graph),
'['
),
vscode.languages.registerCompletionItemProvider(
mdDocSelector,
new SectionCompletionProvider(foam.workspace),
'#'
)
);
},
};
export default async function activate(
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) {
const foam = await foamPromise;
context.subscriptions.push(
vscode.languages.registerCompletionItemProvider(
mdDocSelector,
new WikilinkCompletionProvider(foam.workspace, foam.graph),
'['
),
vscode.languages.registerCompletionItemProvider(
mdDocSelector,
new SectionCompletionProvider(foam.workspace),
'#'
),
/**
* always jump to the closing bracket, but jump back the cursor when commit
* by alias divider `|` and section divider `#`
* See https://github.com/foambubble/foam/issues/962,
*/
/**
* always jump to the closing bracket, but jump back the cursor when commit
* by alias divider `|` and section divider `#`
* See https://github.com/foambubble/foam/issues/962,
*/
vscode.commands.registerCommand(
COMPLETION_CURSOR_MOVE.command,
async () => {
const activeEditor = vscode.window.activeTextEditor;
const document = activeEditor.document;
const currentPosition = activeEditor.selection.active;
const cursorChange = vscode.window.onDidChangeTextEditorSelection(
async e => {
const changedPosition = e.selections[0].active;
const preChar = document
.lineAt(changedPosition.line)
.text.charAt(changedPosition.character - 1);
export const completionCursorMove: FoamFeature = {
activate: (context: vscode.ExtensionContext, foamPromise: Promise<Foam>) => {
context.subscriptions.push(
vscode.commands.registerCommand(
COMPLETION_CURSOR_MOVE.command,
async () => {
const activeEditor = vscode.window.activeTextEditor;
const document = activeEditor.document;
const currentPosition = activeEditor.selection.active;
const cursorChange = vscode.window.onDidChangeTextEditorSelection(
async e => {
const changedPosition = e.selections[0].active;
const preChar = document
.lineAt(changedPosition.line)
.text.charAt(changedPosition.character - 1);
const { character: selectionChar, line: selectionLine } =
e.selections[0].active;
const { character: selectionChar, line: selectionLine } =
e.selections[0].active;
const { line: completionLine, character: completionChar } =
currentPosition;
const { line: completionLine, character: completionChar } =
currentPosition;
const inCompleteBySectionDivider =
linkCommitCharacters.includes(preChar) &&
selectionLine === completionLine &&
selectionChar === completionChar + 1;
const inCompleteBySectionDivider =
linkCommitCharacters.includes(preChar) &&
selectionLine === completionLine &&
selectionChar === completionChar + 1;
cursorChange.dispose();
if (inCompleteBySectionDivider) {
await vscode.commands.executeCommand('cursorMove', {
to: 'left',
by: 'character',
value: 2,
});
}
cursorChange.dispose();
if (inCompleteBySectionDivider) {
await vscode.commands.executeCommand('cursorMove', {
to: 'left',
by: 'character',
value: 2,
});
}
);
}
);
await vscode.commands.executeCommand('cursorMove', {
to: 'right',
by: 'character',
value: 2,
});
}
)
);
},
};
await vscode.commands.executeCommand('cursorMove', {
to: 'right',
by: 'character',
value: 2,
});
}
)
);
}
export class SectionCompletionProvider
implements vscode.CompletionItemProvider<vscode.CompletionItem>
@@ -307,5 +297,3 @@ const normalize = (text: string) => text.toLocaleLowerCase().trim();
function wikilinkRequiresAlias(resource: Resource) {
return normalize(resource.uri.getName()) !== normalize(resource.title);
}
export default feature;

View File

@@ -1,5 +1,4 @@
import * as vscode from 'vscode';
import { URI } from '../core/model/uri';
import { createTestWorkspace } from '../test/test-utils';
import {
cleanWorkspace,
@@ -8,7 +7,6 @@ import {
showInEditor,
} from '../test/test-utils-vscode';
import { NavigationProvider } from './navigation-provider';
import { OPEN_COMMAND } from './commands/open-resource';
import { toVsCodeUri } from '../utils/vsc-utils';
import { createMarkdownParser } from '../core/services/markdown-parser';
import { FoamGraph } from '../core/model/graph';

View File

@@ -1,5 +1,4 @@
import * as vscode from 'vscode';
import { FoamFeature } from '../types';
import { mdDocSelector } from '../utils';
import { toVsCodeRange, toVsCodeUri, fromVsCodeUri } from '../utils/vsc-utils';
import { Foam } from '../core/model/foam';
@@ -12,35 +11,33 @@ import { Position } from '../core/model/position';
import { CREATE_NOTE_COMMAND } from './commands/create-note';
import { commandAsURI } from '../utils/commands';
const feature: FoamFeature = {
activate: async (
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) => {
const foam = await foamPromise;
export default async function activate(
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) {
const foam = await foamPromise;
const navigationProvider = new NavigationProvider(
foam.workspace,
foam.graph,
foam.services.parser
);
const navigationProvider = new NavigationProvider(
foam.workspace,
foam.graph,
foam.services.parser
);
context.subscriptions.push(
vscode.languages.registerDefinitionProvider(
mdDocSelector,
navigationProvider
),
vscode.languages.registerDocumentLinkProvider(
mdDocSelector,
navigationProvider
),
vscode.languages.registerReferenceProvider(
mdDocSelector,
navigationProvider
)
);
},
};
context.subscriptions.push(
vscode.languages.registerDefinitionProvider(
mdDocSelector,
navigationProvider
),
vscode.languages.registerDocumentLinkProvider(
mdDocSelector,
navigationProvider
),
vscode.languages.registerReferenceProvider(
mdDocSelector,
navigationProvider
)
);
}
/**
* Provides navigation and references for Foam links.
@@ -67,7 +64,7 @@ export class NavigationProvider
) {}
/**
* Provide references for links and placholders
* Provide references for links and placeholders
*/
public provideReferences(
document: vscode.TextDocument,
@@ -182,5 +179,3 @@ export class NavigationProvider
});
}
}
export default feature;

View File

@@ -6,15 +6,13 @@ import {
createNote,
getUriInWorkspace,
} from '../../test/test-utils-vscode';
import { BacklinksTreeDataProvider } from './backlinks';
import { OPEN_COMMAND } from '../commands/open-resource';
import { toVsCodeUri } from '../../utils/vsc-utils';
import { ConnectionsTreeDataProvider } from './backlinks';
import { MapBasedMemento, toVsCodeUri } from '../../utils/vsc-utils';
import { FoamGraph } from '../../core/model/graph';
import { URI } from '../../core/model/uri';
import {
ResourceRangeTreeItem,
ResourceTreeItem,
} from '../../utils/tree-view-utils';
} from './utils/tree-view-utils';
describe('Backlinks panel', () => {
beforeAll(async () => {
@@ -23,11 +21,6 @@ describe('Backlinks panel', () => {
await createNote(noteB);
await createNote(noteC);
});
afterAll(async () => {
graph.dispose();
ws.dispose();
await cleanWorkspace();
});
// TODO: this should really just be the workspace folder, use that once #806 is fixed
const rootUri = getUriInWorkspace('just-a-ref.md');
@@ -50,19 +43,25 @@ describe('Backlinks panel', () => {
ws.set(noteA).set(noteB).set(noteC);
const graph = FoamGraph.fromWorkspace(ws, true);
const provider = new BacklinksTreeDataProvider(ws, graph);
const provider = new ConnectionsTreeDataProvider(
ws,
graph,
new MapBasedMemento(),
false
);
afterAll(async () => {
graph.dispose();
ws.dispose();
provider.dispose();
await cleanWorkspace();
});
beforeEach(async () => {
await closeEditors();
provider.target = undefined;
});
// Skipping these as still figuring out how to interact with the provider
// running in the test instance of VS Code
it.skip('does not target excluded files', async () => {
provider.target = URI.file('/excluded-file.txt');
expect(await provider.getChildren()).toEqual([]);
});
it.skip('targets active editor', async () => {
const docA = await workspace.openTextDocument(toVsCodeUri(noteA.uri));
const docB = await workspace.openTextDocument(toVsCodeUri(noteB.uri));
@@ -76,6 +75,7 @@ describe('Backlinks panel', () => {
it('shows linking resources alphaetically by name', async () => {
provider.target = noteA.uri;
await provider.refresh();
const notes = (await provider.getChildren()) as ResourceTreeItem[];
expect(notes.map(n => n.resource.uri.path)).toEqual([
noteB.uri.path,
@@ -84,6 +84,7 @@ describe('Backlinks panel', () => {
});
it('shows references in range order', async () => {
provider.target = noteA.uri;
await provider.refresh();
const notes = (await provider.getChildren()) as ResourceTreeItem[];
const linksFromB = (await provider.getChildren(
notes[0]
@@ -96,14 +97,24 @@ describe('Backlinks panel', () => {
});
it('navigates to the document if clicking on note', async () => {
provider.target = noteA.uri;
await provider.refresh();
const notes = (await provider.getChildren()) as ResourceTreeItem[];
expect(notes[0].command).toMatchObject({
command: 'vscode.open',
arguments: [expect.objectContaining({ path: noteB.uri.path })],
});
const links = (await provider.getChildren(notes[0])) as ResourceTreeItem[];
expect(links[0].command).toMatchObject({
command: 'vscode.open',
arguments: [
expect.objectContaining({ path: noteB.uri.path }),
expect.objectContaining({ selection: expect.anything() }),
],
});
});
it('navigates to document with link selection if clicking on backlink', async () => {
provider.target = noteA.uri;
await provider.refresh();
const notes = (await provider.getChildren()) as ResourceTreeItem[];
const linksFromB = (await provider.getChildren(
notes[0]
@@ -121,7 +132,7 @@ describe('Backlinks panel', () => {
it('refreshes upon changes in the workspace', async () => {
let notes: ResourceTreeItem[] = [];
provider.target = noteA.uri;
await provider.refresh();
notes = (await provider.getChildren()) as ResourceTreeItem[];
expect(notes.length).toEqual(2);
@@ -130,6 +141,7 @@ describe('Backlinks panel', () => {
uri: './note-d.md',
});
ws.set(noteD);
await provider.refresh();
notes = (await provider.getChildren()) as ResourceTreeItem[];
expect(notes.length).toEqual(2);
@@ -139,8 +151,8 @@ describe('Backlinks panel', () => {
links: [{ slug: 'note-a' }],
});
ws.set(noteDBis);
await provider.refresh();
notes = (await provider.getChildren()) as ResourceTreeItem[];
expect(notes.length).toEqual(3);
expect(notes.map(n => n.resource.uri.path)).toEqual(
[noteB.uri, noteC.uri, noteD.uri].map(uri => uri.path)
);

View File

@@ -1,90 +1,170 @@
import * as vscode from 'vscode';
import { URI } from '../../core/model/uri';
import { isNone } from '../../utils';
import { FoamFeature } from '../../types';
import { Foam } from '../../core/model/foam';
import { FoamWorkspace } from '../../core/model/workspace';
import { FoamGraph } from '../../core/model/graph';
import { fromVsCodeUri } from '../../utils/vsc-utils';
import { Connection, FoamGraph } from '../../core/model/graph';
import { Range } from '../../core/model/range';
import { ContextMemento, fromVsCodeUri } from '../../utils/vsc-utils';
import {
BaseTreeItem,
ResourceRangeTreeItem,
ResourceTreeItem,
groupRangesByResource,
} from '../../utils/tree-view-utils';
UriTreeItem,
createConnectionItemsForResource,
} from './utils/tree-view-utils';
import { BaseTreeProvider } from './utils/base-tree-provider';
const feature: FoamFeature = {
activate: async (
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) => {
const foam = await foamPromise;
export default async function activate(
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) {
const foam = await foamPromise;
const provider = new BacklinksTreeDataProvider(foam.workspace, foam.graph);
const provider = new ConnectionsTreeDataProvider(
foam.workspace,
foam.graph,
context.globalState
);
const treeView = vscode.window.createTreeView('foam-vscode.connections', {
treeDataProvider: provider,
showCollapseAll: true,
});
const baseTitle = treeView.title;
vscode.window.onDidChangeActiveTextEditor(async () => {
provider.target = vscode.window.activeTextEditor
? fromVsCodeUri(vscode.window.activeTextEditor?.document.uri)
: undefined;
await provider.refresh();
});
const updateTreeView = async () => {
provider.target = vscode.window.activeTextEditor
? fromVsCodeUri(vscode.window.activeTextEditor?.document.uri)
: undefined;
await provider.refresh();
};
context.subscriptions.push(
vscode.window.registerTreeDataProvider('foam-vscode.backlinks', provider),
foam.graph.onDidUpdate(() => provider.refresh())
);
},
};
export default feature;
updateTreeView();
export class BacklinksTreeDataProvider
implements vscode.TreeDataProvider<vscode.TreeItem>
{
context.subscriptions.push(
provider,
treeView,
foam.graph.onDidUpdate(() => updateTreeView()),
vscode.window.onDidChangeActiveTextEditor(() => updateTreeView()),
provider.onDidChangeTreeData(() => {
treeView.title = ` ${provider.show.get()} (${provider.nValues})`;
})
);
}
export class ConnectionsTreeDataProvider extends BaseTreeProvider<vscode.TreeItem> {
public show = new ContextMemento<'connections' | 'backlinks' | 'links'>(
this.state,
`foam-vscode.views.connections.show`,
'connections',
true
);
public target?: URI = undefined;
// prettier-ignore
private _onDidChangeTreeDataEmitter = new vscode.EventEmitter<BacklinkPanelTreeItem | undefined | void>();
readonly onDidChangeTreeData = this._onDidChangeTreeDataEmitter.event;
public nValues = 0;
private connectionItems: ResourceRangeTreeItem[] = [];
constructor(private workspace: FoamWorkspace, private graph: FoamGraph) {}
refresh(): void {
this._onDidChangeTreeDataEmitter.fire();
constructor(
private workspace: FoamWorkspace,
private graph: FoamGraph,
public state: vscode.Memento,
registerCommands = true // for testing. don't love it, but will do for now
) {
super();
if (!registerCommands) {
return;
}
this.disposables.push(
vscode.commands.registerCommand(
`foam-vscode.views.connections.show:connections`,
() => {
this.show.update('connections');
this.refresh();
}
),
vscode.commands.registerCommand(
`foam-vscode.views.connections.show:backlinks`,
() => {
this.show.update('backlinks');
this.refresh();
}
),
vscode.commands.registerCommand(
`foam-vscode.views.connections.show:links`,
() => {
this.show.update('links');
this.refresh();
}
)
);
}
getTreeItem(item: BacklinkPanelTreeItem): vscode.TreeItem {
return item;
}
getChildren(item?: BacklinkPanelTreeItem): Promise<vscode.TreeItem[]> {
async refresh(): Promise<void> {
const uri = this.target;
if (item && item instanceof ResourceTreeItem) {
const connectionItems =
isNone(uri) || isNone(this.workspace.find(uri))
? []
: await createConnectionItemsForResource(
this.workspace,
this.graph,
uri,
(connection: Connection) => {
const isBacklink = connection.target
.asPlain()
.isEqual(this.target);
return (
this.show.get() === 'connections' ||
(isBacklink && this.show.get() === 'backlinks') ||
(!isBacklink && this.show.get() === 'links')
);
}
);
this.connectionItems = connectionItems;
this.nValues = connectionItems.length;
super.refresh();
}
async getChildren(item?: BacklinkPanelTreeItem): Promise<vscode.TreeItem[]> {
if (item && item instanceof BaseTreeItem) {
return item.getChildren();
}
if (isNone(uri) || isNone(this.workspace.find(uri))) {
return Promise.resolve([]);
const byResource = this.connectionItems.reduce((acc, item) => {
const connection = item.value as Connection;
const isBacklink = connection.target.asPlain().isEqual(this.target);
const uri = isBacklink ? connection.source : connection.target;
acc.set(uri.toString(), [...(acc.get(uri.toString()) ?? []), item]);
return acc;
}, new Map() as Map<string, ResourceRangeTreeItem[]>);
const resourceItems = [];
for (const [uriString, items] of byResource.entries()) {
const uri = URI.parse(uriString);
const item = uri.isPlaceholder()
? new UriTreeItem(uri, {
collapsibleState: vscode.TreeItemCollapsibleState.Expanded,
})
: new ResourceTreeItem(this.workspace.get(uri), this.workspace, {
collapsibleState: vscode.TreeItemCollapsibleState.Expanded,
});
const children = items.sort((a, b) => {
return (
a.variant.localeCompare(b.variant) || Range.isBefore(a.range, b.range)
);
});
item.getChildren = () => Promise.resolve(children);
item.description = `(${items.length}) ${item.description}`;
// item.iconPath = children.every(c => c.variant === children[0].variant)
// ? children[0].iconPath
// : new vscode.ThemeIcon(
// 'arrow-swap',
// new vscode.ThemeColor('charts.purple')
// );
resourceItems.push(item);
}
const connections = this.graph
.getConnections(uri)
.filter(c => c.target.asPlain().isEqual(uri));
const backlinkItems = connections.map(c =>
ResourceRangeTreeItem.createStandardItem(
this.workspace,
this.workspace.get(c.source),
c.link.range
)
);
return groupRangesByResource(
this.workspace,
backlinkItems,
vscode.TreeItemCollapsibleState.Expanded
);
}
resolveTreeItem(item: BacklinkPanelTreeItem): Promise<BacklinkPanelTreeItem> {
return item.resolveTreeItem();
resourceItems.sort((a, b) => a.label.localeCompare(b.label));
return resourceItems;
}
}

View File

@@ -1,5 +1,4 @@
import * as vscode from 'vscode';
import { FoamFeature } from '../../types';
import { TextDecoder } from 'util';
import { getGraphStyle, getTitleMaxLength } from '../../settings';
import { isSome } from '../../utils';
@@ -7,53 +6,54 @@ import { Foam } from '../../core/model/foam';
import { Logger } from '../../core/utils/log';
import { fromVsCodeUri } from '../../utils/vsc-utils';
const feature: FoamFeature = {
activate: (context: vscode.ExtensionContext, foamPromise: Promise<Foam>) => {
let panel: vscode.WebviewPanel | undefined = undefined;
vscode.workspace.onDidChangeConfiguration(event => {
if (event.affectsConfiguration('foam.graph.style')) {
const style = getGraphStyle();
panel.webview.postMessage({
type: 'didUpdateStyle',
payload: style,
});
}
});
export default async function activate(
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) {
let panel: vscode.WebviewPanel | undefined = undefined;
vscode.workspace.onDidChangeConfiguration(event => {
if (event.affectsConfiguration('foam.graph.style')) {
const style = getGraphStyle();
panel.webview.postMessage({
type: 'didUpdateStyle',
payload: style,
});
}
});
vscode.commands.registerCommand('foam-vscode.show-graph', async () => {
if (panel) {
const columnToShowIn = vscode.window.activeTextEditor
? vscode.window.activeTextEditor.viewColumn
: undefined;
panel.reveal(columnToShowIn);
} else {
const foam = await foamPromise;
panel = await createGraphPanel(foam, context);
const onFoamChanged = _ => {
updateGraph(panel, foam);
};
vscode.commands.registerCommand('foam-vscode.show-graph', async () => {
if (panel) {
const columnToShowIn = vscode.window.activeTextEditor
? vscode.window.activeTextEditor.viewColumn
: undefined;
panel.reveal(columnToShowIn);
} else {
const foam = await foamPromise;
panel = await createGraphPanel(foam, context);
const onFoamChanged = _ => {
updateGraph(panel, foam);
};
const noteUpdatedListener = foam.graph.onDidUpdate(onFoamChanged);
panel.onDidDispose(() => {
noteUpdatedListener.dispose();
panel = undefined;
});
const noteUpdatedListener = foam.graph.onDidUpdate(onFoamChanged);
panel.onDidDispose(() => {
noteUpdatedListener.dispose();
panel = undefined;
});
vscode.window.onDidChangeActiveTextEditor(e => {
if (e?.document?.uri?.scheme === 'file') {
const note = foam.workspace.get(fromVsCodeUri(e.document.uri));
if (isSome(note)) {
panel.webview.postMessage({
type: 'didSelectNote',
payload: note.uri.path,
});
}
vscode.window.onDidChangeActiveTextEditor(e => {
if (e?.document?.uri?.scheme === 'file') {
const note = foam.workspace.get(fromVsCodeUri(e.document.uri));
if (isSome(note)) {
panel.webview.postMessage({
type: 'didSelectNote',
payload: note.uri.path,
});
}
});
}
});
},
};
}
});
}
});
}
function updateGraph(panel: vscode.WebviewPanel, foam: Foam) {
const graph = generateGraphData(foam);
@@ -191,5 +191,3 @@ async function getWebviewContent(
return filled;
}
export default feature;

View File

@@ -3,3 +3,4 @@ export { default as dataviz } from './dataviz';
export { default as orphans } from './orphans';
export { default as placeholders } from './placeholders';
export { default as tags } from './tags-explorer';
export { default as notes } from './notes-explorer';

View File

@@ -0,0 +1,165 @@
import * as vscode from 'vscode';
import { Foam } from '../../core/model/foam';
import { FoamWorkspace } from '../../core/model/workspace';
import {
ResourceRangeTreeItem,
ResourceTreeItem,
createBacklinkItemsForResource as createBacklinkTreeItemsForResource,
} from './utils/tree-view-utils';
import { Resource } from '../../core/model/note';
import { FoamGraph } from '../../core/model/graph';
import { ContextMemento } from '../../utils/vsc-utils';
import {
FolderTreeItem,
FolderTreeProvider,
} from './utils/folder-tree-provider';
export default async function activate(
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) {
const foam = await foamPromise;
const provider = new NotesProvider(
foam.workspace,
foam.graph,
context.globalState
);
provider.refresh();
const treeView = vscode.window.createTreeView<NotesTreeItems>(
'foam-vscode.notes-explorer',
{
treeDataProvider: provider,
showCollapseAll: true,
canSelectMany: true,
}
);
const revealTextEditorItem = async () => {
const target = vscode.window.activeTextEditor?.document.uri;
if (treeView.visible) {
if (target) {
const item = await findTreeItemByUri(provider, target);
// Check if the item is already selected.
// This check is needed because always calling reveal() will
// cause the tree view to take the focus from the item when
// browsing the notes explorer
if (
!treeView.selection.find(
i => i.resourceUri?.path === item.resourceUri.path
)
) {
treeView.reveal(item);
}
}
}
};
context.subscriptions.push(
treeView,
provider,
foam.graph.onDidUpdate(() => {
provider.refresh();
}),
vscode.window.onDidChangeActiveTextEditor(revealTextEditorItem),
treeView.onDidChangeVisibility(revealTextEditorItem)
);
}
export function findTreeItemByUri<I, T>(
provider: FolderTreeProvider<I, T>,
target: vscode.Uri
) {
const path = vscode.workspace.asRelativePath(
target,
vscode.workspace.workspaceFolders.length > 1
);
return provider.findTreeItemByPath(path.split('/'));
}
export type NotesTreeItems =
| ResourceTreeItem
| FolderTreeItem<Resource>
| ResourceRangeTreeItem;
export class NotesProvider extends FolderTreeProvider<
NotesTreeItems,
Resource
> {
public show = new ContextMemento<'all' | 'notes-only'>(
this.state,
`foam-vscode.views.notes-explorer.show`,
'all'
);
constructor(
private workspace: FoamWorkspace,
private graph: FoamGraph,
private state: vscode.Memento
) {
super();
this.disposables.push(
vscode.commands.registerCommand(
`foam-vscode.views.notes-explorer.show:all`,
() => {
this.show.update('all');
this.refresh();
}
),
vscode.commands.registerCommand(
`foam-vscode.views.notes-explorer.show:notes`,
() => {
this.show.update('notes-only');
this.refresh();
}
)
);
}
getValues() {
return this.workspace.list();
}
getFilterFn() {
return this.show.get() === 'notes-only'
? res => res.type !== 'image' && res.type !== 'attachment'
: () => true;
}
valueToPath(value: Resource) {
const path = vscode.workspace.asRelativePath(
value.uri.path,
vscode.workspace.workspaceFolders.length > 1
);
const parts = path.split('/');
return parts;
}
isValueType(value: Resource): value is Resource {
return value.uri != null;
}
createValueTreeItem(
value: Resource,
parent: FolderTreeItem<Resource>
): NotesTreeItems {
const res = new ResourceTreeItem(value, this.workspace, {
parent,
collapsibleState:
this.graph.getBacklinks(value.uri).length > 0
? vscode.TreeItemCollapsibleState.Collapsed
: vscode.TreeItemCollapsibleState.None,
});
res.getChildren = async () => {
const backlinks = await createBacklinkTreeItemsForResource(
this.workspace,
this.graph,
res.uri
);
backlinks.forEach(item => {
item.description = item.label;
item.label = item.resource.title;
});
return backlinks;
};
return res;
}
}

View File

@@ -2,58 +2,70 @@ import * as vscode from 'vscode';
import { Foam } from '../../core/model/foam';
import { createMatcherAndDataStore } from '../../services/editor';
import { getOrphansConfig } from '../../settings';
import { FoamFeature } from '../../types';
import { GroupedResourcesTreeDataProvider } from '../../utils/grouped-resources-tree-data-provider';
import { ResourceTreeItem, UriTreeItem } from '../../utils/tree-view-utils';
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';
const EXCLUDE_TYPES = ['image', 'attachment'];
const feature: FoamFeature = {
activate: async (
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) => {
const foam = await foamPromise;
export default async function activate(
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) {
const foam = await foamPromise;
const { matcher } = await createMatcherAndDataStore(
getOrphansConfig().exclude
);
const provider = new GroupedResourcesTreeDataProvider(
'orphans',
'orphan',
context.globalState,
matcher,
() =>
foam.graph
.getAllNodes()
.filter(
uri =>
!EXCLUDE_TYPES.includes(foam.workspace.find(uri)?.type) &&
foam.graph.getConnections(uri).length === 0
),
uri => {
return uri.isPlaceholder()
? new UriTreeItem(uri)
: new ResourceTreeItem(foam.workspace.find(uri), foam.workspace);
}
);
const { matcher } = await createMatcherAndDataStore(
getOrphansConfig().exclude
);
const provider = new OrphanTreeView(
context.globalState,
foam.workspace,
foam.graph,
matcher
);
const treeView = vscode.window.createTreeView('foam-vscode.orphans', {
treeDataProvider: provider,
showCollapseAll: true,
});
provider.refresh();
const baseTitle = treeView.title;
treeView.title = baseTitle + ` (${provider.numElements})`;
const treeView = vscode.window.createTreeView('foam-vscode.orphans', {
treeDataProvider: provider,
showCollapseAll: true,
});
provider.refresh();
const baseTitle = treeView.title;
treeView.title = baseTitle + ` (${provider.nValues})`;
context.subscriptions.push(
vscode.window.registerTreeDataProvider('foam-vscode.orphans', provider),
provider,
foam.graph.onDidUpdate(() => {
provider.refresh();
treeView.title = baseTitle + ` (${provider.numElements})`;
})
);
},
};
context.subscriptions.push(
vscode.window.registerTreeDataProvider('foam-vscode.orphans', provider),
provider,
treeView,
foam.graph.onDidUpdate(() => {
provider.refresh();
treeView.title = baseTitle + ` (${provider.nValues})`;
})
);
}
export default feature;
export class OrphanTreeView extends GroupedResourcesTreeDataProvider {
constructor(
state: vscode.Memento,
private workspace: FoamWorkspace,
private graph: FoamGraph,
matcher: IMatcher
) {
super('orphans', state, matcher);
}
createValueTreeItem = uri => {
return uri.isPlaceholder()
? new UriTreeItem(uri)
: new ResourceTreeItem(this.workspace.find(uri), this.workspace);
};
getUris = () =>
this.graph
.getAllNodes()
.filter(
uri =>
!EXCLUDE_TYPES.includes(this.workspace.find(uri)?.type) &&
this.graph.getConnections(uri).length === 0
);
}

View File

@@ -2,96 +2,73 @@ import * as vscode from 'vscode';
import { Foam } from '../../core/model/foam';
import { createMatcherAndDataStore } from '../../services/editor';
import { getPlaceholdersConfig } from '../../settings';
import { FoamFeature } from '../../types';
import { GroupedResourcesTreeDataProvider } from '../../utils/grouped-resources-tree-data-provider';
import { GroupedResourcesTreeDataProvider } from './utils/grouped-resources-tree-data-provider';
import {
ResourceRangeTreeItem,
UriTreeItem,
createBacklinkItemsForResource,
groupRangesByResource,
} from '../../utils/tree-view-utils';
} from './utils/tree-view-utils';
import { IMatcher } from '../../core/services/datastore';
import { ContextMemento, fromVsCodeUri } from '../../utils/vsc-utils';
import { FoamGraph } from '../../core/model/graph';
import { URI } from '../../core/model/uri';
import { FoamWorkspace } from '../../core/model/workspace';
import { FolderTreeItem } from './utils/folder-tree-provider';
const feature: FoamFeature = {
activate: async (
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) => {
const foam = await foamPromise;
const { matcher } = await createMatcherAndDataStore(
getPlaceholdersConfig().exclude
);
const provider = new PlaceholderTreeView(
context.globalState,
foam,
matcher
);
export default async function activate(
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) {
const foam = await foamPromise;
const { matcher } = await createMatcherAndDataStore(
getPlaceholdersConfig().exclude
);
const provider = new PlaceholderTreeView(
context.globalState,
foam.workspace,
foam.graph,
matcher
);
const treeView = vscode.window.createTreeView('foam-vscode.placeholders', {
treeDataProvider: provider,
showCollapseAll: true,
});
const baseTitle = treeView.title;
treeView.title = baseTitle + ` (${provider.numElements})`;
provider.refresh();
const treeView = vscode.window.createTreeView('foam-vscode.placeholders', {
treeDataProvider: provider,
showCollapseAll: true,
});
provider.refresh();
const baseTitle = treeView.title;
treeView.title = baseTitle + ` (${provider.nValues})`;
context.subscriptions.push(
treeView,
provider,
foam.graph.onDidUpdate(() => {
context.subscriptions.push(
treeView,
provider,
foam.graph.onDidUpdate(() => {
provider.refresh();
}),
provider.onDidChangeTreeData(() => {
treeView.title = baseTitle + ` (${provider.nValues})`;
}),
vscode.window.onDidChangeActiveTextEditor(() => {
if (provider.show.get() === 'for-current-file') {
provider.refresh();
}),
provider.onDidChangeTreeData(() => {
treeView.title = baseTitle + ` (${provider.numElements})`;
}),
vscode.window.onDidChangeActiveTextEditor(() => {
if (provider.show.get() === 'for-current-file') {
provider.refresh();
}
})
);
},
};
}
})
);
}
export class PlaceholderTreeView extends GroupedResourcesTreeDataProvider {
private graph: FoamGraph;
public show = new ContextMemento<'all' | 'for-current-file'>(
this.state,
`foam-vscode.views.${this.providerId}.show`,
'all'
);
public constructor(state: vscode.Memento, foam: Foam, matcher: IMatcher) {
super(
'placeholders',
'placeholder',
state,
matcher,
() => {
// we override computeResources below (as we can't use "this" here)
throw new Error('Not implemented');
},
uri => {
return new UriTreeItem(uri, {
icon: 'link',
getChildren: async () => {
return groupRangesByResource(
foam.workspace,
foam.graph.getBacklinks(uri).map(link => {
return ResourceRangeTreeItem.createStandardItem(
foam.workspace,
foam.workspace.get(link.source),
link.link.range
);
})
);
},
});
}
);
this.graph = foam.graph;
public constructor(
state: vscode.Memento,
private workspace: FoamWorkspace,
private graph: FoamGraph,
matcher: IMatcher
) {
super('placeholders', state, matcher);
this.disposables.push(
vscode.commands.registerCommand(
`foam-vscode.views.${this.providerId}.show:all`,
@@ -110,7 +87,26 @@ export class PlaceholderTreeView extends GroupedResourcesTreeDataProvider {
);
}
computeResources = (): URI[] => {
createValueTreeItem(uri: URI, parent: FolderTreeItem<URI>): UriTreeItem {
const item = new UriTreeItem(uri, {
parent,
collapsibleState: vscode.TreeItemCollapsibleState.Collapsed,
});
item.getChildren = async () => {
return groupRangesByResource(
this.workspace,
await createBacklinkItemsForResource(
this.workspace,
this.graph,
uri,
'link'
)
);
};
return item;
}
getUris(): URI[] {
if (this.show.get() === 'for-current-file') {
const currentFile = vscode.window.activeTextEditor?.document.uri;
return currentFile
@@ -121,7 +117,5 @@ export class PlaceholderTreeView extends GroupedResourcesTreeDataProvider {
: [];
}
return this.graph.getAllNodes().filter(uri => uri.isPlaceholder());
};
}
}
export default feature;

View File

@@ -3,7 +3,7 @@ import { cleanWorkspace, closeEditors } from '../../test/test-utils-vscode';
import { TagItem, TagsProvider } from './tags-explorer';
import { FoamTags } from '../../core/model/tags';
import { FoamWorkspace } from '../../core/model/workspace';
import { ResourceTreeItem } from '../../utils/tree-view-utils';
import { ResourceTreeItem } from './utils/tree-view-utils';
describe('Tags tree panel', () => {
beforeAll(async () => {

View File

@@ -1,44 +1,36 @@
import { URI } from '../../core/model/uri';
import * as vscode from 'vscode';
import { FoamFeature } from '../../types';
import { getNoteTooltip, isSome } from '../../utils';
import { toVsCodeRange, toVsCodeUri } from '../../utils/vsc-utils';
import { Foam } from '../../core/model/foam';
import { FoamWorkspace } from '../../core/model/workspace';
import { Resource, Tag } from '../../core/model/note';
import { FoamTags } from '../../core/model/tags';
import {
ResourceRangeTreeItem,
ResourceTreeItem,
groupRangesByResource,
} from '../../utils/tree-view-utils';
} from './utils/tree-view-utils';
const TAG_SEPARATOR = '/';
const feature: FoamFeature = {
activate: async (
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) => {
const foam = await foamPromise;
const provider = new TagsProvider(foam.tags, foam.workspace);
const treeView = vscode.window.createTreeView('foam-vscode.tags-explorer', {
treeDataProvider: provider,
showCollapseAll: true,
});
const baseTitle = treeView.title;
treeView.title = baseTitle + ` (${foam.tags.tags.size})`;
export default async function activate(
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) {
const foam = await foamPromise;
const provider = new TagsProvider(foam.tags, foam.workspace);
const treeView = vscode.window.createTreeView('foam-vscode.tags-explorer', {
treeDataProvider: provider,
showCollapseAll: true,
});
const baseTitle = treeView.title;
treeView.title = baseTitle + ` (${foam.tags.tags.size})`;
context.subscriptions.push(
treeView,
foam.tags.onDidUpdate(() => {
provider.refresh();
treeView.title = baseTitle + ` (${foam.tags.tags.size})`;
})
);
},
};
export default feature;
context.subscriptions.push(
treeView,
foam.tags.onDidUpdate(() => {
provider.refresh();
treeView.title = baseTitle + ` (${foam.tags.tags.size})`;
})
);
}
export class TagsProvider implements vscode.TreeDataProvider<TagTreeItem> {
// prettier-ignore
@@ -120,7 +112,8 @@ export class TagsProvider implements vscode.TreeDataProvider<TagTreeItem> {
ResourceRangeTreeItem.createStandardItem(
this.workspace,
note,
t.range
t.range,
'tag'
)
);
return [...acc, ...items];

View File

@@ -0,0 +1,44 @@
import * as vscode from 'vscode';
import { IDisposable } from '../../../core/common/lifecycle';
/**
* This class is a wrapper around vscode.TreeDataProvider that adds a few
* features:
* - It adds a `refresh()` method that can be called to refresh the tree view
* - It adds a `resolveTreeItem()` method that can be used to resolve the
* tree item asynchronously. This is useful when the tree item needs to
* fetch data from the file system or from the network.
* - It adds a `dispose()` method that can be used to dispose of any resources
* that the tree provider might be holding on to.
*/
export abstract class BaseTreeProvider<T>
implements vscode.TreeDataProvider<T>, IDisposable
{
protected disposables: vscode.Disposable[] = [];
// prettier-ignore
private _onDidChangeTreeData: vscode.EventEmitter<T | undefined | void> = new vscode.EventEmitter<T | undefined | void>();
// prettier-ignore
readonly onDidChangeTreeData: vscode.Event<T | undefined | void> = this._onDidChangeTreeData.event;
abstract getChildren(element?: T): vscode.ProviderResult<T[]>;
getTreeItem(element: T) {
return element;
}
async resolveTreeItem(item: T): Promise<T> {
if ((item as any)?.resolveTreeItem) {
return (item as any).resolveTreeItem();
}
return Promise.resolve(item);
}
refresh(): void {
this._onDidChangeTreeData.fire();
}
dispose(): void {
this.disposables.forEach(d => d.dispose());
}
}

View File

@@ -0,0 +1,204 @@
import * as vscode from 'vscode';
import { BaseTreeProvider } from './base-tree-provider';
import { BaseTreeItem, ResourceTreeItem } from './tree-view-utils';
/**
* A folder is a map of basenames to either folders or values (e.g. resources).
*/
export interface Folder<T> {
[basename: string]: Folder<T> | T;
}
/**
* A TreeItem that represents a folder.
*/
export class FolderTreeItem<T> extends vscode.TreeItem {
collapsibleState = vscode.TreeItemCollapsibleState.Collapsed;
contextValue = 'folder';
iconPath = new vscode.ThemeIcon('folder');
constructor(
public parent: Folder<T>,
public name: string,
public parentElement?: FolderTreeItem<T>
) {
super(name, vscode.TreeItemCollapsibleState.Collapsed);
}
}
/**
* An abstract class that can be used to create a tree view from a Folder object.
* Its abstract methods must be implemented by the subclass to define the type of
* the values in the folder, and how to filter them.
*/
export abstract class FolderTreeProvider<I, T> extends BaseTreeProvider<I> {
private root: Folder<T>;
public nValues = 0;
refresh(): void {
const values = this.getValues();
this.nValues = values.length;
this.createTree(values, this.getFilterFn());
super.refresh();
}
getParent(element: I | FolderTreeItem<T>): vscode.ProviderResult<I> {
if (element instanceof ResourceTreeItem) {
return Promise.resolve(element.parent as I);
}
if (element instanceof FolderTreeItem) {
return Promise.resolve(element.parentElement as any);
}
}
createFolderTreeItem(
value: Folder<T>,
name: string,
parent: FolderTreeItem<T>
) {
return new FolderTreeItem<T>(value, name, parent);
}
async getChildren(item?: I): Promise<I[]> {
if (item instanceof BaseTreeItem) {
return item.getChildren() as Promise<I[]>;
}
const parent = (item as any)?.parent ?? this.root;
const children: vscode.TreeItem[] = Object.keys(parent).map(name => {
const value = parent[name];
if (this.isValueType(value)) {
return this.createValueTreeItem(value, undefined);
} else {
return this.createFolderTreeItem(
value,
name,
item as unknown as FolderTreeItem<T>
);
}
});
return children.sort((a, b) => sortFolderTreeItems(a, b)) as any;
}
createTree(values: T[], filterFn: (value: T) => boolean): Folder<T> {
const root: Folder<T> = {};
for (const r of values) {
const parts = this.valueToPath(r);
let currentNode: Folder<T> = root;
parts.forEach((part, index) => {
if (!currentNode[part]) {
if (index < parts.length - 1) {
currentNode[part] = {};
} else {
if (filterFn(r)) {
currentNode[part] = r;
}
}
}
currentNode = currentNode[part] as Folder<T>;
});
}
this.root = root;
return root;
}
getTreeItemsHierarchy(path: string[]): vscode.TreeItem[] {
const treeItemsHierarchy: vscode.TreeItem[] = [];
let currentNode: Folder<T> | T = this.root;
for (const part of path) {
if (currentNode[part] !== undefined) {
currentNode = currentNode[part] as Folder<T> | T;
if (this.isValueType(currentNode as T)) {
treeItemsHierarchy.push(
this.createValueTreeItem(
currentNode as T,
treeItemsHierarchy[
treeItemsHierarchy.length - 1
] as FolderTreeItem<T>
)
);
} else {
treeItemsHierarchy.push(
new FolderTreeItem(
currentNode as Folder<T>,
part,
treeItemsHierarchy[
treeItemsHierarchy.length - 1
] as FolderTreeItem<T>
)
);
}
} else {
// If a part is not found in the tree structure, the given URI is not valid.
return [];
}
}
return treeItemsHierarchy;
}
findTreeItemByPath(path: string[]): Promise<I> {
const hierarchy = this.getTreeItemsHierarchy(path);
return hierarchy.length > 0
? Promise.resolve(hierarchy.pop())
: Promise.resolve(null);
}
/**
* Returns a function that can be used to filter the values.
* The difference between using this function vs not including the values
* is that in this case, the tree will be created with all the folders
* and subfolders, but the values will only be displayed if they pass
* the filter.
* By default it doesn't filter anything.
*/
getFilterFn(): (value: T) => boolean {
return () => true;
}
/**
* Converts a value to a path of strings that can be used to create a tree.
*/
abstract valueToPath(value: T);
/**
* Returns all the values that should be displayed in the tree.
*/
abstract getValues(): T[];
/**
* Returns true if the given value is of the type that should be displayed
* as a leaf in the tree. That is, not as a folder.
*/
abstract isValueType(value: T): value is T;
/**
* Creates a tree item for the given value.
*/
abstract createValueTreeItem(value: T, parent: FolderTreeItem<T>): I;
}
function sortFolderTreeItems(a: vscode.TreeItem, b: vscode.TreeItem): number {
// Both a and b are FolderTreeItem instances
if (a instanceof FolderTreeItem && b instanceof FolderTreeItem) {
return a.label.toString().localeCompare(b.label.toString());
}
// Only a is a FolderTreeItem instance
if (a instanceof FolderTreeItem) {
return -1;
}
// Only b is a FolderTreeItem instance
if (b instanceof FolderTreeItem) {
return 1;
}
return a.label.toString().localeCompare(b.label.toString());
}

View File

@@ -0,0 +1,157 @@
import { FoamWorkspace } from '../../../core/model/workspace';
import {
AlwaysIncludeMatcher,
IMatcher,
SubstringExcludeMatcher,
} from '../../../core/services/datastore';
import { createTestNote } from '../../../test/test-utils';
import { ResourceTreeItem, UriTreeItem } from './tree-view-utils';
import { randomString } from '../../../test/test-utils';
import { MapBasedMemento } from '../../../utils/vsc-utils';
import { URI } from '../../../core/model/uri';
import { TreeItem } from 'vscode';
import { GroupedResourcesTreeDataProvider } from './grouped-resources-tree-data-provider';
const testMatcher = new SubstringExcludeMatcher('path-exclude');
class TestProvider extends GroupedResourcesTreeDataProvider {
constructor(
matcher: IMatcher,
private list: () => URI[],
private create: (uri: URI) => TreeItem
) {
super(randomString(), new MapBasedMemento(), matcher);
}
getUris(): URI[] {
return this.list();
}
createValueTreeItem(value: URI) {
return this.create(value) as any;
}
}
describe('TestProvider', () => {
const note1 = createTestNote({ uri: '/path/ABC.md', title: 'ABC' });
const note2 = createTestNote({
uri: '/path-bis/XYZ.md',
title: 'XYZ',
});
const note3 = createTestNote({
uri: '/path-bis/ABCDEFG.md',
title: 'ABCDEFG',
});
const excludedNote = createTestNote({
uri: '/path-exclude/HIJ.m',
title: 'HIJ',
});
const workspace = new FoamWorkspace()
.set(note1)
.set(note2)
.set(note3)
.set(excludedNote);
it('should return the grouped resources as a folder tree', async () => {
const provider = new TestProvider(
testMatcher,
() => workspace.list().map(r => r.uri),
uri => new UriTreeItem(uri)
);
provider.groupBy.update('folder');
provider.refresh();
const result = await provider.getChildren();
expect(result).toMatchObject([
{
collapsibleState: 1,
label: '/path',
description: '(1)',
},
{
collapsibleState: 1,
label: '/path-bis',
description: '(2)',
},
]);
});
it('should return the grouped resources in a directory', async () => {
const provider = new TestProvider(
testMatcher,
() => workspace.list().map(r => r.uri),
uri => new ResourceTreeItem(workspace.get(uri), workspace)
);
provider.groupBy.update('folder');
provider.refresh();
const paths = await provider.getChildren();
const directory = paths[0];
expect(directory).toMatchObject({
label: '/path',
});
const result = await provider.getChildren(directory);
expect(result).toMatchObject([
{
collapsibleState: 0,
label: 'ABC',
description: '/path/ABC.md',
command: { command: 'vscode.open' },
},
]);
});
it('should return the flattened resources', async () => {
const provider = new TestProvider(
testMatcher,
() => workspace.list().map(r => r.uri),
uri => new ResourceTreeItem(workspace.get(uri), workspace)
);
provider.groupBy.update('off');
provider.refresh();
const result = await provider.getChildren();
expect(result).toMatchObject([
{
collapsibleState: 0,
label: note1.title,
description: '/path/ABC.md',
command: { command: 'vscode.open' },
},
{
collapsibleState: 0,
label: note3.title,
description: '/path-bis/ABCDEFG.md',
command: { command: 'vscode.open' },
},
{
collapsibleState: 0,
label: note2.title,
description: '/path-bis/XYZ.md',
command: { command: 'vscode.open' },
},
]);
});
it('should return the grouped resources without exclusion', async () => {
const provider = new TestProvider(
new AlwaysIncludeMatcher(),
() => workspace.list().map(r => r.uri),
uri => new UriTreeItem(uri)
);
provider.groupBy.update('folder');
provider.refresh();
const result = await provider.getChildren();
expect(result.length).toEqual(3);
expect(result).toMatchObject([
{
collapsibleState: 1,
label: '/path',
description: '(1)',
},
{
collapsibleState: 1,
label: '/path-bis',
description: '(2)',
},
{
collapsibleState: 1,
label: '/path-exclude',
description: '(1)',
},
]);
});
});

View File

@@ -0,0 +1,114 @@
import * as path from 'path';
import * as vscode from 'vscode';
import { URI } from '../../../core/model/uri';
import { IMatcher } from '../../../core/services/datastore';
import { UriTreeItem } from './tree-view-utils';
import { ContextMemento } from '../../../utils/vsc-utils';
import {
FolderTreeItem,
FolderTreeProvider,
Folder,
} from './folder-tree-provider';
type GroupedResourceTreeItem = UriTreeItem | FolderTreeItem<URI>;
/**
* Provides the ability to expose a TreeDataExplorerView in VSCode. This class will
* iterate over each Resource in the FoamWorkspace, call the provided filter predicate, and
* display the Resources.
*
* **NOTE**: In order for this provider to correctly function, you must define the following command in the package.json file:
* ```
* foam-vscode.views.${providerId}.group-by-folder
* foam-vscode.views.${providerId}.group-off
* ```
* Where `providerId` is the same string provided to the constructor.
* @export
* @class GroupedResourcesTreeDataProvider
* @implements {vscode.TreeDataProvider<GroupedResourceTreeItem>}
*/
export abstract class GroupedResourcesTreeDataProvider extends FolderTreeProvider<
GroupedResourceTreeItem,
URI
> {
public groupBy = new ContextMemento<'off' | 'folder'>(
this.state,
`foam-vscode.views.${this.providerId}.group-by`,
'folder'
);
/**
* Creates an instance of GroupedResourcesTreeDataProvider.
* **NOTE**: In order for this provider to correctly function, you must define the following command in the package.json file:
* ```
* foam-vscode.views.${this.providerId}.group-by:folder
* foam-vscode.views.${this.providerId}.group-by:off
* ```
* Where `providerId` is the same string provided to this constructor.
*
* @param {string} providerId A **unique** providerId, this will be used to generate necessary commands within the provider.
* @param {vscode.Memento} state The state to use for persisting the panel settings.
* @param {IMatcher} matcher The matcher to use for filtering the uris.
* @memberof GroupedResourcesTreeDataProvider
*/
constructor(
protected providerId: string,
protected state: vscode.Memento,
private matcher: IMatcher
) {
super();
this.disposables.push(
vscode.commands.registerCommand(
`foam-vscode.views.${this.providerId}.group-by:folder`,
() => {
this.groupBy.update('folder');
this.refresh();
}
),
vscode.commands.registerCommand(
`foam-vscode.views.${this.providerId}.group-by:off`,
() => {
this.groupBy.update('off');
this.refresh();
}
)
);
}
valueToPath(value: URI) {
const p = vscode.workspace.asRelativePath(
value.path,
vscode.workspace.workspaceFolders.length > 1
);
if (this.groupBy.get() === 'folder') {
const { dir, base } = path.parse(p);
return [dir, base];
}
return [p];
}
getValues(): URI[] {
const uris = this.getUris();
return uris.filter(uri => this.matcher.isMatch(uri));
}
isValueType(value: URI): value is URI {
return value instanceof URI;
}
createFolderTreeItem(
value: Folder<URI>,
name: string,
parent: FolderTreeItem<URI>
) {
const item = super.createFolderTreeItem(value, name, parent);
item.label = item.label || '(Not Created)';
item.description = `(${Object.keys(value).length})`;
return item;
}
/**
* Return the URIs before the filtering by the matcher is applied
*/
abstract getUris(): URI[];
}

View File

@@ -0,0 +1,229 @@
import * as vscode from 'vscode';
import { groupBy } from 'lodash';
import { Resource } from '../../../core/model/note';
import { toVsCodeUri } from '../../../utils/vsc-utils';
import { Range } from '../../../core/model/range';
import { URI } from '../../../core/model/uri';
import { FoamWorkspace } from '../../../core/model/workspace';
import { getNoteTooltip } from '../../../utils';
import { isSome } from '../../../core/utils';
import { getBlockFor } from '../../../core/services/markdown-parser';
import { Connection, FoamGraph } from '../../../core/model/graph';
export class BaseTreeItem extends vscode.TreeItem {
resolveTreeItem(): Promise<vscode.TreeItem> {
return Promise.resolve(this);
}
getChildren(): Promise<vscode.TreeItem[]> {
return Promise.resolve([]);
}
}
export class UriTreeItem extends BaseTreeItem {
public parent?: vscode.TreeItem;
constructor(
public readonly uri: URI,
options: {
collapsibleState?: vscode.TreeItemCollapsibleState;
title?: string;
parent?: vscode.TreeItem;
} = {}
) {
super(options?.title ?? uri.getName(), options.collapsibleState);
this.parent = options.parent;
this.description = uri.path.replace(
vscode.workspace.getWorkspaceFolder(toVsCodeUri(uri))?.uri.path,
''
);
this.iconPath = new vscode.ThemeIcon('link');
}
}
export class ResourceTreeItem extends UriTreeItem {
constructor(
public readonly resource: Resource,
private readonly workspace: FoamWorkspace,
options: {
collapsibleState?: vscode.TreeItemCollapsibleState;
parent?: vscode.TreeItem;
} = {}
) {
super(resource.uri, {
title: resource.title,
collapsibleState: options.collapsibleState,
parent: options.parent,
});
this.command = {
command: 'vscode.open',
arguments: [toVsCodeUri(resource.uri)],
title: 'Go to location',
};
this.resourceUri = toVsCodeUri(resource.uri);
this.iconPath = vscode.ThemeIcon.File;
this.contextValue = 'foam.resource';
}
async resolveTreeItem(): Promise<ResourceTreeItem> {
if (this instanceof ResourceTreeItem) {
const content = await this.workspace.readAsMarkdown(this.resource.uri);
this.tooltip = isSome(content)
? getNoteTooltip(content)
: this.resource.title;
}
return this;
}
}
export class ResourceRangeTreeItem extends BaseTreeItem {
public value: any;
constructor(
public label: string,
public variant: string,
public readonly resource: Resource,
public readonly range: Range,
public readonly workspace: FoamWorkspace
) {
super(label, vscode.TreeItemCollapsibleState.None);
this.command = {
command: 'vscode.open',
arguments: [toVsCodeUri(resource.uri), { selection: range }],
title: 'Go to location',
};
}
async resolveTreeItem(): Promise<ResourceRangeTreeItem> {
const markdown =
(await this.workspace.readAsMarkdown(this.resource.uri)) ?? '';
let { block, nLines } = getBlockFor(markdown, this.range.start);
// Long blocks need to be interrupted or they won't display in hover preview
// We keep the extra lines so that the count in the preview is correct
if (nLines > 15) {
let tmp = block.split('\n');
tmp.splice(15, 1, '\n'); // replace a line with a blank line to interrupt the block
block = tmp.join('\n');
}
const tooltip = getNoteTooltip(block ?? this.label ?? '');
this.tooltip = tooltip;
return Promise.resolve(this);
}
static icons = {
backlink: new vscode.ThemeIcon(
'arrow-left',
new vscode.ThemeColor('charts.purple')
),
link: new vscode.ThemeIcon(
'arrow-right',
new vscode.ThemeColor('charts.purple')
),
tag: new vscode.ThemeIcon(
'symbol-number',
new vscode.ThemeColor('charts.purple')
),
};
static async createStandardItem(
workspace: FoamWorkspace,
resource: Resource,
range: Range,
variant: 'backlink' | 'tag' | 'link'
): Promise<ResourceRangeTreeItem> {
const markdown = (await workspace.readAsMarkdown(resource.uri)) ?? '';
const lines = markdown.split('\n');
const line = lines[range.start.line];
const start = Math.max(0, range.start.character - 15);
const ellipsis = start === 0 ? '' : '...';
const label = line
? `${range.start.line + 1}: ${ellipsis}${line.slice(start, start + 300)}`
: Range.toString(range);
const item = new ResourceRangeTreeItem(
label,
variant,
resource,
range,
workspace
);
item.iconPath = ResourceRangeTreeItem.icons[variant];
return item;
}
}
export const groupRangesByResource = async (
workspace: FoamWorkspace,
items:
| ResourceRangeTreeItem[]
| Promise<ResourceRangeTreeItem[]>
| Promise<ResourceRangeTreeItem>[],
collapsibleState = vscode.TreeItemCollapsibleState.Collapsed
) => {
let itemsArray = [] as ResourceRangeTreeItem[];
if (items instanceof Promise) {
itemsArray = await items;
}
if (items instanceof Array && items[0] instanceof Promise) {
itemsArray = await Promise.all(items);
}
if (items instanceof Array && items[0] instanceof ResourceRangeTreeItem) {
itemsArray = items as any;
}
const byResource = groupBy(itemsArray, item => item.resource.uri.path);
const resourceItems = Object.values(byResource).map(items => {
const resourceItem = new ResourceTreeItem(items[0].resource, workspace, {
collapsibleState,
});
const children = items.sort((a, b) => Range.isBefore(a.range, b.range));
resourceItem.getChildren = () => Promise.resolve(children);
resourceItem.description = `(${items.length}) ${resourceItem.description}`;
resourceItem.command = children[0].command;
return resourceItem;
});
resourceItems.sort((a, b) => Resource.sortByTitle(a.resource, b.resource));
return resourceItems;
};
export function createBacklinkItemsForResource(
workspace: FoamWorkspace,
graph: FoamGraph,
uri: URI,
variant: 'backlink' | 'link' = 'backlink'
) {
const connections = graph
.getConnections(uri)
.filter(c => c.target.asPlain().isEqual(uri));
const backlinkItems = connections.map(async c =>
ResourceRangeTreeItem.createStandardItem(
workspace,
workspace.get(c.source),
c.link.range,
variant
)
);
return Promise.all(backlinkItems);
}
export function createConnectionItemsForResource(
workspace: FoamWorkspace,
graph: FoamGraph,
uri: URI,
filter: (c: Connection) => boolean = () => true
) {
const connections = graph.getConnections(uri).filter(c => filter(c));
const backlinkItems = connections.map(async c => {
const item = await ResourceRangeTreeItem.createStandardItem(
workspace,
workspace.get(c.source),
c.link.range,
c.source.asPlain().isEqual(uri) ? 'link' : 'backlink'
);
item.value = c;
return item;
});
return Promise.all(backlinkItems);
}

View File

@@ -1,34 +1,30 @@
/*global markdownit:readonly*/
import * as vscode from 'vscode';
import { FoamFeature } from '../../types';
import { Foam } from '../../core/model/foam';
import { default as markdownItFoamTags } from './tag-highlight';
import { default as markdownItWikilinkNavigation } from './wikilink-navigation';
import { default as markdownItRemoveLinkReferences } from './remove-wikilink-references';
import { default as markdownItWikilinkEmbed } from './wikilink-embed';
const feature: FoamFeature = {
activate: async (
_context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) => {
const foam = await foamPromise;
export default async function activate(
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) {
const foam = await foamPromise;
return {
extendMarkdownIt: (md: markdownit) => {
return [
markdownItWikilinkEmbed,
markdownItFoamTags,
markdownItWikilinkNavigation,
markdownItRemoveLinkReferences,
].reduce(
(acc, extension) =>
extension(acc, foam.workspace, foam.services.parser),
md
);
},
};
},
};
export default feature;
return {
extendMarkdownIt: (md: markdownit) => {
return [
markdownItWikilinkEmbed,
markdownItFoamTags,
markdownItWikilinkNavigation,
markdownItRemoveLinkReferences,
].reduce(
(acc, extension) =>
extension(acc, foam.workspace, foam.services.parser),
md
);
},
};
}

View File

@@ -4,114 +4,108 @@ import { MarkdownLink } from '../core/services/markdown-link';
import { Logger } from '../core/utils/log';
import { isAbsolute } from '../core/utils/path';
import { getFoamVsCodeConfig } from '../services/config';
import { FoamFeature } from '../types';
import { fromVsCodeUri, toVsCodeRange, toVsCodeUri } from '../utils/vsc-utils';
const feature: FoamFeature = {
activate: async (
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) => {
const foam = await foamPromise;
export default async function activate(
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) {
const foam = await foamPromise;
context.subscriptions.push(
vscode.workspace.onWillRenameFiles(async e => {
if (!getFoamVsCodeConfig<boolean>('links.sync.enable')) {
return;
context.subscriptions.push(
vscode.workspace.onWillRenameFiles(async e => {
if (!getFoamVsCodeConfig<boolean>('links.sync.enable')) {
return;
}
const renameEdits = new vscode.WorkspaceEdit();
for (const { oldUri, newUri } of e.files) {
if (
(await vscode.workspace.fs.stat(oldUri)).type ===
vscode.FileType.Directory
) {
vscode.window.showWarningMessage(
'Foam: Updating links on directory rename is not supported.'
);
continue;
}
const renameEdits = new vscode.WorkspaceEdit();
for (const { oldUri, newUri } of e.files) {
if (
(await vscode.workspace.fs.stat(oldUri)).type ===
vscode.FileType.Directory
) {
vscode.window.showWarningMessage(
'Foam: Updating links on directory rename is not supported.'
);
continue;
}
const connections = foam.graph.getBacklinks(fromVsCodeUri(oldUri));
connections.forEach(async connection => {
const { target } = MarkdownLink.analyzeLink(connection.link);
switch (connection.link.type) {
case 'wikilink': {
const identifier = foam.workspace.getIdentifier(
fromVsCodeUri(newUri),
[fromVsCodeUri(oldUri)]
);
const edit = MarkdownLink.createUpdateLinkEdit(
connection.link,
{ target: identifier }
);
renameEdits.replace(
toVsCodeUri(connection.source),
toVsCodeRange(edit.range),
edit.newText
);
break;
}
case 'link': {
const path = isAbsolute(target)
? '/' + vscode.workspace.asRelativePath(newUri)
: fromVsCodeUri(newUri).relativeTo(
connection.source.getDirectory()
).path;
const edit = MarkdownLink.createUpdateLinkEdit(
connection.link,
{ target: path }
);
renameEdits.replace(
toVsCodeUri(connection.source),
toVsCodeRange(edit.range),
edit.newText
);
break;
}
const connections = foam.graph.getBacklinks(fromVsCodeUri(oldUri));
connections.forEach(async connection => {
const { target } = MarkdownLink.analyzeLink(connection.link);
switch (connection.link.type) {
case 'wikilink': {
const identifier = foam.workspace.getIdentifier(
fromVsCodeUri(newUri),
[fromVsCodeUri(oldUri)]
);
const edit = MarkdownLink.createUpdateLinkEdit(connection.link, {
target: identifier,
});
renameEdits.replace(
toVsCodeUri(connection.source),
toVsCodeRange(edit.range),
edit.newText
);
break;
}
});
}
try {
if (renameEdits.size > 0) {
// We break the update by file because applying it at once was causing
// dirty state and editors not always saving or closing
for (const renameEditForUri of renameEdits.entries()) {
const [uri, edits] = renameEditForUri;
const fileEdits = new vscode.WorkspaceEdit();
fileEdits.set(uri, edits);
await vscode.workspace.applyEdit(fileEdits);
const editor = await vscode.workspace.openTextDocument(uri);
// Because the save happens within 50ms of opening the doc, it will be then closed
editor.save();
case 'link': {
const path = isAbsolute(target)
? '/' + vscode.workspace.asRelativePath(newUri)
: fromVsCodeUri(newUri).relativeTo(
connection.source.getDirectory()
).path;
const edit = MarkdownLink.createUpdateLinkEdit(connection.link, {
target: path,
});
renameEdits.replace(
toVsCodeUri(connection.source),
toVsCodeRange(edit.range),
edit.newText
);
break;
}
// Reporting
const nUpdates = renameEdits.entries().reduce((acc, entry) => {
return (acc += entry[1].length);
}, 0);
const links = nUpdates > 1 ? 'links' : 'link';
const nFiles = renameEdits.size;
const files = nFiles > 1 ? 'files' : 'file';
Logger.info(
`Updated links in the following files:`,
...renameEdits
.entries()
.map(e => vscode.workspace.asRelativePath(e[0]))
);
vscode.window.showInformationMessage(
`Updated ${nUpdates} ${links} across ${nFiles} ${files}.`
);
}
} catch (e) {
Logger.error('Error while updating references to file', e);
vscode.window.showErrorMessage(
`Foam couldn't update the links to ${vscode.workspace.asRelativePath(
e.newUri
)}. Check the logs for error details.`
});
}
try {
if (renameEdits.size > 0) {
// We break the update by file because applying it at once was causing
// dirty state and editors not always saving or closing
for (const renameEditForUri of renameEdits.entries()) {
const [uri, edits] = renameEditForUri;
const fileEdits = new vscode.WorkspaceEdit();
fileEdits.set(uri, edits);
await vscode.workspace.applyEdit(fileEdits);
const editor = await vscode.workspace.openTextDocument(uri);
// Because the save happens within 50ms of opening the doc, it will be then closed
editor.save();
}
// Reporting
const nUpdates = renameEdits.entries().reduce((acc, entry) => {
return (acc += entry[1].length);
}, 0);
const links = nUpdates > 1 ? 'links' : 'link';
const nFiles = renameEdits.size;
const files = nFiles > 1 ? 'files' : 'file';
Logger.info(
`Updated links in the following files:`,
...renameEdits
.entries()
.map(e => vscode.workspace.asRelativePath(e[0]))
);
vscode.window.showInformationMessage(
`Updated ${nUpdates} ${links} across ${nFiles} ${files}.`
);
}
})
);
},
};
export default feature;
} catch (e) {
Logger.error('Error while updating references to file', e);
vscode.window.showErrorMessage(
`Foam couldn't update the links to ${vscode.workspace.asRelativePath(
e.newUri
)}. Check the logs for error details.`
);
}
})
);
}

View File

@@ -213,4 +213,154 @@ more text
expect(tags).toBeNull();
});
});
describe('works inside front-matter #1184', () => {
it('should provide suggestions when on `tags:` in the front-matter', async () => {
const { uri } = await createFile(`---
created: 2023-01-01
tags: prim`);
const { doc } = await showInEditor(uri);
const provider = new TagCompletionProvider(foamTags);
const tags = await provider.provideCompletionItems(
doc,
new vscode.Position(2, 10)
);
expect(foamTags.tags.get('primary')).toBeTruthy();
expect(tags.items.length).toEqual(3);
});
it('should provide suggestions when on `tags:` in the front-matter with leading `[`', async () => {
const { uri } = await createFile('---\ntags: [');
const { doc } = await showInEditor(uri);
const provider = new TagCompletionProvider(foamTags);
const tags = await provider.provideCompletionItems(
doc,
new vscode.Position(1, 7)
);
expect(foamTags.tags.get('primary')).toBeTruthy();
expect(tags.items.length).toEqual(3);
});
it('should provide suggestions when on `tags:` in the front-matter with `#`', async () => {
const { uri } = await createFile('---\ntags: #');
const { doc } = await showInEditor(uri);
const provider = new TagCompletionProvider(foamTags);
const tags = await provider.provideCompletionItems(
doc,
new vscode.Position(1, 7)
);
expect(foamTags.tags.get('primary')).toBeTruthy();
expect(tags.items.length).toEqual(3);
});
it('should provide suggestions when on `tags:` in the front-matter when tags are comma separated', async () => {
const { uri } = await createFile(
'---\ncreated: 2023-01-01\ntags: secondary, prim'
);
const { doc } = await showInEditor(uri);
const provider = new TagCompletionProvider(foamTags);
const tags = await provider.provideCompletionItems(
doc,
new vscode.Position(2, 21)
);
expect(foamTags.tags.get('primary')).toBeTruthy();
expect(tags.items.length).toEqual(3);
});
it('should provide suggestions when on `tags:` in the front-matter in middle of comma separated', async () => {
const { uri } = await createFile(
'---\ncreated: 2023-01-01\ntags: second, prim'
);
const { doc } = await showInEditor(uri);
const provider = new TagCompletionProvider(foamTags);
const tags = await provider.provideCompletionItems(
doc,
new vscode.Position(2, 12)
);
expect(foamTags.tags.get('secondary')).toBeTruthy();
expect(tags.items.length).toEqual(3);
});
it('should provide suggestions in `tags:` on separate line with leading space', async () => {
const { uri } = await createFile('---\ntags: second, prim\n ');
const { doc } = await showInEditor(uri);
const provider = new TagCompletionProvider(foamTags);
const tags = await provider.provideCompletionItems(
doc,
new vscode.Position(2, 1)
);
expect(foamTags.tags.get('secondary')).toBeTruthy();
expect(tags.items.length).toEqual(3);
});
it('should provide suggestions in `tags:` on separate line with leading ` - `', async () => {
const { uri } = await createFile('---\ntags:\n - ');
const { doc } = await showInEditor(uri);
const provider = new TagCompletionProvider(foamTags);
const tags = await provider.provideCompletionItems(
doc,
new vscode.Position(2, 3)
);
expect(foamTags.tags.get('secondary')).toBeTruthy();
expect(tags.items.length).toEqual(3);
});
it('should not provide suggestions when on non-`tags:` in the front-matter', async () => {
const { uri } = await createFile('---\ntags: prim\ntitle: prim');
const { doc } = await showInEditor(uri);
const provider = new TagCompletionProvider(foamTags);
const tags = await provider.provideCompletionItems(
doc,
new vscode.Position(2, 11)
);
expect(foamTags.tags.get('primary')).toBeTruthy();
expect(tags).toBeNull();
});
it('should not provide suggestions when outside the front-matter without `#` key', async () => {
const { uri } = await createFile(
'---\ncreated: 2023-01-01\ntags: prim\n---\ncontent\ntags: prim'
);
const { doc } = await showInEditor(uri);
const provider = new TagCompletionProvider(foamTags);
const tags = await provider.provideCompletionItems(
doc,
new vscode.Position(5, 10)
);
expect(foamTags.tags.get('primary')).toBeTruthy();
expect(tags).toBeNull();
});
it('should not provide suggestions in `tags:` on separate line with leading ` -`', async () => {
const { uri } = await createFile('---\ntags:\n -');
const { doc } = await showInEditor(uri);
const provider = new TagCompletionProvider(foamTags);
const tags = await provider.provideCompletionItems(
doc,
new vscode.Position(2, 2)
);
expect(foamTags.tags.get('secondary')).toBeTruthy();
expect(tags).toBeNull();
});
});
});

View File

@@ -1,29 +1,27 @@
import * as vscode from 'vscode';
import { Foam } from '../core/model/foam';
import { FoamTags } from '../core/model/tags';
import { FoamFeature } from '../types';
import { mdDocSelector } from '../utils';
import { isInFrontMatter, isOnYAMLKeywordLine, mdDocSelector } from '../utils';
// this regex is different from HASHTAG_REGEX in that it does not look for a
// #+character. It uses a negative look-ahead for `# `
const TAG_REGEX =
const HASH_REGEX =
/(?<=^|\s)#(?![ \t#])([0-9]*[\p{L}\p{Emoji_Presentation}\p{N}/_-]*)/dgu;
const MAX_LINES_FOR_FRONT_MATTER = 50;
const feature: FoamFeature = {
activate: async (
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) => {
const foam = await foamPromise;
context.subscriptions.push(
vscode.languages.registerCompletionItemProvider(
mdDocSelector,
new TagCompletionProvider(foam.tags),
'#'
)
);
},
};
export default async function activate(
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) {
const foam = await foamPromise;
context.subscriptions.push(
vscode.languages.registerCompletionItemProvider(
mdDocSelector,
new TagCompletionProvider(foam.tags),
'#'
)
);
}
export class TagCompletionProvider
implements vscode.CompletionItemProvider<vscode.CompletionItem>
@@ -38,23 +36,96 @@ export class TagCompletionProvider
.lineAt(position)
.text.substr(0, position.character);
const requiresAutocomplete = cursorPrefix.match(TAG_REGEX);
if (!requiresAutocomplete) {
const beginningOfFileText = document.getText(
new vscode.Range(
new vscode.Position(0, 0),
new vscode.Position(
position.line < MAX_LINES_FOR_FRONT_MATTER
? position.line
: MAX_LINES_FOR_FRONT_MATTER,
position.character
)
)
);
const isHashMatch = cursorPrefix.match(HASH_REGEX) !== null;
const inFrontMatter = isInFrontMatter(beginningOfFileText, position.line);
if (!isHashMatch && !inFrontMatter) {
return null;
}
// check the match group length.
// find the last match group, and ensure the end of that group is
// at the cursor position.
// This excludes both `#%` and also `here is #my-app1 and now # ` with
// trailing space
const matches = Array.from(cursorPrefix.matchAll(TAG_REGEX));
const lastMatch = matches[matches.length - 1];
const lastMatchEndIndex = lastMatch[0].length + lastMatch.index;
return inFrontMatter
? this.createTagsForFrontMatter(beginningOfFileText, position)
: this.createTagsForContent(cursorPrefix, position);
}
private createTagsForFrontMatter(
content: string,
position: vscode.Position
): vscode.ProviderResult<vscode.CompletionList<vscode.CompletionItem>> {
const FRONT_MATTER_PREVIOUS_CHARACTER = /[#[\s\w]/g;
const lines = content.split('\n');
if (position.line >= lines.length) {
return null;
}
const cursorPrefix = lines[position.line].substring(0, position.character);
const isTagsMatch =
isOnYAMLKeywordLine(content, 'tags') &&
cursorPrefix
.charAt(position.character - 1)
.match(FRONT_MATTER_PREVIOUS_CHARACTER);
if (!isTagsMatch) {
return null;
}
const [lastMatchStartIndex, lastMatchEndIndex] = this.tagMatchIndices(
cursorPrefix,
HASH_REGEX
);
const isHashMatch = cursorPrefix.match(HASH_REGEX) !== null;
if (isHashMatch && lastMatchEndIndex !== position.character) {
return null;
}
const completionTags = this.createCompletionTagItems();
// We are in the front matter and we typed #, remove the `#`
if (isHashMatch) {
completionTags.forEach(item => {
item.additionalTextEdits = [
vscode.TextEdit.delete(
new vscode.Range(
position.line,
lastMatchStartIndex,
position.line,
lastMatchStartIndex + 1
)
),
];
});
}
return new vscode.CompletionList(completionTags);
}
private createTagsForContent(
content: string,
position: vscode.Position
): vscode.ProviderResult<vscode.CompletionList<vscode.CompletionItem>> {
const [, lastMatchEndIndex] = this.tagMatchIndices(content, HASH_REGEX);
if (lastMatchEndIndex !== position.character) {
return null;
}
return new vscode.CompletionList(this.createCompletionTagItems());
}
private createCompletionTagItems(): vscode.CompletionItem[] {
const completionTags = [];
[...this.foamTags.tags].forEach(([tag]) => {
const item = new vscode.CompletionItem(
@@ -67,9 +138,24 @@ export class TagCompletionProvider
completionTags.push(item);
});
return completionTags;
}
return new vscode.CompletionList(completionTags);
private tagMatchIndices(content: string, match: RegExp): number[] {
// check the match group length.
// find the last match group, and ensure the end of that group is
// at the cursor position.
// This excludes both `#%` and also `here is #my-app1 and now # ` with
// trailing space
const matches = Array.from(content.matchAll(match));
if (matches.length === 0) {
return [-1, -1];
}
const lastMatch = matches[matches.length - 1];
const lastMatchStartIndex = lastMatch.index;
const lastMatchEndIndex = lastMatch[0].length + lastMatchStartIndex;
return [lastMatchStartIndex, lastMatchEndIndex];
}
}
export default feature;

View File

@@ -5,7 +5,6 @@ import { Resource, ResourceParser } from '../core/model/note';
import { Range } from '../core/model/range';
import { FoamWorkspace } from '../core/model/workspace';
import { MarkdownLink } from '../core/services/markdown-link';
import { FoamFeature } from '../types';
import { isNone } from '../utils';
import {
fromVsCodeUri,
@@ -28,7 +27,7 @@ interface FindIdentifierCommandArgs {
amongst: vscode.Uri[];
}
const FIND_IDENTIFER_COMMAND: FoamCommand<FindIdentifierCommandArgs> = {
const FIND_IDENTIFIER_COMMAND: FoamCommand<FindIdentifierCommandArgs> = {
name: 'foam:compute-identifier',
execute: async ({ target, amongst, range }) => {
if (vscode.window.activeTextEditor) {
@@ -62,59 +61,57 @@ const REPLACE_TEXT_COMMAND: FoamCommand<ReplaceTextCommandArgs> = {
},
};
const feature: FoamFeature = {
activate: async (
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) => {
const collection = vscode.languages.createDiagnosticCollection('foam');
const debouncedUpdateDiagnostics = debounce(updateDiagnostics, 500);
const foam = await foamPromise;
if (vscode.window.activeTextEditor) {
updateDiagnostics(
foam.workspace,
foam.services.parser,
vscode.window.activeTextEditor.document,
collection
);
}
context.subscriptions.push(
vscode.window.onDidChangeActiveTextEditor(editor => {
if (editor) {
updateDiagnostics(
foam.workspace,
foam.services.parser,
editor.document,
collection
);
}
}),
vscode.workspace.onDidChangeTextDocument(event => {
debouncedUpdateDiagnostics(
export default async function activate(
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) {
const collection = vscode.languages.createDiagnosticCollection('foam');
const debouncedUpdateDiagnostics = debounce(updateDiagnostics, 500);
const foam = await foamPromise;
if (vscode.window.activeTextEditor) {
updateDiagnostics(
foam.workspace,
foam.services.parser,
vscode.window.activeTextEditor.document,
collection
);
}
context.subscriptions.push(
vscode.window.onDidChangeActiveTextEditor(editor => {
if (editor) {
updateDiagnostics(
foam.workspace,
foam.services.parser,
event.document,
editor.document,
collection
);
}),
vscode.languages.registerCodeActionsProvider(
'markdown',
new IdentifierResolver(),
{
providedCodeActionKinds: IdentifierResolver.providedCodeActionKinds,
}
),
vscode.commands.registerCommand(
FIND_IDENTIFER_COMMAND.name,
FIND_IDENTIFER_COMMAND.execute
),
vscode.commands.registerCommand(
REPLACE_TEXT_COMMAND.name,
REPLACE_TEXT_COMMAND.execute
)
);
},
};
}
}),
vscode.workspace.onDidChangeTextDocument(event => {
debouncedUpdateDiagnostics(
foam.workspace,
foam.services.parser,
event.document,
collection
);
}),
vscode.languages.registerCodeActionsProvider(
'markdown',
new IdentifierResolver(),
{
providedCodeActionKinds: IdentifierResolver.providedCodeActionKinds,
}
),
vscode.commands.registerCommand(
FIND_IDENTIFIER_COMMAND.name,
FIND_IDENTIFIER_COMMAND.execute
),
vscode.commands.registerCommand(
REPLACE_TEXT_COMMAND.name,
REPLACE_TEXT_COMMAND.execute
)
);
}
export function updateDiagnostics(
workspace: FoamWorkspace,
@@ -267,7 +264,7 @@ const createFindIdentifierCommand = (
vscode.CodeActionKind.QuickFix
);
action.command = {
command: FIND_IDENTIFER_COMMAND.name,
command: FIND_IDENTIFIER_COMMAND.name,
title: 'Link to this resource',
arguments: [
{
@@ -285,5 +282,3 @@ const createFindIdentifierCommand = (
action.diagnostics = [diagnostic];
return action;
};
export default feature;

View File

@@ -2,6 +2,7 @@ import { isEmpty } from 'lodash';
import { asAbsoluteUri, URI } from '../core/model/uri';
import { TextEncoder } from 'util';
import {
EndOfLine,
FileType,
RelativePattern,
Selection,
@@ -74,6 +75,15 @@ export async function replaceSelection(
await workspace.applyEdit(originatingFileEdit);
}
/**
* Returns the EOL character for the currently open editor.
*/
export function getEditorEOL(): string {
return window.activeTextEditor.document.eol === EndOfLine.CRLF
? '\r\n'
: '\n';
}
/**
* Returns the directory of the file currently open in the editor.
* If no file is open in the editor it will return the first folder

View File

@@ -24,7 +24,6 @@ import {
} from './editor';
import { Resolver } from './variable-resolver';
import dateFormat from 'dateformat';
import { isSome } from '../core/utils';
import { getFoamVsCodeConfig } from './config';
/**

View File

@@ -1,19 +1,13 @@
import { workspace, GlobPattern } from 'vscode';
import { LogLevel } from './core/utils/log';
export enum LinkReferenceDefinitionsSetting {
withExtensions = 'withExtensions',
withoutExtensions = 'withoutExtensions',
off = 'off',
}
export function getWikilinkDefinitionSetting(): LinkReferenceDefinitionsSetting {
export function getWikilinkDefinitionSetting():
| 'withExtensions'
| 'withoutExtensions'
| 'off' {
return workspace
.getConfiguration('foam.edit')
.get<LinkReferenceDefinitionsSetting>(
'linkReferenceDefinitions',
LinkReferenceDefinitionsSetting.withoutExtensions
);
.get('linkReferenceDefinitions', 'withoutExtensions');
}
/** Retrieve the list of file ignoring globs. */

View File

@@ -1,9 +1,7 @@
import { ExtensionContext } from 'vscode';
import { Foam } from './core/model/foam';
export interface FoamFeature {
activate: (
context: ExtensionContext,
foamPromise: Promise<Foam>
) => Promise<any> | void;
}
export type FoamFeature = (
context: ExtensionContext,
foamPromise: Promise<Foam>
) => Promise<any> | void;

View File

@@ -1,4 +1,9 @@
import { removeBrackets, toTitleCase } from './utils';
import {
isInFrontMatter,
isOnYAMLKeywordLine,
removeBrackets,
toTitleCase,
} from './utils';
describe('removeBrackets', () => {
it('removes the brackets', () => {
@@ -57,3 +62,66 @@ describe('toTitleCase', () => {
expect(actual).toEqual(expected);
});
});
describe('isInFrontMatter', () => {
it('is true for started front matter', () => {
const content = `---
`;
const actual = isInFrontMatter(content, 1);
expect(actual).toBeTruthy();
});
it('is true for inside completed front matter', () => {
const content = '---\ntitle: A title\n---\n';
const actual = isInFrontMatter(content, 1);
expect(actual).toBeTruthy();
});
it('is true for inside completed front matter with "..." end delimiter', () => {
const content = '---\ntitle: A title\n...\n';
const actual = isInFrontMatter(content, 1);
expect(actual).toBeTruthy();
});
it('is false for outside completed front matter', () => {
const content = '---\ntitle: A title\n---\ncontent\nmore content\n';
const actual = isInFrontMatter(content, 3);
expect(actual).toBeFalsy();
});
it('is false for outside completed front matter with "..." end delimiter', () => {
const content = '---\ntitle: A title\n...\ncontent\nmore content\n';
const actual = isInFrontMatter(content, 3);
expect(actual).toBeFalsy();
});
it('is false for position on initial front matter delimiter', () => {
const content = '---\ntitle: A title\n---\ncontent\nmore content\n';
const actual = isInFrontMatter(content, 0);
expect(actual).toBeFalsy();
});
it('is false for position on final front matter delimiter', () => {
const content = '---\ntitle: A title\n---\ncontent\nmore content\n';
const actual = isInFrontMatter(content, 2);
expect(actual).toBeFalsy();
});
describe('isOnYAMLKeywordLine', () => {
it('is true if line starts with keyword', () => {
const content = 'tags: foo, bar\n';
const actual = isOnYAMLKeywordLine(content, 'tags');
expect(actual).toBeTruthy();
});
it('is true if previous line starts with keyword', () => {
const content = 'tags: foo\n - bar\n';
const actual = isOnYAMLKeywordLine(content, 'tags');
expect(actual).toBeTruthy();
});
it('is false if line starts with wrong keyword', () => {
const content = 'tags: foo, bar\n';
const actual = isOnYAMLKeywordLine(content, 'title');
expect(actual).toBeFalsy();
});
it('is false if previous line starts with wrong keyword', () => {
const content = 'dates:\n - 2023-01-1\n - 2023-01-02\n';
const actual = isOnYAMLKeywordLine(content, 'tags');
expect(actual).toBeFalsy();
});
});
});

View File

@@ -1,5 +1,4 @@
import {
EndOfLine,
Range,
TextDocument,
window,
@@ -12,35 +11,14 @@ import {
} from 'vscode';
import matter from 'gray-matter';
import { toVsCodeUri } from './utils/vsc-utils';
import { Logger } from './core/utils/log';
import { URI } from './core/model/uri';
export const docConfig = { tab: ' ', eol: '\r\n' };
import { getEditorEOL } from './services/editor';
export const mdDocSelector = [
{ language: 'markdown', scheme: 'file' },
{ language: 'markdown', scheme: 'untitled' },
];
export function loadDocConfig() {
// Load workspace config
const activeEditor = window.activeTextEditor;
if (!activeEditor) {
Logger.debug('Failed to load config, no active editor');
return;
}
docConfig.eol = activeEditor.document.eol === EndOfLine.CRLF ? '\r\n' : '\n';
const tabSize = Number(activeEditor.options.tabSize);
const insertSpaces = activeEditor.options.insertSpaces;
if (insertSpaces) {
docConfig.tab = ' '.repeat(tabSize);
} else {
docConfig.tab = '\t';
}
}
export function isMdEditor(editor: TextEditor) {
return editor && editor.document && editor.document.languageId === 'markdown';
}
@@ -50,7 +28,7 @@ export function detectGeneratedCode(
header: string,
footer: string
): { range: Range | null; lines: string[] } {
const lines = fullText.split(docConfig.eol);
const lines = fullText.split(getEditorEOL());
const headerLine = lines.findIndex(line => line === header);
const footerLine = lines.findIndex(line => line === footer);
@@ -221,3 +199,37 @@ export function stripImages(markdown: string): string {
'$1'.length ? '[Image: $1]' : ''
);
}
export function isInFrontMatter(content: string, lineNumber: number): Boolean {
const FIRST_DELIMITER_MATCH = /^---\s*?$/gm;
const LAST_DELIMITER_MATCH = /^[-.]{3}\s*?$/g;
// if we're on the first line, we're not _yet_ in the front matter
if (lineNumber === 0) {
return false;
}
// look for --- at start, and a second --- or ... to end
if (content.match(FIRST_DELIMITER_MATCH) === null) {
return false;
}
const lines = content.split('\n');
lines.shift();
const endLineMatches = (l: string) => l.match(LAST_DELIMITER_MATCH);
const endLineNumber = lines.findIndex(endLineMatches);
return endLineNumber === -1 || endLineNumber >= lineNumber;
}
export function isOnYAMLKeywordLine(content: string, keyword: string): Boolean {
const keywordMatch = /^\s*(\w+):/gm;
if (content.match(keywordMatch) === null) {
return false;
}
const matches = Array.from(content.matchAll(keywordMatch));
const lastMatch = matches[matches.length - 1];
return lastMatch[1] === keyword;
}

View File

@@ -1,196 +0,0 @@
import { FoamWorkspace } from '../core/model/workspace';
import {
AlwaysIncludeMatcher,
SubstringExcludeMatcher,
} from '../core/services/datastore';
import { createTestNote } from '../test/test-utils';
import {
DirectoryTreeItem,
GroupedResourcesTreeDataProvider,
} from './grouped-resources-tree-data-provider';
import { ResourceTreeItem, UriTreeItem } from './tree-view-utils';
import { randomString } from '../test/test-utils';
import { MapBasedMemento } from './vsc-utils';
const testMatcher = new SubstringExcludeMatcher('path-exclude');
describe('GroupedResourcesTreeDataProvider', () => {
const matchingNote1 = createTestNote({ uri: '/path/ABC.md', title: 'ABC' });
const matchingNote2 = createTestNote({
uri: '/path-bis/XYZ.md',
title: 'XYZ',
});
const excludedPathNote = createTestNote({
uri: '/path-exclude/HIJ.m',
title: 'HIJ',
});
const notMatchingNote = createTestNote({
uri: '/path-bis/ABCDEFG.md',
title: 'ABCDEFG',
});
const workspace = new FoamWorkspace()
.set(matchingNote1)
.set(matchingNote2)
.set(excludedPathNote)
.set(notMatchingNote);
it('should return the grouped resources as a folder tree', async () => {
const provider = new GroupedResourcesTreeDataProvider(
randomString(),
'note',
new MapBasedMemento(),
testMatcher,
() =>
workspace
.list()
.filter(r => r.title.length === 3)
.map(r => r.uri),
uri => new UriTreeItem(uri)
);
provider.groupBy.update('folder');
provider.refresh();
const result = await provider.getChildren();
expect(result).toMatchObject([
{
collapsibleState: 1,
label: '/path',
description: '1 note',
children: [new UriTreeItem(matchingNote1.uri)],
},
{
collapsibleState: 1,
label: '/path-bis',
description: '1 note',
children: [new UriTreeItem(matchingNote2.uri)],
},
]);
});
it('should return the grouped resources in a directory', async () => {
const provider = new GroupedResourcesTreeDataProvider(
randomString(),
'note',
new MapBasedMemento(),
testMatcher,
() =>
workspace
.list()
.filter(r => r.title.length === 3)
.map(r => r.uri),
uri => new ResourceTreeItem(workspace.get(uri), workspace)
);
provider.groupBy.update('folder');
provider.refresh();
const directory = new DirectoryTreeItem(
'/path',
[new ResourceTreeItem(matchingNote1, workspace)],
'note'
);
const result = await provider.getChildren(directory);
expect(result).toMatchObject([
{
collapsibleState: 0,
label: 'ABC',
description: '/path/ABC.md',
command: { command: 'vscode.open' },
},
]);
});
it('should return the flattened resources', async () => {
const provider = new GroupedResourcesTreeDataProvider(
randomString(),
'note',
new MapBasedMemento(),
testMatcher,
() =>
workspace
.list()
.filter(r => r.title.length === 3)
.map(r => r.uri),
uri => new ResourceTreeItem(workspace.get(uri), workspace)
);
provider.groupBy.update('off');
provider.refresh();
const result = await provider.getChildren();
expect(result).toMatchObject([
{
collapsibleState: 0,
label: matchingNote1.title,
description: '/path/ABC.md',
command: { command: 'vscode.open' },
},
{
collapsibleState: 0,
label: matchingNote2.title,
description: '/path-bis/XYZ.md',
command: { command: 'vscode.open' },
},
]);
});
it('should return the grouped resources without exclusion', async () => {
const provider = new GroupedResourcesTreeDataProvider(
randomString(),
'note',
new MapBasedMemento(),
new AlwaysIncludeMatcher(),
() =>
workspace
.list()
.filter(r => r.title.length === 3)
.map(r => r.uri),
uri => new UriTreeItem(uri)
);
provider.groupBy.update('folder');
provider.refresh();
const result = await provider.getChildren();
expect(result).toMatchObject([
expect.anything(),
expect.anything(),
{
collapsibleState: 1,
label: '/path-exclude',
description: '1 note',
children: [new UriTreeItem(excludedPathNote.uri)],
},
]);
});
it('should dynamically set the description', async () => {
const description = 'test description';
const provider = new GroupedResourcesTreeDataProvider(
randomString(),
description,
new MapBasedMemento(),
testMatcher,
() =>
workspace
.list()
.filter(r => r.title.length === 3)
.map(r => r.uri),
uri => new UriTreeItem(uri)
);
provider.groupBy.update('folder');
provider.refresh();
const result = await provider.getChildren();
expect(result).toMatchObject([
{
collapsibleState: 1,
label: '/path',
description: `1 ${description}`,
children: expect.anything(),
},
{
collapsibleState: 1,
label: '/path-bis',
description: `1 ${description}`,
children: expect.anything(),
},
]);
});
});

View File

@@ -1,214 +0,0 @@
import * as path from 'path';
import * as vscode from 'vscode';
import { getContainsTooltip, isSome } from '../utils';
import { URI } from '../core/model/uri';
import { IMatcher } from '../core/services/datastore';
import { UriTreeItem } from './tree-view-utils';
import { ContextMemento } from './vsc-utils';
/**
* Provides the ability to expose a TreeDataExplorerView in VSCode. This class will
* iterate over each Resource in the FoamWorkspace, call the provided filter predicate, and
* display the Resources.
*
* **NOTE**: In order for this provider to correctly function, you must define the following command in the package.json file:
* ```
* foam-vscode.views.${providerId}.group-by-folder
* foam-vscode.views.${providerId}.group-off
* ```
* Where `providerId` is the same string provided to the constructor. You must also register the commands in your context subscriptions as follows:
* ```
* const provider = new GroupedResourcesTreeDataProvider(
...
);
context.subscriptions.push(
vscode.window.registerTreeDataProvider(
'foam-vscode.placeholders',
provider
),
...provider.commands,
);
```
* @export
* @class GroupedResourcesTreeDataProvider
* @implements {vscode.TreeDataProvider<GroupedResourceTreeItem>}
*/
export class GroupedResourcesTreeDataProvider
implements
vscode.TreeDataProvider<GroupedResourceTreeItem>,
vscode.Disposable
{
// prettier-ignore
private _onDidChangeTreeData: vscode.EventEmitter<GroupedResourceTreeItem | undefined | void> = new vscode.EventEmitter<GroupedResourceTreeItem | undefined | void>();
// prettier-ignore
readonly onDidChangeTreeData: vscode.Event<GroupedResourceTreeItem | undefined | void> = this._onDidChangeTreeData.event;
private flatUris: Array<URI> = [];
private root = vscode.workspace.workspaceFolders[0].uri.path;
public groupBy = new ContextMemento<'off' | 'folder'>(
this.state,
`foam-vscode.views.${this.providerId}.group-by`,
'folder'
);
protected disposables: vscode.Disposable[] = [];
/**
* Creates an instance of GroupedResourcesTreeDataProvider.
* **NOTE**: In order for this provider to correctly function, you must define the following command in the package.json file:
* ```
* foam-vscode.views.${this.providerId}.group-by-folder
* foam-vscode.views.${this.providerId}.group-by-off
* ```
* Where `providerId` is the same string provided to this constructor. You must also register the commands in your context subscriptions as follows:
* ```
* const provider = new GroupedResourcesTreeDataProvider(
...
);
context.subscriptions.push(
vscode.window.registerTreeDataProvider(
'foam-vscode.placeholders',
provider
),
...provider.commands,
);
```
* @param {string} providerId A **unique** providerId, this will be used to generate necessary commands within the provider.
* @param {string} resourceName A display name used in the explorer view
* @param {() => Array<URI>} computeResources
* @param {(item: URI) => GroupedResourceTreeItem} createTreeItem
* @param {GroupedResourcesConfig} config
* @param {URI[]} workspaceUris The workspace URIs
* @memberof GroupedResourcesTreeDataProvider
*/
constructor(
protected providerId: string,
private resourceName: string,
protected state: vscode.Memento,
private matcher: IMatcher,
protected computeResources: () => Array<URI>,
private createTreeItem: (item: URI) => GroupedResourceTreeItem
) {
this.disposables.push(
vscode.commands.registerCommand(
`foam-vscode.views.${this.providerId}.group-by:folder`,
() => {
this.groupBy.update('folder');
this.refresh();
}
),
vscode.commands.registerCommand(
`foam-vscode.views.${this.providerId}.group-by:off`,
() => {
this.groupBy.update('off');
this.refresh();
}
)
);
}
dispose() {
this.disposables.forEach(d => d.dispose());
}
public get numElements() {
return this.flatUris.length;
}
refresh(): void {
this.doComputeResources();
this._onDidChangeTreeData.fire();
}
getTreeItem(item: GroupedResourceTreeItem): vscode.TreeItem {
return item;
}
async getChildren(
item?: GroupedResourceTreeItem
): Promise<GroupedResourceTreeItem[]> {
if ((item as any)?.getChildren) {
return (item as any).getChildren();
}
if (this.groupBy.get() === 'folder') {
const directories = Object.entries(this.getUrisByDirectory())
.sort(([dir1], [dir2]) => sortByString(dir1, dir2))
.map(
([dir, children]) =>
new DirectoryTreeItem(
dir,
children.map(this.createTreeItem),
this.resourceName
)
);
return Promise.resolve(directories);
}
const items = this.flatUris
.map(uri => this.createTreeItem(uri))
.sort(sortByTreeItemLabel);
return Promise.resolve(items);
}
resolveTreeItem(
item: GroupedResourceTreeItem
): Promise<GroupedResourceTreeItem> {
return item.resolveTreeItem();
}
private doComputeResources(): void {
this.flatUris = this.computeResources()
.filter(uri => this.matcher.isMatch(uri))
.filter(isSome);
}
private getUrisByDirectory(): UrisByDirectory {
const resourcesByDirectory: UrisByDirectory = {};
for (const uri of this.flatUris) {
const p = uri.path.replace(this.root, '');
const { dir } = path.parse(p);
if (resourcesByDirectory[dir]) {
resourcesByDirectory[dir].push(uri);
} else {
resourcesByDirectory[dir] = [uri];
}
}
return resourcesByDirectory;
}
}
type UrisByDirectory = { [key: string]: Array<URI> };
type GroupedResourceTreeItem = UriTreeItem | DirectoryTreeItem;
export class DirectoryTreeItem extends vscode.TreeItem {
constructor(
public readonly dir: string,
public readonly children: Array<GroupedResourceTreeItem>,
itemLabel: string
) {
super(dir || 'Not Created', vscode.TreeItemCollapsibleState.Collapsed);
const s = this.children.length > 1 ? 's' : '';
this.description = `${this.children.length} ${itemLabel}${s}`;
}
iconPath = new vscode.ThemeIcon('folder');
contextValue = 'directory';
resolveTreeItem(): Promise<GroupedResourceTreeItem> {
const titles = this.children
.map(c => c.label?.toString())
.sort(sortByString);
this.tooltip = getContainsTooltip(titles);
return Promise.resolve(this);
}
getChildren(): Promise<GroupedResourceTreeItem[]> {
return Promise.resolve(this.children);
}
}
const sortByTreeItemLabel = (a: vscode.TreeItem, b: vscode.TreeItem) =>
a.label.toString().localeCompare(b.label.toString());
const sortByString = (a: string, b: string) =>
a.toLocaleLowerCase().localeCompare(b.toLocaleLowerCase());

View File

@@ -1,178 +0,0 @@
import * as vscode from 'vscode';
import { Resource } from '../core/model/note';
import { toVsCodeUri } from './vsc-utils';
import { Range } from '../core/model/range';
import { OPEN_COMMAND } from '../features/commands/open-resource';
import { URI } from '../core/model/uri';
import { FoamWorkspace } from '../core/model/workspace';
import { getNoteTooltip } from '../utils';
import { isSome } from '../core/utils';
import { groupBy } from 'lodash';
import { getBlockFor } from '../core/services/markdown-parser';
export class UriTreeItem extends vscode.TreeItem {
private doGetChildren: () => Promise<vscode.TreeItem[]>;
constructor(
public readonly uri: URI,
options: {
collapsibleState?: vscode.TreeItemCollapsibleState;
icon?: string;
title?: string;
getChildren?: () => Promise<vscode.TreeItem[]>;
} = {}
) {
super(
options?.title ?? uri.getName(),
options.collapsibleState
? options.collapsibleState
: options.getChildren
? vscode.TreeItemCollapsibleState.Collapsed
: vscode.TreeItemCollapsibleState.None
);
this.doGetChildren = options.getChildren;
this.description = uri.path.replace(
vscode.workspace.getWorkspaceFolder(toVsCodeUri(uri))?.uri.path,
''
);
this.tooltip = undefined;
this.iconPath = new vscode.ThemeIcon(options.icon ?? 'new-file');
}
resolveTreeItem(): Promise<UriTreeItem> {
return Promise.resolve(this);
}
getChildren(): Promise<vscode.TreeItem[]> {
return isSome(this.doGetChildren)
? this.doGetChildren()
: Promise.resolve([]);
}
}
export class ResourceTreeItem extends UriTreeItem {
constructor(
public readonly resource: Resource,
private readonly workspace: FoamWorkspace,
options: {
collapsibleState?: vscode.TreeItemCollapsibleState;
getChildren?: () => Promise<vscode.TreeItem[]>;
} = {}
) {
super(resource.uri, {
title: resource.title,
icon: 'note',
collapsibleState: options.collapsibleState,
getChildren: options.getChildren,
});
this.command = {
command: 'vscode.open',
arguments: [toVsCodeUri(resource.uri)],
title: 'Go to location',
};
this.contextValue = 'resource';
}
async resolveTreeItem(): Promise<ResourceTreeItem> {
if (this instanceof ResourceTreeItem) {
const content = await this.workspace.readAsMarkdown(this.resource.uri);
this.tooltip = isSome(content)
? getNoteTooltip(content)
: this.resource.title;
}
return this;
}
}
export class ResourceRangeTreeItem extends vscode.TreeItem {
constructor(
public label: string,
public readonly resource: Resource,
public readonly range: Range,
private resolveFn?: (
item: ResourceRangeTreeItem
) => Promise<ResourceRangeTreeItem>
) {
super(label, vscode.TreeItemCollapsibleState.None);
this.label = `${range.start.line}: ${this.label}`;
this.command = {
command: 'vscode.open',
arguments: [toVsCodeUri(resource.uri), { selection: range }],
title: 'Go to location',
};
}
resolveTreeItem(): Promise<ResourceRangeTreeItem> {
return this.resolveFn ? this.resolveFn(this) : Promise.resolve(this);
}
static async createStandardItem(
workspace: FoamWorkspace,
resource: Resource,
range: Range
): Promise<ResourceRangeTreeItem> {
const markdown = (await workspace.readAsMarkdown(resource.uri)) ?? '';
const lines = markdown.split('\n');
const line = lines[range.start.line];
const start = Math.max(0, range.start.character - 15);
const ellipsis = start === 0 ? '' : '...';
const label = line
? `${range.start.line}: ${ellipsis}${line.slice(start, start + 300)}`
: Range.toString(range);
const resolveFn = (item: ResourceRangeTreeItem) => {
let { block, nLines } = getBlockFor(markdown, range.start);
// Long blocks need to be interrupted or they won't display in hover preview
// We keep the extra lines so that the count in the preview is correct
if (nLines > 15) {
let tmp = block.split('\n');
tmp.splice(15, 1, '\n'); // replace a line with a blank line to interrupt the block
block = tmp.join('\n');
}
const tooltip = getNoteTooltip(block ?? line ?? '');
item.tooltip = tooltip;
return Promise.resolve(item);
};
const item = new ResourceRangeTreeItem(label, resource, range, resolveFn);
return item;
}
}
export const groupRangesByResource = async (
workspace: FoamWorkspace,
items:
| ResourceRangeTreeItem[]
| Promise<ResourceRangeTreeItem[]>
| Promise<ResourceRangeTreeItem>[],
collapsibleState = vscode.TreeItemCollapsibleState.Collapsed
) => {
let itemsArray = [] as ResourceRangeTreeItem[];
if (items instanceof Promise) {
itemsArray = await items;
}
if (items instanceof Array && items[0] instanceof Promise) {
itemsArray = await Promise.all(items);
}
if (items instanceof Array && items[0] instanceof ResourceRangeTreeItem) {
itemsArray = items as any;
}
const byResource = groupBy(itemsArray, item => item.resource.uri.path);
const resourceItems = Object.values(byResource).map(items => {
const resourceItem = new ResourceTreeItem(items[0].resource, workspace, {
collapsibleState,
getChildren: () => {
return Promise.resolve(
items.sort((a, b) => Range.isBefore(a.range, b.range))
);
},
});
resourceItem.description = `(${items.length}) ${resourceItem.description}`;
return resourceItem;
});
resourceItems.sort((a, b) => Resource.sortByTitle(a.resource, b.resource));
return resourceItems;
};

View File

@@ -17,7 +17,13 @@ export const fromVsCodeUri = (u: Uri): FoamURI => FoamURI.parse(u.toString());
* A class that wraps context value, syncs it via setContext, and provides a typed interface to it.
*/
export class ContextMemento<T> {
constructor(private data: Memento, private key: string, defaultValue: T) {
constructor(
private data: Memento,
private key: string,
defaultValue: T,
resetToDefault: boolean = false
) {
resetToDefault && this.data.update(this.key, defaultValue);
const value = data.get(key) ?? defaultValue;
commands.executeCommand('setContext', this.key, value);
}

View File

@@ -12,7 +12,7 @@
id="graph"
style="position: absolute; top: 0; left: 0; right: 0; bottom: 0;"
></div>
<!-- To test the graph locally in a broswer:
<!-- To test the graph locally in a browser:
1. copy the json data object received in the message payload
2. paste the content in test-data.js
3. uncomment the next <script ...> line

View File

@@ -1,4 +1,4 @@
# Note being refered as angel
# Note being referred as angel
This is just a link target for now.

View File

@@ -1,3 +1,3 @@
# Angel reference
[[Note being refered as angel]]
[[Note being referred as angel]]

View File

@@ -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 -->
[![All Contributors](https://img.shields.io/badge/all_contributors-111-orange.svg?style=flat-square)](#contributors-)
[![All Contributors](https://img.shields.io/badge/all_contributors-112-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
[![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/foam.foam-vscode?label=VS%20Code%20Installs)](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode)
@@ -341,6 +341,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<td align="center" valign="top" width="14.28%"><a href="http://yongliangliu.com"><img src="https://avatars.githubusercontent.com/u/41845017?v=4?s=60" width="60px;" alt="Liu YongLiang"/><br /><sub><b>Liu YongLiang</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=tlylt" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://scottakerman.com"><img src="https://avatars.githubusercontent.com/u/15224439?v=4?s=60" width="60px;" alt="Scott Akerman"/><br /><sub><b>Scott Akerman</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=Skakerman" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://www.jim-graham.net/"><img src="https://avatars.githubusercontent.com/u/430293?v=4?s=60" width="60px;" alt="Jim Graham"/><br /><sub><b>Jim Graham</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jimgraham" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://t.me/littlepoint"><img src="https://avatars.githubusercontent.com/u/7611700?v=4?s=60" width="60px;" alt="Zhizhen He"/><br /><sub><b>Zhizhen He</b></sub></a><br /><a href="#tool-hezhizhen" title="Tools">🔧</a></td>
</tr>
</tbody>
</table>

6
typos.toml Normal file
View File

@@ -0,0 +1,6 @@
# See https://github.com/crate-ci/typos/blob/master/docs/reference.md to configure typos
[default.extend-words]
ons = "ons" # add-ons
pallette = "pallette"
[files]
extend-exclude = ["CHANGELOG.md", "d3.v6.min.js", "force-graph.1.40.5.min.js", "dat.gui.min.js"]