Feature/blank note explorer view #493
Conversation
Creates a new "Blank Note" explorer view which displays all notes that
contain only a title. When note.source.text.trim().split('\n').length
is equal to 1, a note is considered blank. This should mean that the
note contains only a title.
The UX experience is identical to that of the Orphan view. A user can
toggle between both the flat view and a nested view grouped by
directory.
Instead of just copy and pasting the orphans view into blank notes, I created a filtered notes provider, which behaves identically to the old orphan/blank notes providers, but allows the caller to pass in the "filter function" which will narrow down the list of notes in the view. This also allows us to more easily unit test the filtering logic, and only test the flatten / nested logic in one place. It also makes it so that when we refactor the way one of these views works (e.g. adding the markdown preview), we don't have to make changes to the other view.
|
this is interesting @joeltjames
|
I like the idea of combining these two, perhaps we could just merge the name, call this the "Placeholder" view, and then display placeholders in a slightly different format in the list
|
I like this!
Sounds good then, let's see how it plays out. it seems a fair argument to say that a note that is only heading doesn't really have any content, and therefore is just a placeholder |
|
@riccardoferretti I was able to get those changes made. Placeholders and Blank Notes now appear under the "Placeholder"s view. See the attached gif for a preview. The icon for placeholders is the "New File" icon, notes are the same as previous. In the "Nested Directory" view, all placeholders are grouped into a virtual directory called "Not Created". |
Replaced "blank notes" with "placeholders".
- Removed commented lines from packages/foam-vscode/src/features/orphans.test.ts - Removed workspacesFsPaths and replaced with workspacesURIs - Moved to chained array functions to determine what is a placeholder
|
@riccardoferretti, I just pushed a few commits to address your feedback. Thanks for the suggestions. |
There was a problem hiding this comment.
There are some design considerations around the FilteredResourcesProvider class that I have been holding off to share because I wanted to clarify them in my head, but in the end I think are necessary for good integration with the codebase, let me know your thoughts - thanks!
|
@riccardoferretti I think I managed to clean up all of these items. Thanks again. |
packages/foam-vscode/src/utils/grouped-resources-tree-data-provider.test.ts
Outdated
Show resolved
Hide resolved
|
@allcontributors add @joeltjames for code |
|
I've put up a pull request to add @joeltjames! 🎉 |
This PR resolves #491, but creating a new "Placeholder" view.
It also extracts a
FilteredNotesProviderfrom the currentOrphansProvider. This allows us to very easily create explorer views similar to the Orphans and Blank Notes view. The new path for doing this would just require adding the requisite settings, and then adding aFoamFeaturewhich defines the match function.Please let me know if I've missed anything in this code change.