Compare commits

...

36 Commits

Author SHA1 Message Date
Riccardo Ferretti
fac2247382 v0.25.0 2023-06-30 14:12:50 +02:00
Riccardo Ferretti
b089b997bb Preparation for next release 2023-06-30 14:12:30 +02:00
Riccardo
a504054504 Support for multiple file extensions and default extension (#1235)
* Added multiple extension support for markdown provider

* Added default extension support

* Injecting extensions params to FoamWorkspace and MarkdownProvider (to avoid dependencies on non-core code)

* Inject extensions to attachment provider
2023-06-30 14:08:59 +02:00
Riccardo Ferretti
a00d18cfbb Fixed connections panel documentation (fixes @1244) 2023-06-19 13:08:16 +02:00
Riccardo Ferretti
5ca7c3eb52 Fixed #1236 - show full name in "Create note with template" hover 2023-05-23 22:33:08 +02:00
Riccardo
571b6a3528 Add FOAM_TITLE_SAFE variable (#1232)
* Introduced FOAM_TITLE_SAFE, which is the FOAM_TITLE variable with all the invalid path characters replaced by '-'

* (out of scope) In notes explorer show item description only when name is different from note title
2023-05-22 17:14:21 +02:00
Riccardo Ferretti
b6c9eac86c Notes explorer ignores untitled documents 2023-05-22 15:56:44 +02:00
dependabot[bot]
557330413c Bump yaml from 1.10.2 to 2.2.2 (#1210)
Bumps [yaml](https://github.com/eemeli/yaml) from 1.10.2 to 2.2.2.
- [Release notes](https://github.com/eemeli/yaml/releases)
- [Commits](https://github.com/eemeli/yaml/compare/v1.10.2...v2.2.2)

---
updated-dependencies:
- dependency-name: yaml
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-21 18:48:07 +02:00
Riccardo
20894a1166 Connections panel tweaks (#1233)
* Renamed commands and labels in connections panel

* renamed backlinks.ts -> connections.ts

* (out of scope) In notes explorer show item description only when name is different from note title
2023-05-21 18:37:53 +02:00
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
Riccardo Ferretti
f1b15eceed v0.22.2 2023-04-20 18:25:37 -07:00
Riccardo Ferretti
96f410a453 Prepare for next release 2023-04-20 18:25:06 -07:00
Riccardo Ferretti
95a14d5dd6 Create blocks markdown parser only once 2023-04-20 18:25:00 -07:00
Riccardo
10905fd703 Various improvements in tree view panels (#1201)
* Show note block in panels on hover preview
* Show tag references within tag explorer
* Improved structure of view related commands
* Refactored grouped resources tree data provider and added support for placeholders filter
  - Consolidated the naming of the accessory commands
  - Consolidated the management of the state/context related to grouping
  - Removed group-by config, simply restore the last used setting
  - Added filter to only show the placeholders related to the open file
* Refreshing placeholders when changing editor and filtering by active document
2023-04-21 03:20:22 +02:00
Riccardo Ferretti
f4eaf5c5ff v0.22.1 2023-04-15 13:39:00 -07:00
Riccardo Ferretti
b4830eaf30 Prepare for next release 2023-04-15 13:38:28 -07:00
Jim Graham
0cda6aed50 Allow for # alone to trigger tag completion (#1192)
* Allow for `#` alone to trigger tag completion

In #1183, I reused [HASHTAG_REGEX](83a90177b9/packages/foam-vscode/src/core/utils/hashtags.ts (L2-L3))
to validate the tag line when the `CompletionProvider` was triggered.

I wanted to prevent this:

```markdown
 # This is a Markdown header
```

but using the `HASHTAG_REGEX` had the side effect of requiring an
_additional_ character to trigger the completion provider.

```markdown

1. #p <-- triggers completion
2. #  <-- does not trigger
3. #_ (space) <-- does not trigger
```
both 1. and 2. should have triggered.

To fix, I use a slightly different regex that uses a negative lookahead
to ensure that the `#` is not followed by a space. I also added spec
cases to cover this situation.

* Update regex for more robust detection of tags

Update the regex used for more robust detection of tags. Replace the
negative lookahead assertion `\s` with `[ \t]` (allow for `\n`), and
add `#` to the class so that `##` is ignored.

Attempted to add the negation `^[0-9p{L}p{Emoji}p{N}-/]` to the
negative look ahead. This was to exclude items like `#$`, `#&` that
can't be tags. However my regex-fu was insufficient.

Instead, if the regex match is to a single `#`, ensure it is the
character to the left of the cursor. Example

  `this is text #%|`

where the `|` represents the cursor. The `TAG_REGEX`
will match the `#` at index 13. However since the cursor is at 15, the
Completion provider will not run.

Update the tests to cover these situations and add them all to a sub-
`describe` block labeled by the bug issue number #1189

* Use regex groups to determine match position

For the case like `here is #my-tag and now # |`, where `|` is the cursor
position after a trailing space, the match on `#my-tag` would allow tag
completion at the cursor position.

Ensure that the last regexp match group covers up to the the cursor
position. This also handles the case of `#$` because the match will only
be `#`.
2023-04-15 22:34:55 +02:00
Riccardo Ferretti
89c9bb5a7f v0.22.0 2023-04-15 10:47:20 -07:00
Riccardo Ferretti
941e870a65 Prepare for 0.22.0 2023-04-15 10:47:06 -07:00
Riccardo
c6655c33ff Fixed #1193 and added tests (#1197) 2023-04-15 19:31:48 +02:00
Riccardo
c94fb18f8a Resource tree items improvements (#1196)
* Consolidated common tree view code and migrated placeholder panel
* Migrated backlink panel to new pattern
* Tweaked code and fixed tests
2023-04-15 19:21:24 +02:00
Riccardo
cbd55bac74 Fix #1134 - added support for deep tag hierarchy (#1194) 2023-04-15 02:22:12 +02:00
105 changed files with 3493 additions and 2127 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

@@ -1,10 +1,11 @@
# Backlinking
When using [[wikilinks]], you can find all notes that link to a specific note in the **Backlinks Explorer**
When using [[wikilinks]], you can find all notes that link to a specific note in the **Connections Explorer**
- Run `Cmd` + `Shift` + `P` (`Ctrl` + `Shift` + `P` for Windows), type "backlinks" and run the **Explorer: Focus on Backlinks** view.
- Run `Cmd` + `Shift` + `P` (`Ctrl` + `Shift` + `P` for Windows), type "connections" and run the **Explorer: Focus on Connections** view.
- Keep this pane always visible to discover relationships between your thoughts
- You can drag the backlinks pane to a different section in VS Code if you prefer. See: [[make-backlinks-more-prominent]]
- You can drag the connections panel to a different section in VS Code if you prefer. See: [[make-backlinks-more-prominent]]
- You can filter the connections to see just backlinks, forward links, or all connections
- Finding backlinks in published Foam workspaces via [[materialized-backlinks]] is on the [[roadmap]] but not yet implemented.
[//begin]: # "Autogenerated link references for markdown compatibility"

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

@@ -58,6 +58,7 @@ In addition, you can also use variables provided by Foam:
| -------------------- | ------------ |
| `FOAM_SELECTED_TEXT` | Foam will fill it with selected text when creating a new note, if any text is selected. Selected text will be replaced with a wikilink to the new |
| `FOAM_TITLE` | The title of the note. If used, Foam will prompt you to enter a title for the note. |
| `FOAM_TITLE_SAFE` | The title of the note in a file system safe format. If used, Foam will prompt you to enter a title for the note unless `FOAM_TITLE` has already caused the prompt. |
| `FOAM_SLUG` | The sluggified title of the note (using the default github slug method). If used, Foam will prompt you to enter a title for the note unless `FOAM_TITLE` has already caused the prompt. |
| `FOAM_DATE_*` | `FOAM_DATE_YEAR`, `FOAM_DATE_MONTH`, `FOAM_DATE_WEEK` etc. Foam-specific versions of [VS Code's datetime snippet variables](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_variables). Prefer these versions over VS Code's. |

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.21.4"
"version": "0.25.0"
}

View File

@@ -4,6 +4,64 @@ All notable changes to the "foam-vscode" extension will be documented in this fi
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
## [0.25.0] - 2023-06-30
Features:
- Support for multiple extensions and custom default extension (#1235)
- Added `FOAM_TITLE_SAFE` template variable (#1232)
Fixes and Improvements:
- Connections panel tweaks (#1233)
## [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:
- Support to show placeholders only for open file in panel (#1201, #988)
- Show note block in panels on hover preview (#1201, #800)
- Show tag references within tag explorer (#1201)
- Improved structure of view related commands (#1201)
- Ignore `.foam` directory
## [0.22.1] - 2023-04-15
Fixes and Improvements:
- Allow the `#` char to trigger tag autocompletion (#1192, #1189 - thanks @jimgraham)
## [0.22.0] - 2023-04-15
Fixes and Improvements:
- Added support for deep tag hierarchy in Tag Explorer panel (#1134, #1194)
- Consolidated and improved Backlinks, Placeholders and Orphans panels (#1196)
- Fixed note resolution when using template without defined path (#1197)
## [0.21.4] - 2023-04-14
Fixes and Improvements:

View File

@@ -0,0 +1,33 @@
The MIT Licence (MIT)
Copyright 2020 - present Jani Eväkallio <jani.evakallio@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Where noted, some code uses the following license:
MIT License
Copyright (c) 2015 - present Microsoft Corporation
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

View File

@@ -8,7 +8,7 @@
"type": "git"
},
"homepage": "https://github.com/foambubble/foam",
"version": "0.21.4",
"version": "0.25.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",
@@ -96,29 +102,64 @@
},
{
"view": "foam-vscode.placeholders",
"contents": "No placeholders found. Pending links and notes without content will show up here."
"contents": "No placeholders found for selected resource or workspace."
}
],
"menus": {
"view/title": [
{
"command": "foam-vscode.group-orphans-by-folder",
"when": "view == foam-vscode.orphans && foam-vscode.orphans-grouped-by-folder == false",
"command": "foam-vscode.views.connections.show:backlinks",
"when": "view == foam-vscode.connections && foam-vscode.views.connections.show == 'all links'",
"group": "navigation"
},
{
"command": "foam-vscode.group-orphans-off",
"when": "view == foam-vscode.orphans && foam-vscode.orphans-grouped-by-folder == true",
"command": "foam-vscode.views.connections.show:forward-links",
"when": "view == foam-vscode.connections && foam-vscode.views.connections.show == 'backlinks'",
"group": "navigation"
},
{
"command": "foam-vscode.group-placeholders-by-folder",
"when": "view == foam-vscode.placeholders && foam-vscode.placeholders-grouped-by-folder == false",
"command": "foam-vscode.views.connections.show:all-links",
"when": "view == foam-vscode.connections && foam-vscode.views.connections.show == 'forward links'",
"group": "navigation"
},
{
"command": "foam-vscode.group-placeholders-off",
"when": "view == foam-vscode.placeholders && foam-vscode.placeholders-grouped-by-folder == true",
"command": "foam-vscode.views.orphans.group-by:folder",
"when": "view == foam-vscode.orphans && foam-vscode.views.orphans.group-by == 'off'",
"group": "navigation"
},
{
"command": "foam-vscode.views.orphans.group-by:off",
"when": "view == foam-vscode.orphans && foam-vscode.views.orphans.group-by == 'folder'",
"group": "navigation"
},
{
"command": "foam-vscode.views.placeholders.show:for-current-file",
"when": "view == foam-vscode.placeholders && foam-vscode.views.placeholders.show == 'all'",
"group": "navigation"
},
{
"command": "foam-vscode.views.placeholders.show:all",
"when": "view == foam-vscode.placeholders && foam-vscode.views.placeholders.show == 'for-current-file'",
"group": "navigation"
},
{
"command": "foam-vscode.views.placeholders.group-by:folder",
"when": "view == foam-vscode.placeholders && foam-vscode.views.placeholders.group-by == 'off'",
"group": "navigation"
},
{
"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"
}
],
@@ -132,19 +173,47 @@
"when": "false"
},
{
"command": "foam-vscode.group-orphans-by-folder",
"command": "foam-vscode.views.connections.show:all-links",
"when": "false"
},
{
"command": "foam-vscode.group-orphans-off",
"command": "foam-vscode.views.connections.show:backlinks",
"when": "false"
},
{
"command": "foam-vscode.group-placeholders-by-folder",
"command": "foam-vscode.views.connections.show:forward-links",
"when": "false"
},
{
"command": "foam-vscode.group-placeholders-off",
"command": "foam-vscode.views.orphans.group-by:folder",
"when": "false"
},
{
"command": "foam-vscode.views.orphans.group-by:off",
"when": "false"
},
{
"command": "foam-vscode.views.placeholders.show:for-current-file",
"when": "false"
},
{
"command": "foam-vscode.views.placeholders.show:all",
"when": "false"
},
{
"command": "foam-vscode.views.placeholders.group-by:folder",
"when": "false"
},
{
"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"
},
{
@@ -179,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",
@@ -215,25 +284,60 @@
"title": "Foam: Open Resource"
},
{
"command": "foam-vscode.group-orphans-by-folder",
"title": "Foam: Group Orphans By Folder",
"command": "foam-vscode.views.orphans.group-by:folder",
"title": "Group By Folder",
"icon": "$(list-tree)"
},
{
"command": "foam-vscode.group-orphans-off",
"title": "Foam: Don't Group Orphans",
"command": "foam-vscode.views.connections.show:backlinks",
"title": "Show Backlinks",
"icon": "$(arrow-left)"
},
{
"command": "foam-vscode.views.connections.show:forward-links",
"title": "Show Links",
"icon": "$(arrow-right)"
},
{
"command": "foam-vscode.views.connections.show:all-links",
"title": "Show All",
"icon": "$(arrow-swap)"
},
{
"command": "foam-vscode.views.orphans.group-by:off",
"title": "Flat list",
"icon": "$(list-flat)"
},
{
"command": "foam-vscode.group-placeholders-by-folder",
"title": "Foam: Group Placeholders By Folder",
"command": "foam-vscode.views.placeholders.show:for-current-file",
"title": "Show placeholders in current file",
"icon": "$(file)"
},
{
"command": "foam-vscode.views.placeholders.show:all",
"title": "Show placeholders in workspace",
"icon": "$(files)"
},
{
"command": "foam-vscode.views.placeholders.group-by:folder",
"title": "Group By Folder",
"icon": "$(list-tree)"
},
{
"command": "foam-vscode.group-placeholders-off",
"title": "Foam: Don't Group Placeholders",
"command": "foam-vscode.views.placeholders.group-by:off",
"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"
@@ -291,6 +395,16 @@
"default": "pdf mp3 webm wav m4a mp4 avi mov rtf txt doc docx pages xls xlsx numbers ppt pptm pptx",
"description": "Space separated list of file extensions that will be considered attachments"
},
"foam.files.notesExtensions": {
"type": "string",
"default": "",
"description": "Space separated list of extra file extensions that will be considered text notes (e.g. 'mdx txt markdown')"
},
"foam.files.defaultNoteExtension": {
"type": "string",
"default": "md",
"description": "The default extension for new notes"
},
"foam.files.newNotePath": {
"type": "string",
"default": "root",
@@ -375,21 +489,6 @@
"default": [],
"markdownDescription": "Specifies the list of glob patterns that will be excluded from the orphans report. To ignore the all the content of a given folder, use `**<folderName>/**/*`"
},
"foam.orphans.groupBy": {
"type": [
"string"
],
"enum": [
"off",
"folder"
],
"enumDescriptions": [
"Disable grouping",
"Group by folder"
],
"default": "folder",
"markdownDescription": "Group orphans report entries by."
},
"foam.placeholders.exclude": {
"type": [
"array"
@@ -397,21 +496,6 @@
"default": [],
"markdownDescription": "Specifies the list of glob patterns that will be excluded from the placeholders report. To ignore the all the content of a given folder, use `**<folderName>/**/*`"
},
"foam.placeholders.groupBy": {
"type": [
"string"
],
"enum": [
"off",
"folder"
],
"enumDescriptions": [
"Disable grouping",
"Group by folder"
],
"default": "folder",
"markdownDescription": "Group blank note report entries by."
},
"foam.dateSnippets.afterCompletion": {
"type": "string",
"default": "createNote",
@@ -519,7 +603,7 @@
"title-case": "^3.0.2",
"unified": "^9.0.0",
"unist-util-visit": "^2.0.2",
"yaml": "^1.10.0"
"yaml": "^2.2.2"
},
"__metadata": {
"id": "b85c6625-454b-4b61-8a22-c42f3d0f2e1e",

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

@@ -25,13 +25,15 @@ export const bootstrap = async (
watcher: IWatcher | undefined,
dataStore: IDataStore,
parser: ResourceParser,
initialProviders: ResourceProvider[]
initialProviders: ResourceProvider[],
defaultExtension: string = '.md'
) => {
const tsStart = Date.now();
const workspace = await FoamWorkspace.fromProviders(
initialProviders,
dataStore
dataStore,
defaultExtension
);
const tsWsDone = Date.now();

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;
@@ -53,6 +66,10 @@ export abstract class Resource {
return a.title.localeCompare(b.title);
}
public static sortByPath(a: Resource, b: Resource) {
return a.uri.path.localeCompare(b.uri.path);
}
public static isResource(thing: any): thing is Resource {
if (!thing) {
return false;

View File

@@ -69,4 +69,8 @@ export abstract class Range {
static isBefore(a: Range, b: Range): number {
return a.start.line - b.start.line || a.start.character - b.start.character;
}
static toString(range: Range): string {
return `${range.start.line}:${range.start.character} - ${range.end.line}:${range.end.character}`;
}
}

View File

@@ -107,7 +107,7 @@ describe('Identifier computation', () => {
const third = createTestNote({
uri: '/another/path/for/page-a.md',
});
const ws = new FoamWorkspace().set(first).set(second).set(third);
const ws = new FoamWorkspace('.md').set(first).set(second).set(third);
expect(ws.getIdentifier(first.uri)).toEqual('to/page-a');
expect(ws.getIdentifier(second.uri)).toEqual('way/for/page-a');
@@ -124,7 +124,7 @@ describe('Identifier computation', () => {
const third = createTestNote({
uri: '/another/path/for/page-a.md',
});
const ws = new FoamWorkspace().set(first).set(second).set(third);
const ws = new FoamWorkspace('.md').set(first).set(second).set(third);
expect(ws.getIdentifier(first.uri.withFragment('section name'))).toEqual(
'to/page-a#section name'
@@ -170,7 +170,7 @@ describe('Identifier computation', () => {
});
it('should ignore elements from the exclude list', () => {
const workspace = new FoamWorkspace();
const workspace = new FoamWorkspace('.md');
const noteA = createTestNote({ uri: '/path/to/note-a.md' });
const noteB = createTestNote({ uri: '/path/to/note-b.md' });
const noteC = createTestNote({ uri: '/path/to/note-c.md' });

View File

@@ -22,6 +22,11 @@ export class FoamWorkspace implements IDisposable {
*/
private _resources: Map<string, Resource> = new Map();
/**
* @param defaultExtension: The default extension for notes in this workspace (e.g. `.md`)
*/
constructor(public defaultExtension: string = '.md') {}
registerProvider(provider: ResourceProvider) {
this.providers.push(provider);
}
@@ -67,14 +72,16 @@ export class FoamWorkspace implements IDisposable {
public listByIdentifier(identifier: string): Resource[] {
const needle = normalize('/' + identifier);
const mdNeedle =
getExtension(needle) !== '.md' ? needle + '.md' : undefined;
const resources = [];
getExtension(needle) !== this.defaultExtension
? needle + this.defaultExtension
: undefined;
const resources: Resource[] = [];
for (const key of this._resources.keys()) {
if ((mdNeedle && key.endsWith(mdNeedle)) || key.endsWith(needle)) {
if (key.endsWith(mdNeedle) || key.endsWith(needle)) {
resources.push(this._resources.get(normalize(key)));
}
}
return resources.sort((a, b) => a.uri.path.localeCompare(b.uri.path));
return resources.sort(Resource.sortByPath);
}
/**
@@ -105,7 +112,7 @@ export class FoamWorkspace implements IDisposable {
forResource.path,
amongst.map(uri => uri.path)
);
identifier = changeExtension(identifier, '.md', '');
identifier = changeExtension(identifier, this.defaultExtension, '');
if (forResource.fragment) {
identifier += `#${forResource.fragment}`;
}
@@ -121,7 +128,7 @@ export class FoamWorkspace implements IDisposable {
if (FoamWorkspace.isIdentifier(path)) {
resource = this.listByIdentifier(path)[0];
} else {
const candidates = [path, path + '.md'];
const candidates = [path, path + this.defaultExtension];
for (const candidate of candidates) {
const searchKey = isAbsolute(candidate)
? candidate
@@ -141,7 +148,6 @@ export class FoamWorkspace implements IDisposable {
}
public resolveLink(resource: Resource, link: ResourceLink): URI {
// TODO add tests
for (const provider of this.providers) {
if (provider.supports(resource.uri)) {
return provider.resolveLink(this, resource, link);
@@ -237,9 +243,10 @@ export class FoamWorkspace implements IDisposable {
static async fromProviders(
providers: ResourceProvider[],
dataStore: IDataStore
dataStore: IDataStore,
defaultExtension: string = '.md'
): Promise<FoamWorkspace> {
const workspace = new FoamWorkspace();
const workspace = new FoamWorkspace(defaultExtension);
await Promise.all(providers.map(p => workspace.registerProvider(p)));
const files = await dataStore.list();
await Promise.all(files.map(f => workspace.fetchAndSet(f)));

View File

@@ -3,17 +3,8 @@ import { URI } from '../model/uri';
import { FoamWorkspace } from '../model/workspace';
import { IDisposable } from '../common/lifecycle';
import { ResourceProvider } from '../model/provider';
import { getFoamVsCodeConfig } from '../../services/config';
const attachmentExtConfig = getFoamVsCodeConfig(
'files.attachmentExtensions',
''
)
.split(' ')
.map(ext => '.' + ext.trim());
const imageExtensions = ['.png', '.jpg', '.jpeg', '.gif', '.svg', '.webp'];
const attachmentExtensions = [...attachmentExtConfig, ...imageExtensions];
const asResource = (uri: URI): Resource => {
const type = imageExtensions.includes(uri.getExtension())
@@ -34,9 +25,14 @@ const asResource = (uri: URI): Resource => {
export class AttachmentResourceProvider implements ResourceProvider {
private disposables: IDisposable[] = [];
public readonly attachmentExtensions: string[];
constructor(attachmentExtensions: string[] = []) {
this.attachmentExtensions = [...imageExtensions, ...attachmentExtensions];
}
supports(uri: URI) {
return attachmentExtensions.includes(
return this.attachmentExtensions.includes(
uri.getExtension().toLocaleLowerCase()
);
}

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

@@ -1,8 +1,13 @@
import { createMarkdownParser, ParserPlugin } from './markdown-parser';
import {
createMarkdownParser,
getBlockFor,
ParserPlugin,
} from './markdown-parser';
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');
@@ -459,3 +464,121 @@ But with some content.
]);
});
});
describe('Block detection for lists', () => {
const md = `
- this is block 1
- this is [[block]] 2
- this is block 2.1
- this is block 3
- this is block 3.1
- this is block 3.1.1
- this is block 3.2
- this is block 4
this is a simple line
this is another simple line
`;
it('can detect block', () => {
const { block } = getBlockFor(md, 1);
expect(block).toEqual('- this is block 1');
});
it('supports nested blocks 1', () => {
const { block } = getBlockFor(md, 2);
expect(block).toEqual(`- this is [[block]] 2
- this is block 2.1`);
});
it('supports nested blocks 2', () => {
const { block } = getBlockFor(md, 5);
expect(block).toEqual(` - this is block 3.1
- this is block 3.1.1`);
});
it('returns the line if no block is detected', () => {
const { block } = getBlockFor(md, 9);
expect(block).toEqual(`this is a simple line`);
});
it('is compatible with Range object', () => {
const note = parser.parse(URI.file('/path/to/a'), md);
const { start } = note.links[0].range;
const { block } = getBlockFor(md, start);
expect(block).toEqual(`- this is [[block]] 2
- 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) => {
@@ -424,3 +424,46 @@ const astPositionToFoamRange = (pos: AstPosition): Range =>
pos.end.line - 1,
pos.end.column - 1
);
const blockParser = unified().use(markdownParse, { gfm: true });
export const getBlockFor = (
markdown: string,
line: number | Position
): { block: string; nLines: number } => {
const searchLine = typeof line === 'number' ? line : line.line;
const tree = blockParser.parse(markdown);
const lines = markdown.split('\n');
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) {
startLine = node.position.start.line - 1;
endLine = node.position.end.line;
return visit.EXIT;
}
});
// 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,17 +12,19 @@ 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[] = [];
constructor(
private readonly dataStore: IDataStore,
private readonly parser: ResourceParser
private readonly parser: ResourceParser,
public readonly noteExtensions: string[] = ['.md']
) {}
supports(uri: URI) {
return uri.isMarkdown();
return this.noteExtensions.includes(uri.getExtension());
}
async readAsMarkdown(uri: URI): Promise<string | null> {
@@ -106,27 +108,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,8 +129,11 @@ to generate markdown reference list`
return null;
}
let relativeUri = target.uri.relativeTo(noteUri.getDirectory());
if (!includeExtension && relativeUri.path.endsWith('.md')) {
let relativeUri = target.uri.relativeTo(resource.uri.getDirectory());
if (
!includeExtension &&
relativeUri.path.endsWith(workspace.defaultExtension)
) {
relativeUri = relativeUri.changeExtension('*', '');
}
@@ -152,17 +149,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

@@ -7,12 +7,17 @@ import { Logger } from './core/utils/log';
import { features } from './features';
import { VsCodeOutputLogger, exposeLogger } from './services/logging';
import { getIgnoredFilesSetting } from './settings';
import {
getAttachmentsExtensions,
getIgnoredFilesSetting,
getNotesExtensions,
} from './settings';
import { AttachmentResourceProvider } from './core/services/attachment-provider';
import { VsCodeWatcher } from './services/watcher';
import { createMarkdownParser } from './core/services/markdown-parser';
import VsCodeBasedParserCache from './services/cache';
import { createMatcherAndDataStore } from './services/editor';
import { getFoamVsCodeConfig } from './services/config';
export async function activate(context: ExtensionContext) {
const logger = new VsCodeOutputLogger();
@@ -45,16 +50,30 @@ export async function activate(context: ExtensionContext) {
const parserCache = new VsCodeBasedParserCache(context);
const parser = createMarkdownParser([], parserCache);
const markdownProvider = new MarkdownResourceProvider(dataStore, parser);
const attachmentProvider = new AttachmentResourceProvider();
const { notesExtensions, defaultExtension } = getNotesExtensions();
const foamPromise = bootstrap(matcher, watcher, dataStore, parser, [
markdownProvider,
attachmentProvider,
]);
const markdownProvider = new MarkdownResourceProvider(
dataStore,
parser,
notesExtensions
);
const attachmentExtConfig = getAttachmentsExtensions();
const attachmentProvider = new AttachmentResourceProvider(
attachmentExtConfig
);
const foamPromise = bootstrap(
matcher,
watcher,
dataStore,
parser,
[markdownProvider, attachmentProvider],
defaultExtension
);
// 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`);
@@ -66,7 +85,21 @@ export async function activate(context: ExtensionContext) {
attachmentProvider,
commands.registerCommand('foam-vscode.clear-cache', () =>
parserCache.clear()
)
),
workspace.onDidChangeConfiguration(e => {
if (
[
'foam.files.ignore',
'foam.files.attachmentExtensions',
'foam.files.noteExtensions',
'foam.files.defaultNoteExtension',
].some(setting => e.affectsConfiguration(setting))
) {
window.showInformationMessage(
'Foam: Reload the window to use the updated settings'
);
}
})
);
const res = (await Promise.all(resPromises)).filter(r => r != null);

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

@@ -194,7 +194,10 @@ describe('factories', () => {
describe('forPlaceholder', () => {
it('adds the .md extension to notes created for placeholders', async () => {
await closeEditors();
const command = CREATE_NOTE_COMMAND.forPlaceholder('my-placeholder');
const command = CREATE_NOTE_COMMAND.forPlaceholder(
'my-placeholder',
'.md'
);
await commands.executeCommand(command.name, command.params);
const doc = window.activeTextEditor.document;

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.
@@ -110,16 +114,27 @@ async function createNote(args: CreateNoteArgs) {
export const CREATE_NOTE_COMMAND = {
command: 'foam-vscode.create-note',
/**
* Creates a command descriptor to create a note from the given placeholder.
*
* @param placeholder the placeholder
* @param defaultExtension the default extension (e.g. '.md')
* @param extra extra command arguments
* @returns the command descriptor
*/
forPlaceholder: (
placeholder: string,
defaultExtension: string,
extra: Partial<CreateNoteArgs> = {}
): CommandDescriptor<CreateNoteArgs> => {
const title = placeholder.endsWith('.md')
? placeholder.replace(/\.md$/, '')
const endsWithDefaultExtension = new RegExp(defaultExtension + '$');
const title = placeholder.endsWith(defaultExtension)
? placeholder.replace(endsWithDefaultExtension, '')
: placeholder;
const notePath = placeholder.endsWith('.md')
const notePath = placeholder.endsWith(defaultExtension)
? placeholder
: placeholder + '.md';
: placeholder + defaultExtension;
return {
name: CREATE_NOTE_COMMAND.command,
params: {
@@ -130,13 +145,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(
@@ -109,12 +106,16 @@ export class HoverProvider implements vscode.HoverProvider {
: this.workspace.get(targetUri).title;
}
const command = CREATE_NOTE_COMMAND.forPlaceholder(targetUri.path, {
askForTemplate: true,
onFileExists: 'open',
});
const command = CREATE_NOTE_COMMAND.forPlaceholder(
targetUri.path,
this.workspace.defaultExtension,
{
askForTemplate: true,
onFileExists: 'open',
}
);
const newNoteFromTemplate = new vscode.MarkdownString(
`[Create note from template for '${targetUri.getName()}'](${commandAsURI(
`[Create note from template for '${targetUri.getBasename()}'](${commandAsURI(
command
).toString()})`
);
@@ -131,5 +132,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';
@@ -85,7 +83,7 @@ describe('Document navigation', () => {
expect(links.length).toEqual(1);
expect(links[0].target).toEqual(
commandAsURI(
CREATE_NOTE_COMMAND.forPlaceholder('a placeholder', {
CREATE_NOTE_COMMAND.forPlaceholder('a placeholder', '.md', {
onFileExists: 'open',
})
)

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,
@@ -164,9 +161,13 @@ export class NavigationProvider
return targets
.filter(o => o.target.isPlaceholder()) // links to resources are managed by the definition provider
.map(o => {
const command = CREATE_NOTE_COMMAND.forPlaceholder(o.target.path, {
onFileExists: 'open',
});
const command = CREATE_NOTE_COMMAND.forPlaceholder(
o.target.path,
this.workspace.defaultExtension,
{
onFileExists: 'open',
}
);
const documentLink = new vscode.DocumentLink(
new vscode.Range(
@@ -182,5 +183,3 @@ export class NavigationProvider
});
}
}
export default feature;

View File

@@ -1,144 +0,0 @@
import * as vscode from 'vscode';
import { groupBy } from 'lodash';
import { URI } from '../../core/model/uri';
import { getNoteTooltip, isNone } from '../../utils';
import { FoamFeature } from '../../types';
import { ResourceTreeItem } from '../../utils/grouped-resources-tree-data-provider';
import { Foam } from '../../core/model/foam';
import { FoamWorkspace } from '../../core/model/workspace';
import { FoamGraph } from '../../core/model/graph';
import { Resource, ResourceLink } from '../../core/model/note';
import { Range } from '../../core/model/range';
import { fromVsCodeUri, toVsCodeUri } from '../../utils/vsc-utils';
const feature: FoamFeature = {
activate: async (
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) => {
const foam = await foamPromise;
const provider = new BacklinksTreeDataProvider(foam.workspace, foam.graph);
vscode.window.onDidChangeActiveTextEditor(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;
export class BacklinksTreeDataProvider
implements vscode.TreeDataProvider<BacklinkPanelTreeItem>
{
public target?: URI = undefined;
// prettier-ignore
private _onDidChangeTreeDataEmitter = new vscode.EventEmitter<BacklinkPanelTreeItem | undefined | void>();
readonly onDidChangeTreeData = this._onDidChangeTreeDataEmitter.event;
constructor(private workspace: FoamWorkspace, private graph: FoamGraph) {}
refresh(): void {
this._onDidChangeTreeDataEmitter.fire();
}
getTreeItem(item: BacklinkPanelTreeItem): vscode.TreeItem {
return item;
}
getChildren(item?: ResourceTreeItem): Promise<BacklinkPanelTreeItem[]> {
const uri = this.target;
if (item) {
const resource = item.resource;
const backlinkRefs = Promise.all(
resource.links
.filter(link =>
this.workspace.resolveLink(resource, link).asPlain().isEqual(uri)
)
.map(async link => {
const item = new BacklinkTreeItem(resource, link);
const lines = (
(await this.workspace.readAsMarkdown(resource.uri)) ?? ''
).split('\n');
if (link.range.start.line < lines.length) {
const line = lines[link.range.start.line];
const start = Math.max(0, link.range.start.character - 15);
const ellipsis = start === 0 ? '' : '...';
item.label = `${link.range.start.line}: ${ellipsis}${line.substr(
start,
300
)}`;
item.tooltip = getNoteTooltip(line);
}
return item;
})
);
return backlinkRefs;
}
if (isNone(uri) || isNone(this.workspace.find(uri))) {
return Promise.resolve([]);
}
const backlinksByResourcePath = groupBy(
this.graph
.getConnections(uri)
.filter(c => c.target.asPlain().isEqual(uri)),
b => b.source.path
);
const resources = Object.keys(backlinksByResourcePath)
.map(res => backlinksByResourcePath[res][0].source)
.map(uri => this.workspace.get(uri))
.sort(Resource.sortByTitle)
.map(note => {
const connections = backlinksByResourcePath[note.uri.path].sort(
(a, b) => Range.isBefore(a.link.range, b.link.range)
);
const item = new ResourceTreeItem(
note,
this.workspace,
vscode.TreeItemCollapsibleState.Expanded
);
item.description = `(${connections.length}) ${item.description}`;
return item;
});
return Promise.resolve(resources);
}
resolveTreeItem(item: BacklinkPanelTreeItem): Promise<BacklinkPanelTreeItem> {
return item.resolveTreeItem();
}
}
export class BacklinkTreeItem extends vscode.TreeItem {
constructor(
public readonly resource: Resource,
public readonly link: ResourceLink
) {
super(link.rawText, vscode.TreeItemCollapsibleState.None);
this.label = `${link.range.start.line}: ${this.label}`;
this.command = {
command: 'vscode.open',
arguments: [toVsCodeUri(resource.uri), { selection: link.range }],
title: 'Go to link',
};
}
resolveTreeItem(): Promise<BacklinkTreeItem> {
return Promise.resolve(this);
}
}
type BacklinkPanelTreeItem = ResourceTreeItem | BacklinkTreeItem;

View File

@@ -6,12 +6,13 @@ import {
createNote,
getUriInWorkspace,
} from '../../test/test-utils-vscode';
import { BacklinksTreeDataProvider, BacklinkTreeItem } from './backlinks';
import { ResourceTreeItem } from '../../utils/grouped-resources-tree-data-provider';
import { OPEN_COMMAND } from '../commands/open-resource';
import { toVsCodeUri } from '../../utils/vsc-utils';
import { ConnectionsTreeDataProvider } from './connections';
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';
describe('Backlinks panel', () => {
beforeAll(async () => {
@@ -20,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');
@@ -47,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));
@@ -73,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,
@@ -81,34 +84,45 @@ 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]
)) as BacklinkTreeItem[];
expect(linksFromB.map(l => l.link)).toEqual(
noteB.links.sort(
(a, b) => a.range.start.character - b.range.start.character
)
)) as ResourceRangeTreeItem[];
expect(linksFromB.map(l => l.range)).toEqual(
noteB.links
.map(l => l.range)
.sort((a, b) => a.start.character - b.start.character)
);
});
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: OPEN_COMMAND.command,
arguments: [expect.objectContaining({ uri: noteB.uri })],
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]
)) as BacklinkTreeItem[];
)) as ResourceRangeTreeItem[];
expect(linksFromB[0].command).toMatchObject({
command: 'vscode.open',
arguments: [
noteB.uri,
expect.objectContaining({ path: noteB.uri.path }),
{
selection: expect.arrayContaining([]),
},
@@ -118,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);
@@ -127,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);
@@ -136,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

@@ -0,0 +1,171 @@
import * as vscode from 'vscode';
import { URI } from '../../core/model/uri';
import { isNone } from '../../utils';
import { Foam } from '../../core/model/foam';
import { FoamWorkspace } from '../../core/model/workspace';
import { Connection, FoamGraph } from '../../core/model/graph';
import { Range } from '../../core/model/range';
import { ContextMemento, fromVsCodeUri } from '../../utils/vsc-utils';
import {
BaseTreeItem,
ResourceRangeTreeItem,
ResourceTreeItem,
UriTreeItem,
createConnectionItemsForResource,
} from './utils/tree-view-utils';
import { BaseTreeProvider } from './utils/base-tree-provider';
export default async function activate(
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) {
const foam = await foamPromise;
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;
const updateTreeView = async () => {
provider.target = vscode.window.activeTextEditor
? fromVsCodeUri(vscode.window.activeTextEditor?.document.uri)
: undefined;
await provider.refresh();
};
updateTreeView();
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<'all links' | 'backlinks' | 'forward links'>(
this.state,
`foam-vscode.views.connections.show`,
'all links',
true
);
public target?: URI = undefined;
public nValues = 0;
private connectionItems: ResourceRangeTreeItem[] = [];
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:all-links`,
() => {
this.show.update('all links');
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:forward-links`,
() => {
this.show.update('forward links');
this.refresh();
}
)
);
}
async refresh(): Promise<void> {
const uri = this.target;
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() === 'all links' ||
(isBacklink && this.show.get() === 'backlinks') ||
(!isBacklink && this.show.get() === 'forward 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();
}
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);
}
resourceItems.sort((a, b) => a.label.localeCompare(b.label));
return resourceItems;
}
}
type BacklinkPanelTreeItem = ResourceTreeItem | ResourceRangeTreeItem;

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

@@ -1,5 +1,6 @@
export { default as backlinks } from './backlinks';
export { default as backlinks } from './connections';
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,171 @@
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 (
item &&
!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;
};
res.description =
value.uri.getName().toLocaleLowerCase() ===
value.title.toLocaleLowerCase()
? undefined
: value.uri.getBasename();
return res;
}
}

View File

@@ -2,60 +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,
ResourceTreeItem,
UriTreeItem,
} from '../../utils/grouped-resources-tree-data-provider';
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',
() =>
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);
},
matcher
);
provider.setGroupBy(getOrphansConfig().groupBy);
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,
});
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.commands,
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,48 +2,120 @@ 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,
UriTreeItem,
} from '../../utils/grouped-resources-tree-data-provider';
createBacklinkItemsForResource,
groupRangesByResource,
} 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 GroupedResourcesTreeDataProvider(
'placeholders',
'placeholder',
() => foam.graph.getAllNodes().filter(uri => uri.isPlaceholder()),
uri => {
return new UriTreeItem(uri);
},
matcher
);
provider.setGroupBy(getPlaceholdersConfig().groupBy);
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})`;
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.commands,
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();
treeView.title = baseTitle + ` (${provider.numElements})`;
})
);
},
};
}
})
);
}
export default feature;
export class PlaceholderTreeView extends GroupedResourcesTreeDataProvider {
public show = new ContextMemento<'all' | 'for-current-file'>(
this.state,
`foam-vscode.views.${this.providerId}.show`,
'all'
);
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`,
() => {
this.show.update('all');
this.refresh();
}
),
vscode.commands.registerCommand(
`foam-vscode.views.${this.providerId}.show:for-current-file`,
() => {
this.show.update('for-current-file');
this.refresh();
}
)
);
}
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
? this.graph
.getLinks(fromVsCodeUri(currentFile))
.map(link => link.target)
.filter(uri => uri.isPlaceholder())
: [];
}
return this.graph.getAllNodes().filter(uri => uri.isPlaceholder());
}
}

View File

@@ -1,65 +1,49 @@
import {
createTestNote,
readFileFromFs,
TEST_DATA_DIR,
} from '../../test/test-utils';
import { createTestNote } from '../../test/test-utils';
import { cleanWorkspace, closeEditors } from '../../test/test-utils-vscode';
import { TagItem, TagReference, TagsProvider } from './tags-explorer';
import { bootstrap, Foam } from '../../core/model/foam';
import { MarkdownResourceProvider } from '../../core/services/markdown-provider';
import { createMarkdownParser } from '../../core/services/markdown-parser';
import { URI } from '../../core/model/uri';
import { FileDataStore, Matcher } from '../../test/test-datastore';
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';
describe('Tags tree panel', () => {
let _foam: Foam;
let provider: TagsProvider;
const dataStore = new FileDataStore(readFileFromFs, TEST_DATA_DIR.toFsPath());
const matcher = new Matcher([URI.file(TEST_DATA_DIR.toFsPath())]);
const parser = createMarkdownParser();
const mdProvider = new MarkdownResourceProvider(dataStore, parser);
beforeAll(async () => {
await cleanWorkspace();
});
afterAll(async () => {
_foam.dispose();
await cleanWorkspace();
});
beforeEach(async () => {
_foam = await bootstrap(matcher, undefined, dataStore, parser, [
mdProvider,
]);
provider = new TagsProvider(_foam, _foam.workspace);
await closeEditors();
});
afterEach(() => {
_foam.dispose();
});
it('correctly provides a tag from a set of notes', async () => {
it('provides a tag from a set of notes', async () => {
const noteA = createTestNote({
tags: ['test'],
uri: './note-a.md',
});
_foam.workspace.set(noteA);
const workspace = new FoamWorkspace().set(noteA);
const foamTags = FoamTags.fromWorkspace(workspace);
const provider = new TagsProvider(foamTags, workspace);
provider.refresh();
const treeItems = (await provider.getChildren()) as TagItem[];
treeItems.forEach(item => expect(item.tag).toContain('test'));
expect(treeItems).toHaveLength(1);
expect(treeItems[0].label).toEqual('test');
expect(treeItems[0].tag).toEqual('test');
expect(treeItems[0].nResourcesInSubtree).toEqual(1);
});
it('correctly handles a parent and child tag', async () => {
it('handles a simple parent and child tag', async () => {
const noteA = createTestNote({
tags: ['parent/child'],
uri: './note-a.md',
});
_foam.workspace.set(noteA);
const workspace = new FoamWorkspace().set(noteA);
const foamTags = FoamTags.fromWorkspace(workspace);
const provider = new TagsProvider(foamTags, workspace);
provider.refresh();
const parentTreeItems = (await provider.getChildren()) as TagItem[];
@@ -78,17 +62,18 @@ describe('Tags tree panel', () => {
});
});
it('correctly handles a single parent and multiple child tag', async () => {
it('handles a single parent and multiple child tag', async () => {
const noteA = createTestNote({
tags: ['parent/child'],
uri: './note-a.md',
});
_foam.workspace.set(noteA);
const noteB = createTestNote({
tags: ['parent/subchild'],
uri: './note-b.md',
});
_foam.workspace.set(noteB);
const workspace = new FoamWorkspace().set(noteA).set(noteB);
const foamTags = FoamTags.fromWorkspace(workspace);
const provider = new TagsProvider(foamTags, workspace);
provider.refresh();
const parentTreeItems = (await provider.getChildren()) as TagItem[];
@@ -114,14 +99,15 @@ describe('Tags tree panel', () => {
expect(childTreeItems).toHaveLength(3);
});
it('correctly handles a single parent and child tag in the same note', async () => {
it('handles a parent and child tag in the same note', async () => {
const noteC = createTestNote({
tags: ['main', 'main/subtopic'],
title: 'Test note',
uri: './note-c.md',
});
_foam.workspace.set(noteC);
const workspace = new FoamWorkspace().set(noteC);
const foamTags = FoamTags.fromWorkspace(workspace);
const provider = new TagsProvider(foamTags, workspace);
provider.refresh();
@@ -137,9 +123,9 @@ describe('Tags tree panel', () => {
)) as TagItem[];
childTreeItems
.filter(item => item instanceof TagReference)
.filter(item => item instanceof ResourceTreeItem)
.forEach(item => {
expect(item.title).toEqual('Test note');
expect(item.label).toEqual('Test note');
});
childTreeItems
@@ -151,4 +137,36 @@ describe('Tags tree panel', () => {
expect(childTreeItems).toHaveLength(3);
});
it('handles a tag with multiple levels of hierarchy - #1134', async () => {
const noteA = createTestNote({
tags: ['parent/child/second'],
uri: './note-a.md',
});
const workspace = new FoamWorkspace().set(noteA);
const foamTags = FoamTags.fromWorkspace(workspace);
const provider = new TagsProvider(foamTags, workspace);
provider.refresh();
const parentTreeItems = (await provider.getChildren()) as TagItem[];
const parentTagItem = parentTreeItems.pop();
expect(parentTagItem.title).toEqual('parent');
const childTreeItems = (await provider.getChildren(
parentTagItem
)) as TagItem[];
expect(childTreeItems).toHaveLength(2);
expect(childTreeItems[0].label).toMatch(/^Search.*/);
expect(childTreeItems[1].label).toEqual('child');
const grandchildTreeItems = (await provider.getChildren(
childTreeItems[1]
)) as TagItem[];
expect(grandchildTreeItems).toHaveLength(2);
expect(grandchildTreeItems[0].label).toMatch(/^Search.*/);
expect(grandchildTreeItems[1].label).toEqual('second');
});
});

View File

@@ -1,38 +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';
const TAG_SEPARATOR = '/';
const feature: FoamFeature = {
activate: async (
context: vscode.ExtensionContext,
foamPromise: Promise<Foam>
) => {
const foam = await foamPromise;
const provider = new TagsProvider(foam, 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
@@ -48,7 +46,10 @@ export class TagsProvider implements vscode.TreeDataProvider<TagTreeItem> {
notes: URI[];
}[];
constructor(private foam: Foam, private workspace: FoamWorkspace) {
private foamTags: FoamTags;
constructor(tags: FoamTags, private workspace: FoamWorkspace) {
this.foamTags = tags;
this.computeTags();
}
@@ -58,7 +59,7 @@ export class TagsProvider implements vscode.TreeDataProvider<TagTreeItem> {
}
private computeTags() {
this.tags = [...this.foam.tags.tags]
this.tags = [...this.foamTags.tags]
.map(([tag, notes]) => ({ tag, notes }))
.sort((a, b) => a.tag.localeCompare(b.tag));
}
@@ -67,78 +68,93 @@ export class TagsProvider implements vscode.TreeDataProvider<TagTreeItem> {
return element;
}
getChildren(element?: TagItem): Promise<TagTreeItem[]> {
if (element) {
const nestedTagItems: TagTreeItem[] = this.tags
.filter(item => item.tag.indexOf(element.title + TAG_SEPARATOR) > -1)
.map(
item =>
new TagItem(
item.tag,
item.tag.substring(item.tag.indexOf(TAG_SEPARATOR) + 1),
item.notes
)
)
.sort((a, b) => a.title.localeCompare(b.title));
const references: TagTreeItem[] = element.notes
.map(uri => this.foam.workspace.get(uri))
.reduce((acc, note) => {
const tags = note.tags.filter(t => t.label === element.tag);
return [
...acc,
...tags.slice(0, 1).map(t => new TagReference(t, note)),
];
}, [])
.sort((a, b) => a.title.localeCompare(b.title));
return Promise.resolve([
new TagSearch(element.tag),
...nestedTagItems,
...references,
]);
async getChildren(element?: TagItem): Promise<TagTreeItem[]> {
if ((element as any)?.getChildren) {
const children = await (element as any).getChildren();
return children;
}
if (!element) {
const tags: TagItem[] = this.tags
.map(({ tag, notes }) => {
const parentTag =
tag.indexOf(TAG_SEPARATOR) > 0
? tag.substring(0, tag.indexOf(TAG_SEPARATOR))
: tag;
const parentTag = element ? element.tag : '';
const parentPrefix = element ? parentTag + TAG_SEPARATOR : '';
return new TagItem(parentTag, parentTag, notes);
})
.filter(
(value, index, array) =>
array.findIndex(tag => tag.title === value.title) === index
const tagsAtThisLevel = this.tags
.filter(({ tag }) => tag.startsWith(parentPrefix))
.map(({ tag }) => {
const nextSeparator = tag.indexOf(TAG_SEPARATOR, parentPrefix.length);
const label =
nextSeparator > -1
? tag.substring(parentPrefix.length, nextSeparator)
: tag.substring(parentPrefix.length);
const tagId = parentPrefix + label;
return { label, tagId, tag };
})
.reduce((acc, { label, tagId, tag }) => {
const existing = acc.has(label);
const nResources = this.foamTags.tags.get(tag).length ?? 0;
if (!existing) {
acc.set(label, { label, tagId, nResources: 0 });
}
acc.get(label).nResources += nResources;
return acc;
}, new Map() as Map<string, { label: string; tagId: string; nResources: number }>);
const subtags = Array.from(tagsAtThisLevel.values())
.map(({ label, tagId, nResources }) => {
const resources = this.foamTags.tags.get(tagId) ?? [];
return new TagItem(tagId, label, nResources, resources);
})
.sort((a, b) => a.title.localeCompare(b.title));
const resourceTags: ResourceRangeTreeItem[] = (element?.notes ?? [])
.map(uri => this.workspace.get(uri))
.reduce((acc, note) => {
const tags = note.tags.filter(t => t.label === element.tag);
const items = tags.map(t =>
ResourceRangeTreeItem.createStandardItem(
this.workspace,
note,
t.range,
'tag'
)
);
return [...acc, ...items];
}, []);
return Promise.resolve(tags.sort((a, b) => a.tag.localeCompare(b.tag)));
}
const resources = await groupRangesByResource(this.workspace, resourceTags);
return Promise.resolve(
[element && new TagSearch(element.tag), ...subtags, ...resources].filter(
Boolean
)
);
}
async resolveTreeItem(item: TagTreeItem): Promise<TagTreeItem> {
if (item instanceof TagReference) {
const content = await this.workspace.readAsMarkdown(item.note.uri);
if (isSome(content)) {
item.tooltip = getNoteTooltip(content);
}
if (
item instanceof ResourceTreeItem ||
item instanceof ResourceRangeTreeItem
) {
return item.resolveTreeItem();
}
return item;
return Promise.resolve(item);
}
}
type TagTreeItem = TagItem | TagReference | TagSearch;
type TagTreeItem =
| TagItem
| TagSearch
| ResourceTreeItem
| ResourceRangeTreeItem;
export class TagItem extends vscode.TreeItem {
constructor(
public readonly tag: string,
public readonly title: string,
public readonly nResourcesInSubtree: number,
public readonly notes: URI[]
) {
super(title, vscode.TreeItemCollapsibleState.Collapsed);
this.description = `${this.notes.length} reference${
this.notes.length !== 1 ? 's' : ''
this.description = `${nResourcesInSubtree} reference${
nResourcesInSubtree !== 1 ? 's' : ''
}`;
}
@@ -169,28 +185,3 @@ export class TagSearch extends vscode.TreeItem {
iconPath = new vscode.ThemeIcon('search');
contextValue = 'tag-search';
}
export class TagReference extends vscode.TreeItem {
public readonly title: string;
constructor(public readonly tag: Tag, public readonly note: Resource) {
super(note.title, vscode.TreeItemCollapsibleState.None);
const uri = toVsCodeUri(note.uri);
this.title = note.title;
this.description = vscode.workspace.asRelativePath(uri);
this.tooltip = undefined;
this.command = {
command: 'vscode.open',
arguments: [
uri,
{
preview: true,
selection: toVsCodeRange(tag.range),
},
],
title: 'Open File',
};
}
iconPath = new vscode.ThemeIcon('note');
contextValue = 'reference';
}

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

@@ -95,7 +95,7 @@ describe('Tag Completion', () => {
});
it('should not provide suggestions when inside a markdown heading #1182', async () => {
const { uri } = await createFile('# primary heading 1');
const { uri } = await createFile('# primary');
const { doc } = await showInEditor(uri);
const provider = new TagCompletionProvider(foamTags);
@@ -107,4 +107,260 @@ describe('Tag Completion', () => {
expect(foamTags.tags.get('primary')).toBeTruthy();
expect(tags).toBeNull();
});
describe('has robust triggering #1189', () => {
it('should provide multiple suggestions when typing #', async () => {
const { uri } = await createFile(`# Title
#`);
const { doc } = await showInEditor(uri);
const provider = new TagCompletionProvider(foamTags);
const tags = await provider.provideCompletionItems(
doc,
new vscode.Position(2, 1)
);
expect(tags.items.length).toEqual(3);
});
it('should provide multiple suggestions when typing # on line with match', async () => {
const { uri } = await createFile('Here is #my-tag and #');
const { doc } = await showInEditor(uri);
const provider = new TagCompletionProvider(foamTags);
const tags = await provider.provideCompletionItems(
doc,
new vscode.Position(0, 21)
);
expect(tags.items.length).toEqual(3);
});
it('should provide multiple suggestions when typing # at EOL', async () => {
const { uri } = await createFile(`# Title
#
more text
`);
const { doc } = await showInEditor(uri);
const provider = new TagCompletionProvider(foamTags);
const tags = await provider.provideCompletionItems(
doc,
new vscode.Position(2, 1)
);
expect(tags.items.length).toEqual(3);
});
it('should not provide a suggestion when typing `# `', async () => {
const { uri } = await createFile(`# Title
# `);
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('primary')).toBeTruthy();
expect(tags).toBeNull();
});
it('should not provide a suggestion when typing `#{non-match}`', async () => {
const { uri } = await createFile(`# Title
#$`);
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('primary')).toBeTruthy();
expect(tags).toBeNull();
});
it('should not provide a suggestion when typing `##`', async () => {
const { uri } = await createFile(`# Title
##`);
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('primary')).toBeTruthy();
expect(tags).toBeNull();
});
it('should not provide a suggestion when typing `# ` in a line that already matched', async () => {
const { uri } = await createFile('here is #primary and now # ');
const { doc } = await showInEditor(uri);
const provider = new TagCompletionProvider(foamTags);
const tags = await provider.provideCompletionItems(
doc,
new vscode.Position(0, 29)
);
expect(foamTags.tags.get('primary')).toBeTruthy();
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,25 +1,27 @@
import * as vscode from 'vscode';
import { Foam } from '../core/model/foam';
import { FoamTags } from '../core/model/tags';
import { HASHTAG_REGEX } from '../core/utils/hashtags';
import { FoamFeature } from '../types';
import { mdDocSelector } from '../utils';
import { isInFrontMatter, isOnYAMLKeywordLine, mdDocSelector } from '../utils';
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),
'#'
)
);
},
};
// this regex is different from HASHTAG_REGEX in that it does not look for a
// #+character. It uses a negative look-ahead for `# `
const HASH_REGEX =
/(?<=^|\s)#(?![ \t#])([0-9]*[\p{L}\p{Emoji_Presentation}\p{N}/_-]*)/dgu;
const MAX_LINES_FOR_FRONT_MATTER = 50;
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>
@@ -34,12 +36,96 @@ export class TagCompletionProvider
.lineAt(position)
.text.substr(0, position.character);
const requiresAutocomplete = cursorPrefix.match(HASHTAG_REGEX);
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
)
)
);
if (!requiresAutocomplete) {
const isHashMatch = cursorPrefix.match(HASH_REGEX) !== null;
const inFrontMatter = isInFrontMatter(beginningOfFileText, position.line);
if (!isHashMatch && !inFrontMatter) {
return null;
}
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(
@@ -52,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,
@@ -25,20 +24,21 @@ interface FoamCommand<T> {
interface FindIdentifierCommandArgs {
range: vscode.Range;
target: vscode.Uri;
defaultExtension: string;
amongst: vscode.Uri[];
}
const FIND_IDENTIFER_COMMAND: FoamCommand<FindIdentifierCommandArgs> = {
const FIND_IDENTIFIER_COMMAND: FoamCommand<FindIdentifierCommandArgs> = {
name: 'foam:compute-identifier',
execute: async ({ target, amongst, range }) => {
execute: async ({ target, amongst, range, defaultExtension }) => {
if (vscode.window.activeTextEditor) {
let identifier = FoamWorkspace.getShortestIdentifier(
target.path,
amongst.map(uri => uri.path)
);
identifier = identifier.endsWith('.md')
? identifier.slice(0, -3)
identifier = identifier.endsWith(defaultExtension)
? identifier.slice(0, defaultExtension.length * -1)
: identifier;
await vscode.window.activeTextEditor.edit(builder => {
@@ -62,59 +62,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(foam.workspace.defaultExtension),
{
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,
@@ -196,6 +194,8 @@ export class IdentifierResolver implements vscode.CodeActionProvider {
vscode.CodeActionKind.QuickFix,
];
constructor(private defaultExtension: string) {}
provideCodeActions(
document: vscode.TextDocument,
range: vscode.Range | vscode.Selection,
@@ -210,7 +210,12 @@ export class IdentifierResolver implements vscode.CodeActionProvider {
);
for (const item of diagnostic.relatedInformation) {
res.push(
createFindIdentifierCommand(diagnostic, item.location.uri, uris)
createFindIdentifierCommand(
diagnostic,
item.location.uri,
this.defaultExtension,
uris
)
);
}
return [...acc, ...res];
@@ -260,6 +265,7 @@ const createReplaceSectionCommand = (
const createFindIdentifierCommand = (
diagnostic: vscode.Diagnostic,
target: vscode.Uri,
defaultExtension: string,
possibleTargets: vscode.Uri[]
): vscode.CodeAction => {
const action = new vscode.CodeAction(
@@ -267,12 +273,13 @@ const createFindIdentifierCommand = (
vscode.CodeActionKind.QuickFix
);
action.command = {
command: FIND_IDENTIFER_COMMAND.name,
command: FIND_IDENTIFIER_COMMAND.name,
title: 'Link to this resource',
arguments: [
{
target: target,
amongst: possibleTargets,
defaultExtension: defaultExtension,
range: new vscode.Range(
diagnostic.range.start.line,
diagnostic.range.start.character + 2,
@@ -285,5 +292,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

@@ -1,4 +1,4 @@
import { Selection, ViewColumn, window } from 'vscode';
import { Selection, Uri, ViewColumn, window, workspace } from 'vscode';
import { fromVsCodeUri } from '../utils/vsc-utils';
import { NoteFactory } from '../services/templates';
import {
@@ -7,6 +7,7 @@ import {
deleteFile,
getUriInWorkspace,
showInEditor,
withModifiedFoamConfiguration,
} from '../test/test-utils-vscode';
import { Resolver } from './variable-resolver';
import { fileExists } from './editor';
@@ -19,6 +20,56 @@ describe('Create note from template', () => {
});
describe('User flow', () => {
it('should resolve the path using the config when path is derived from note title', async () => {
const templateA = await createFile('Template A', [
'.foam',
'templates',
'template-a.md',
]);
jest
.spyOn(window, 'showInputBox')
.mockImplementation(jest.fn(() => Promise.resolve('Title of note')));
const noteA = await createFile('Note A', [
'path',
'of-new-note',
'note-a.md',
]);
await showInEditor(noteA.uri);
await withModifiedFoamConfiguration(
'files.newNotePath',
'currentDir',
async () => {
const result = await NoteFactory.createFromTemplate(
templateA.uri,
new Resolver(new Map(), new Date())
);
expect(result.uri.path).toEqual(
noteA.uri.getDirectory().joinPath('Title of note.md').path
);
await deleteFile(result.uri);
}
);
await withModifiedFoamConfiguration(
'files.newNotePath',
'root',
async () => {
const result = await NoteFactory.createFromTemplate(
templateA.uri,
new Resolver(new Map(), new Date())
);
expect(result.uri.path).toEqual(
Uri.joinPath(workspace.workspaceFolders[0].uri, 'Title of note.md')
.path
);
await deleteFile(result.uri);
}
);
await deleteFile(noteA);
await deleteFile(templateA);
});
it('should ask a user to confirm the path if note already exists', async () => {
const templateA = await createFile('Template A', [
'.foam',

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';
/**
@@ -351,13 +350,14 @@ export const NoteFactory = {
let newFilePath = template.metadata.has('filepath')
? URI.file(template.metadata.get('filepath'))
: isSome(filepathFallbackURI)
? filepathFallbackURI
: await getPathFromTitle(resolver);
: filepathFallbackURI;
if (!newFilePath.path.startsWith('./')) {
if (isNone(newFilePath)) {
newFilePath = await getPathFromTitle(resolver);
} else if (!newFilePath.path.startsWith('./')) {
newFilePath = asAbsoluteWorkspaceUri(newFilePath);
}
return NoteFactory.createNote(
newFilePath,
template.text,
@@ -475,30 +475,7 @@ async function askUserForFilepathConfirmation(
});
}
/**
* Common chars that is better to avoid in file names.
* Inspired by:
* https://www.mtu.edu/umc/services/websites/writing/characters-avoid/
* https://stackoverflow.com/questions/1976007/what-characters-are-forbidden-in-windows-and-linux-directory-names
* Even if some might be allowed in Win or Linux, to keep things more compatible and less error prone
* we don't allow them
* Also see https://github.com/foambubble/foam/issues/1042
*/
const UNALLOWED_CHARS = '/\\#%&{}<>?*$!\'":@+`|=';
/**
* Uses the title to generate a file path.
* It sanitizes the title to remove special characters and spaces.
*
* @param resolver the resolver to use
* @returns the string path of the new note
*/
export const getPathFromTitle = async (resolver: Resolver) => {
let defaultName = await resolver.resolveFromName('FOAM_TITLE');
UNALLOWED_CHARS.split('').forEach(char => {
defaultName = defaultName.split(char).join('');
});
const defaultFilepath = URI.file(`${defaultName}.md`);
return defaultFilepath;
const defaultName = await resolver.resolveFromName('FOAM_TITLE_SAFE');
return URI.file(`${defaultName}.md`);
};

View File

@@ -102,6 +102,23 @@ describe('variable-resolver, variable resolution', () => {
expect(await resolver.resolveAll(variables)).toEqual(expected);
});
it('should resolve FOAM_TITLE_SAFE', async () => {
const foamTitle = 'My/note#title';
const variables = [
new Variable('FOAM_TITLE'),
new Variable('FOAM_TITLE_SAFE'),
];
const expected = new Map<string, string>();
expected.set('FOAM_TITLE', foamTitle);
expected.set('FOAM_TITLE_SAFE', 'My-note-title');
const givenValues = new Map<string, string>();
givenValues.set('FOAM_TITLE', foamTitle);
const resolver = new Resolver(givenValues, new Date());
expect(await resolver.resolveAll(variables)).toEqual(expected);
});
it('should resolve FOAM_DATE_* properties with current day by default', async () => {
const variables = [
new Variable('FOAM_DATE_YEAR'),

View File

@@ -10,6 +10,7 @@ import {
const knownFoamVariables = new Set([
'FOAM_TITLE',
'FOAM_TITLE_SAFE',
'FOAM_SLUG',
'FOAM_SELECTED_TEXT',
'FOAM_DATE_YEAR',
@@ -132,6 +133,9 @@ export class Resolver implements VariableResolver {
case 'FOAM_TITLE':
value = resolveFoamTitle();
break;
case 'FOAM_TITLE_SAFE':
value = resolveFoamTitleSafe(this);
break;
case 'FOAM_SLUG':
value = toSlug(await this.resolve(new Variable('FOAM_TITLE')));
break;
@@ -242,3 +246,29 @@ async function resolveFoamTitle() {
function resolveFoamSelectedText() {
return findSelectionContent()?.content ?? '';
}
/**
* Common chars that is better to avoid in file names.
* Inspired by:
* https://www.mtu.edu/umc/services/websites/writing/characters-avoid/
* https://stackoverflow.com/questions/1976007/what-characters-are-forbidden-in-windows-and-linux-directory-names
* Even if some might be allowed in Win or Linux, to keep things more compatible and less error prone
* we don't allow them
* Also see https://github.com/foambubble/foam/issues/1042
*/
const UNALLOWED_CHARS = '/\\#%&{}<>?*$!\'":@+`|=';
/**
* Uses the title to generate a file path.
* It sanitizes the title to remove special characters and spaces.
*
* @param resolver the resolver to use
* @returns the string path of the new note
*/
export const resolveFoamTitleSafe = async (resolver: Resolver) => {
let safeTitle = await resolver.resolveFromName('FOAM_TITLE');
UNALLOWED_CHARS.split('').forEach(char => {
safeTitle = safeTitle.split(char).join('-');
});
return safeTitle;
};

View File

@@ -0,0 +1,32 @@
import { getNotesExtensions } from './settings';
import { withModifiedFoamConfiguration } from './test/test-utils-vscode';
describe('Default note settings', () => {
it('should default to .md', async () => {
const config = getNotesExtensions();
expect(config.defaultExtension).toEqual('.md');
expect(config.notesExtensions).toEqual(['.md']);
});
it('should always include the default note extension in the list of notes extensions', async () => {
withModifiedFoamConfiguration(
'files.defaultNoteExtension',
'mdxx',
async () => {
const { notesExtensions } = getNotesExtensions();
expect(notesExtensions).toEqual(['.mdxx']);
withModifiedFoamConfiguration(
'files.notesExtensions',
'md markdown',
async () => {
const { notesExtensions } = getNotesExtensions();
expect(notesExtensions).toEqual(
expect.arrayContaining(['.mdxx', '.md', '.markdown'])
);
}
);
}
);
});
});

View File

@@ -1,24 +1,57 @@
import { workspace, GlobPattern } from 'vscode';
import { uniq } from 'lodash';
import { LogLevel } from './core/utils/log';
import { getFoamVsCodeConfig } from './services/config';
export enum LinkReferenceDefinitionsSetting {
withExtensions = 'withExtensions',
withoutExtensions = 'withoutExtensions',
off = 'off',
/**
* Gets the notes extensions and default extension from the config.
*
* @returns {notesExtensions: string[], defaultExtension: string}
*/
export function getNotesExtensions() {
const notesExtensionsFromSetting = getFoamVsCodeConfig(
'files.notesExtensions',
''
)
.split(' ')
.filter(ext => ext.trim() !== '')
.map(ext => '.' + ext.trim());
const defaultExtension =
'.' +
(getFoamVsCodeConfig('files.defaultNoteExtension', 'md') ?? 'md').trim();
// we make sure that the default extension is always included in the list of extensions
const notesExtensions = uniq(
notesExtensionsFromSetting.concat(defaultExtension)
);
return { notesExtensions, defaultExtension };
}
export function getWikilinkDefinitionSetting(): LinkReferenceDefinitionsSetting {
/**
* Gets the attachment extensions from the config.
*
* @returns string[]
*/
export function getAttachmentsExtensions() {
return getFoamVsCodeConfig('files.attachmentExtensions', '')
.split(' ')
.map(ext => '.' + ext.trim());
}
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. */
export function getIgnoredFilesSetting(): GlobPattern[] {
return [
'**/.foam/**',
...workspace.getConfiguration().get('foam.files.ignore', []),
...Object.keys(workspace.getConfiguration().get('files.exclude', {})),
];
@@ -42,24 +75,16 @@ export function getFoamLoggerLevel(): LogLevel {
export function getOrphansConfig(): GroupedResourcesConfig {
const orphansConfig = workspace.getConfiguration('foam.orphans');
const exclude: string[] = orphansConfig.get('exclude');
const groupBy: GroupedResoucesConfigGroupBy = orphansConfig.get('groupBy');
return { exclude, groupBy };
return { exclude };
}
/** Retrieve the placeholders configuration */
export function getPlaceholdersConfig(): GroupedResourcesConfig {
const placeholderCfg = workspace.getConfiguration('foam.placeholders');
const exclude: string[] = placeholderCfg.get('exclude');
const groupBy: GroupedResoucesConfigGroupBy = placeholderCfg.get('groupBy');
return { exclude, groupBy };
return { exclude };
}
export interface GroupedResourcesConfig {
exclude: string[];
groupBy: GroupedResoucesConfigGroupBy;
}
export enum GroupedResoucesConfigGroupBy {
Folder = 'folder',
Off = 'off',
}

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,186 +0,0 @@
import { FoamWorkspace } from '../core/model/workspace';
import {
AlwaysIncludeMatcher,
SubstringExcludeMatcher,
} from '../core/services/datastore';
import { OPEN_COMMAND } from '../features/commands/open-resource';
import { GroupedResoucesConfigGroupBy } from '../settings';
import { createTestNote } from '../test/test-utils';
import {
DirectoryTreeItem,
GroupedResourcesTreeDataProvider,
UriTreeItem,
} from './grouped-resources-tree-data-provider';
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(
'length3',
'note',
() =>
workspace
.list()
.filter(r => r.title.length === 3)
.map(r => r.uri),
uri => new UriTreeItem(uri),
testMatcher
);
provider.setGroupBy(GroupedResoucesConfigGroupBy.Folder);
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(
'length3',
'note',
() =>
workspace
.list()
.filter(r => r.title.length === 3)
.map(r => r.uri),
uri => new UriTreeItem(uri),
testMatcher
);
provider.setGroupBy(GroupedResoucesConfigGroupBy.Folder);
const directory = new DirectoryTreeItem(
'/path',
[new UriTreeItem(matchingNote1.uri)],
'note'
);
const result = await provider.getChildren(directory);
expect(result).toMatchObject([
{
collapsibleState: 0,
label: 'ABC',
description: '/path/ABC.md',
command: { command: OPEN_COMMAND.command },
},
]);
});
it('should return the flattened resources', async () => {
const provider = new GroupedResourcesTreeDataProvider(
'length3',
'note',
() =>
workspace
.list()
.filter(r => r.title.length === 3)
.map(r => r.uri),
uri => new UriTreeItem(uri),
testMatcher
);
provider.setGroupBy(GroupedResoucesConfigGroupBy.Off);
const result = await provider.getChildren();
expect(result).toMatchObject([
{
collapsibleState: 0,
label: matchingNote1.title,
description: '/path/ABC.md',
command: { command: OPEN_COMMAND.command },
},
{
collapsibleState: 0,
label: matchingNote2.title,
description: '/path-bis/XYZ.md',
command: { command: OPEN_COMMAND.command },
},
]);
});
it('should return the grouped resources without exclusion', async () => {
const provider = new GroupedResourcesTreeDataProvider(
'length3',
'note',
() =>
workspace
.list()
.filter(r => r.title.length === 3)
.map(r => r.uri),
uri => new UriTreeItem(uri),
new AlwaysIncludeMatcher()
);
provider.setGroupBy(GroupedResoucesConfigGroupBy.Folder);
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(
'length3',
description,
() =>
workspace
.list()
.filter(r => r.title.length === 3)
.map(r => r.uri),
uri => new UriTreeItem(uri),
testMatcher
);
provider.setGroupBy(GroupedResoucesConfigGroupBy.Folder);
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,273 +0,0 @@
import * as path from 'path';
import * as vscode from 'vscode';
import { GroupedResoucesConfigGroupBy } from '../settings';
import { getContainsTooltip, getNoteTooltip, isSome } from '../utils';
import { OPEN_COMMAND } from '../features/commands/open-resource';
import { toVsCodeUri } from './vsc-utils';
import { URI } from '../core/model/uri';
import { Resource } from '../core/model/note';
import { FoamWorkspace } from '../core/model/workspace';
import { IMatcher } from '../core/services/datastore';
/**
* 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.group-${providerId}-by-folder
* foam-vscode.group-${providerId}-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>
{
// 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;
// prettier-ignore
private groupBy: GroupedResoucesConfigGroupBy = GroupedResoucesConfigGroupBy.Folder;
private exclude: string[] = [];
private flatUris: Array<URI> = [];
private root = vscode.workspace.workspaceFolders[0].uri.path;
/**
* 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.group-${providerId}-by-folder
* foam-vscode.group-${providerId}-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(
private providerId: string,
private resourceName: string,
private computeResources: () => Array<URI>,
private createTreeItem: (item: URI) => GroupedResourceTreeItem,
private matcher: IMatcher
) {
this.setContext();
this.doComputeResources();
}
public get commands() {
return [
vscode.commands.registerCommand(
`foam-vscode.group-${this.providerId}-by-folder`,
() => this.setGroupBy(GroupedResoucesConfigGroupBy.Folder)
),
vscode.commands.registerCommand(
`foam-vscode.group-${this.providerId}-off`,
() => this.setGroupBy(GroupedResoucesConfigGroupBy.Off)
),
];
}
public get numElements() {
return this.flatUris.length;
}
setGroupBy(groupBy: GroupedResoucesConfigGroupBy): void {
this.groupBy = groupBy;
this.setContext();
this.refresh();
}
private setContext(): void {
vscode.commands.executeCommand(
'setContext',
`foam-vscode.${this.providerId}-grouped-by-folder`,
this.groupBy === GroupedResoucesConfigGroupBy.Folder
);
}
refresh(): void {
this.doComputeResources();
this._onDidChangeTreeData.fire();
}
getTreeItem(item: GroupedResourceTreeItem): vscode.TreeItem {
return item;
}
getChildren(
directory?: DirectoryTreeItem
): Promise<GroupedResourceTreeItem[]> {
if (this.groupBy === GroupedResoucesConfigGroupBy.Folder) {
if (isSome(directory)) {
return Promise.resolve(directory.children.sort(sortByTreeItemLabel));
}
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 UriTreeItem extends vscode.TreeItem {
constructor(
public readonly uri: URI,
options: {
collapsibleState?: vscode.TreeItemCollapsibleState;
icon?: string;
title?: string;
} = {}
) {
super(options?.title ?? uri.getName(), options.collapsibleState);
this.description = uri.path.replace(
vscode.workspace.getWorkspaceFolder(toVsCodeUri(uri))?.uri.path,
''
);
this.tooltip = undefined;
this.command = {
command: OPEN_COMMAND.command,
title: OPEN_COMMAND.title,
arguments: [
{
uri: uri,
},
],
};
this.iconPath = new vscode.ThemeIcon(options.icon ?? 'new-file');
}
resolveTreeItem(): Promise<GroupedResourceTreeItem> {
return Promise.resolve(this);
}
}
export class ResourceTreeItem extends UriTreeItem {
constructor(
public readonly resource: Resource,
private readonly workspace: FoamWorkspace,
collapsibleState = vscode.TreeItemCollapsibleState.None
) {
super(resource.uri, {
title: resource.title,
icon: 'note',
collapsibleState,
});
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 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);
}
}
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,4 +1,4 @@
import { Position, Range, Uri } from 'vscode';
import { Memento, Position, Range, Uri, commands } from 'vscode';
import { Position as FoamPosition } from '../core/model/position';
import { Range as FoamRange } from '../core/model/range';
import { URI as FoamURI } from '../core/model/uri';
@@ -12,3 +12,43 @@ export const toVsCodeRange = (r: FoamRange): Range =>
export const toVsCodeUri = (u: FoamURI): Uri => Uri.parse(u.toString());
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,
resetToDefault: boolean = false
) {
resetToDefault && this.data.update(this.key, defaultValue);
const value = data.get(key) ?? defaultValue;
commands.executeCommand('setContext', this.key, value);
}
public get(): T {
return this.data.get(this.key);
}
public async update(value: T): Promise<void> {
this.data.update(this.key, value);
await commands.executeCommand('setContext', this.key, value);
}
}
/**
* Implementation of the Memento interface that uses a Map as backend
*/
export class MapBasedMemento implements Memento {
get<T>(key: unknown, defaultValue?: unknown | T): T | T {
return (this.map.get(key as string) as T) || (defaultValue as T);
}
private map: Map<string, string> = new Map();
keys(): readonly string[] {
return Array.from(this.map.keys());
}
update(key: string, value: any): Promise<void> {
this.map.set(key, value);
return Promise.resolve();
}
}

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

Some files were not shown because too many files have changed in this diff Show More