[feature]: add config and improving extension naming

Kyonru · Kyonru · commit 3fd71b5058ae · 2026-01-02T01:30:02.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,4 +6,17 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 ## [Unreleased]
 
-- Initial release
+## [v0.2.0] - 2025-08-10
+
+- Add search notes
+- Add change notes directory
+- Add keybindings
+- Add Icon
+
+## [v0.1.0] - 2025-08-10
+
+- Initial Release
+- Add note taking
+
+[v0.2.0]: https://github.com/Kyonru/feather/compare/v0.1.0...v0.2.0
+[v0.1.0]: https://github.com/Kyonru/feather/releases/tag/v0.1.0
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# Code Notes 📝
+# Codebase Notebook 📝
 
-Code Notes is a VS Code extension that lets you take structured notes across your codebase and quickly jump between code and the notes that describe it.
+Codebase Notebook is a VS Code extension that lets you take structured notes across your codebase and quickly jump between code and the notes that describe it.
 
 ## ✨ Features
 
@@ -36,9 +36,9 @@ Code Notes is a VS Code extension that lets you take structured notes across you
 
 ### 📸 UI Overview
 
-> Screenshots coming soon
+![example](preview.gif)
 
-- Activity Bar → Code Notes
+- Activity Bar → Codebase Notebook
 
 - Sidebar tree listing all your notes
 
@@ -62,23 +62,23 @@ Then press F5 to launch the extension dev host.
 
 ## 🎯 Core Commands
 
-| Command                            | Description                                     |
-| ---------------------------------- | ----------------------------------------------- |
-| `Code Notes: Create Note`          | Create a new note                               |
-| `Code Notes: Select Note`          | Switch the active note                          |
-| `Code Notes: Add Reference`        | Attach a code reference to a note               |
-| `Code Notes: Go to Reference`      | Jump to referenced file + line                  |
-| `Code Notes: View Note`            | Open preview of current note                    |
-| `Code Notes: Open Notes Directory` | Open storage folder for notes                   |
-| `Code Notes: Delete Note`          | Remove note                                     |
-| `Code Notes: Refresh Tree`         | Reload notes list                               |
-| `Code Notes: Open Note from Tree`  | Open by clicking tree item                      |
-| `Code Notes: View Note at`         | View note related to current cursor (if exists) |
+| Command                                   | Description                                     |
+| ----------------------------------------- | ----------------------------------------------- |
+| `Codebase Notebook: Create Note`          | Create a new note                               |
+| `Codebase Notebook: Select Note`          | Switch the active note                          |
+| `Codebase Notebook: Add Reference`        | Attach a code reference to a note               |
+| `Codebase Notebook: Go to Reference`      | Jump to referenced file + line                  |
+| `Codebase Notebook: View Note`            | Open preview of current note                    |
+| `Codebase Notebook: Open Notes Directory` | Open storage folder for notes                   |
+| `Codebase Notebook: Delete Note`          | Remove note                                     |
+| `Codebase Notebook: Refresh Tree`         | Reload notes list                               |
+| `Codebase Notebook: Open Note from Tree`  | Open by clicking tree item                      |
+| `Codebase Notebook: View Note at`         | View note related to current cursor (if exists) |
 
 You’ll find most actions in:
 
 - Command Palette (Cmd/Ctrl + Shift + P)
-- Code Notes sidebar
+- Codebase Notebook sidebar
 - Tree item right-click menus
 
 ## 🗂️ Where are notes stored?
@@ -87,18 +87,6 @@ Notes are stored locally in a Markdown directory (managed by the extension).
 
 They’re human readable and version-control friendly.
 
-## 🔧 Roadmap
-
-Planned improvements include:
-
-- Search & filtering
-
-- Workspace-shared notes option
-
-- Inline commenting UX
-
-- Multiple notes per line
-
 If you have ideas or feature requests, open an issue!
 
 ## ❤️ Sponsor
diff --git a/icon.png b/icon.png
diff --git a/package.json b/package.json
@@ -6,6 +6,7 @@
   },
   "description": "An extension to help taking note across the codebase",
   "version": "0.1.0",
+  "icon": "icon.png",
   "publisher": "SolenodonteLabs",
   "engines": {
     "vscode": "^1.107.0"
@@ -30,11 +31,22 @@
   "activationEvents": [],
   "main": "./out/extension.js",
   "contributes": {
+    "configuration": {
+      "title": "Codebase Notebook",
+      "properties": {
+        "crosscodenotes.notesDirectory": {
+          "type": "string",
+          "default": "",
+          "markdownDescription": "Custom directory for storing notes. Leave empty to use default. Supports `~` for home directory.",
+          "scope": "application"
+        }
+      }
+    },
     "viewsContainers": {
       "activitybar": [
         {
           "id": "crosscodenotes",
-          "title": "Code Notes",
+          "title": "Codebase Notebook",
           "icon": "$(notebook)"
         }
       ]
@@ -50,54 +62,59 @@
     "commands": [
       {
         "command": "crosscodenotes.createNote",
-        "title": "Code Notes: Create Note",
+        "title": "Codebase Notebook: Create Note",
         "icon": "$(new-file)"
       },
       {
         "command": "crosscodenotes.selectNote",
-        "title": "Code Notes: Select Note"
+        "title": "Codebase Notebook: Select Note"
       },
       {
         "command": "crosscodenotes.addReference",
-        "title": "Code Notes: Add Reference"
+        "title": "Codebase Notebook: Add Reference"
       },
       {
         "command": "crosscodenotes.goToReference",
-        "title": "Code Notes: Go to Reference"
+        "title": "Codebase Notebook: Go to Reference"
       },
       {
         "command": "crosscodenotes.viewNote",
-        "title": "Code Notes: View Note",
+        "title": "Codebase Notebook: View Note",
         "icon": "$(open-preview)"
       },
       {
         "command": "crosscodenotes.openNotesDir",
-        "title": "Code Notes: Open Notes Directory",
-        "icon": "$(folder)"
+        "title": "Codebase Notebook: Open Notes Directory",
+        "icon": "$(folder-opened)"
       },
       {
         "command": "crosscodenotes.deleteNote",
-        "title": "Code Notes: Delete Note",
+        "title": "Codebase Notebook: Delete Note",
         "icon": "$(trash)"
       },
       {
         "command": "crosscodenotes.refreshTree",
-        "title": "Code Notes: Refresh Tree",
+        "title": "Codebase Notebook: Refresh Notes",
         "icon": "$(refresh)"
       },
       {
         "command": "crosscodenotes.openNoteFromTree",
-        "title": "Code Notes: Open Note from Tree",
+        "title": "Codebase Notebook: Open Note from Tree",
         "icon": "$(open-preview)"
       },
       {
         "command": "crosscodenotes.viewNoteAt",
-        "title": "Code Notes: View Note at"
+        "title": "Codebase Notebook: View Note at"
       },
       {
         "command": "crosscodenotes.searchNotes",
-        "title": "Code Notes: Search Notes",
+        "title": "Codebase Notebook: Search Notes",
         "icon": "$(search)"
+      },
+      {
+        "command": "crosscodenotes.changeNotesDirectory",
+        "title": "Codebase Notebook: Change Notes Directory",
+        "icon": "$(settings)"
       }
     ],
     "menus": {
diff --git a/preview.gif b/preview.gif
diff --git a/src/commands.ts b/src/commands.ts
@@ -3,8 +3,9 @@ import * as path from "path";
 import * as fs from "fs";
 
 import { NoteItem, NotesTreeProvider } from "./treeView";
-import { createCommandName, getNotesDir } from "./utils";
+import { createCommandName, getDefaultNotesDir, getNotesDir } from "./utils";
 import { NotesCodeLensProvider } from "./codelens";
+import { EXTENSION_NAME } from "./constants";
 
 export function gerRefreshTreeCommand(
   notesTreeProvider: NotesTreeProvider,
@@ -527,3 +528,85 @@ export function getSearchNotesCommand(context: vscode.ExtensionContext) {
     }
   );
 }
+
+export function getChangeNotesDirectoryCommand(
+  context: vscode.ExtensionContext
+) {
+  return vscode.commands.registerCommand(
+    createCommandName("changeNotesDirectory"),
+    async () => {
+      const options = await vscode.window.showQuickPick(
+        [
+          {
+            label: "$(folder) Browse for Directory",
+            description: "Choose a custom location",
+            value: "browse",
+          },
+          {
+            label: "$(home) Use Default Directory",
+            description: getDefaultNotesDir(context),
+            value: "default",
+          },
+          {
+            label: "$(edit) Enter Path Manually",
+            description: "Type a custom path",
+            value: "manual",
+          },
+        ],
+        {
+          placeHolder: "How would you like to set the notes directory?",
+        }
+      );
+
+      if (!options) {
+        return;
+      }
+
+      let newPath: string | undefined;
+
+      if (options.value === "browse") {
+        const selected = await vscode.window.showOpenDialog({
+          canSelectFiles: false,
+          canSelectFolders: true,
+          canSelectMany: false,
+          openLabel: "Select Notes Directory",
+          title: "Choose Notes Directory",
+        });
+
+        if (selected && selected[0]) {
+          newPath = selected[0].fsPath;
+        }
+      } else if (options.value === "default") {
+        newPath = ""; // Empty string will use default
+      } else if (options.value === "manual") {
+        const NOTES_DIR = getNotesDir(context);
+        const input = await vscode.window.showInputBox({
+          prompt: "Enter notes directory path",
+          placeHolder: "~/Documents/code-notes or /absolute/path",
+          value: NOTES_DIR,
+          validateInput: (value) => {
+            if (!value || value.trim() === "") {
+              return "Path cannot be empty";
+            }
+            return null;
+          },
+        });
+
+        if (input) {
+          newPath = input;
+        }
+      }
+
+      if (newPath !== undefined) {
+        const config = vscode.workspace.getConfiguration(EXTENSION_NAME);
+        await config.update(
+          "notesDirectory",
+          newPath,
+          vscode.ConfigurationTarget.Global
+        );
+
+        await vscode.commands.executeCommand(createCommandName("refreshTree"));
+      }
+    }
+  );
+}
diff --git a/src/extension.ts b/src/extension.ts
@@ -16,6 +16,7 @@ import {
   getViewNoteAtCommand,
   getViewNoteCommand,
   getSearchNotesCommand,
+  getChangeNotesDirectoryCommand,
 } from "./commands";
 import { NoteReference } from "./types";
 import { initCodeLensProvider, NotesCodeLensProvider } from "./codelens";
@@ -76,6 +77,7 @@ export function activate(context: vscode.ExtensionContext) {
   const openNoteFromTree = getOpenNoteFromTreeCommand(context, updateStatusBar);
   const viewNoteAt = getViewNoteAtCommand();
   const searchNotes = getSearchNotesCommand(context);
+  const changeNotesDirectory = getChangeNotesDirectoryCommand(context);
 
   updateStatusBar();
 
@@ -89,6 +91,7 @@ export function activate(context: vscode.ExtensionContext) {
     refreshTree,
     deleteNote,
     viewNoteAt,
+    changeNotesDirectory,
     searchNotes,
     openNoteFromTree,
     treeView,
diff --git a/src/utils.ts b/src/utils.ts
@@ -1,4 +1,7 @@
 import * as vscode from "vscode";
+import * as path from "path";
+import * as os from "os";
+
 import { EXTENSION_NAME } from "./constants";
 
 export const createCommandName = (name: string) => `${EXTENSION_NAME}.${name}`;
@@ -7,6 +10,20 @@ export function getLineFromOffset(content: string, offset: number): number {
   return content.slice(0, offset).split(/\r?\n/).length;
 }
 
-export function getNotesDir(context: vscode.ExtensionContext) {
+export function getNotesDir(context: vscode.ExtensionContext): string {
+  const config = vscode.workspace.getConfiguration(EXTENSION_NAME);
+  const customPath = config.get<string>("notesDirectory");
+
+  if (customPath && customPath.trim() !== "") {
+    const expandedPath = customPath.startsWith("~")
+      ? path.join(os.homedir(), customPath.slice(1))
+      : customPath;
+    return path.resolve(expandedPath);
+  }
+
+  return getDefaultNotesDir(context);
+}
+
+export function getDefaultNotesDir(context: vscode.ExtensionContext) {
   return context.globalStorageUri.fsPath;
 }
