Skip to content

uozuAho/note_searcher

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notes searcher

VS code extension for managing a collection of local text files, eg. a zettelkasten.

Features:

  • full text search
  • search by tags
  • shortcuts for creating and linking notes

See the extension readme for more info.

Contributing

Quick start

Install nodejs (see github actions for which version). Then:

cd vscode
npm ci
npm test

Run the extension locally

Open the vscode directory with VS code, and run the Run Extension configuration.

Build the extension locally

Run npm run build_vsix in the vscode directory.

Updating dependencies

Speedrun:

cd vscode
npm outdated
npm update
npm test
npm outdated
# if any major updates available:
npm rm [list] [of] [deps] [to] [update]
npm i -D <same list as above>
npm test
# just in case:
npm audit
# make sure it still builds:
npm run webpack

Understanding the code/architecture

See code explainer

todo

  • bug?
    • search for something
    • edit a doc to contain that something
    • search again
    • expected: edited doc near the top
    • actual: edited doc near the bottom
  • feature: extract text to new note
  • feature: make paths queryable. Eg. i want to exclude ABC from path, but not contents
  • feature(s): pasting links
  • cleanup: replace mocked/other high level tests with acceptance tests
  • feature: suggest tags in search
  • improvement: dead links should navigate to the offending link text

About

Full-text and tag-based searching of arbitrary directories and files

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •