This package provides two commands:
project_notes_open and project_notes_list

---

default settings

{
  "notes_dir_path": "...",
  "note_file_name": "todo",
  "add_note_dir_to_project": true,
  "note_dir_name": "notes"
}

---

project_notes_list

This will display a quickpanel listing the names of projects which have a note named $note_file_name. And open that file upon selection.

project_notes_open

When the command is executed it will open the file:
$notes_dir_path/$PROJECT_NAME/$note_file_name

If there is no project associated with the active window the command will not do anything.

If notes_dir_path is not a path to an existing directory (example: ~/Documents/notes), it will default to: SUBLIME_PACKAGE_PATH/User/notes (~/sublime-text/Packages/User/notes).

If add_note_dir_to_project is set to true the directory containing the note will get added to the current project with the display name defined for note_dir_name.

Why?

I often find myself wanting to keep notes, lists of links and other files related to a project, in its own directory, outside the project, so i don't accidentally commit those files to git.

This simple package makes that workflow seamless.

keybinding

There is no keybindings enabled by default, I personally use Alt+n:

{ "keys": ["alt+n"], "command": "project_notes_open" }
{ "keys": ["alt+shift+n"], "command": "project_notes_list" }

contact

bug/issues/enhancements:
https://github.com/budlime/ProjectNotes

license

0BSD