12 feature enable the user to customize file names (#13)

* Base impl to enable prefix set as an option

* Fix for root vault folder showing as empty when selected

* Enabling the filename prefix to be set

* Save filename prefix things on button click so there can be validation

* remove console log

* Adds recordingFilenamePrefix to settings

* Fixes file exists logic in rename

* uses filename prefix from settings

* Shows saved notifciation on directory changes

* Adds note that this will be improved

* Bump version number

* Fix formatting that got weird for some reason

Author: Mikodin

manifest.json

@@ -1,11 +1,11 @@
 {
-	"id": "scribe",
-	"name": "Scribe",
-	"version": "1.0.6",
-	"minAppVersion": "0.15.0",
-	"description": "Record voice notes, Fill in lost thoughts, Transcribe the audio, Summarize & Visualize the text - All in one clip",
-	"author": "Mike Alicea",
-	"authorUrl": "https://github.com/Mikodin/",
-	"fundingUrl": "https://buymeacoffee.com/mikealicea",
-	"isDesktopOnly": false
+  "id": "scribe",
+  "name": "Scribe",
+  "version": "1.0.7",
+  "minAppVersion": "0.15.0",
+  "description": "Record voice notes, Fill in lost thoughts, Transcribe the audio, Summarize & Visualize the text - All in one clip",
+  "author": "Mike Alicea",
+  "authorUrl": "https://github.com/Mikodin/",
+  "fundingUrl": "https://buymeacoffee.com/mikealicea",
+  "isDesktopOnly": false
 }

package.json

@@ -1,36 +1,36 @@
 {
-	"name": "obsidian-scribe-plugin",
-	"version": "1.0.6",
-	"description": "An Obsidian plugin for recording voice notes, transcribing the audio, and summarizing the text - All in one",
-	"main": "build/main.js",
-	"scripts": {
-		"dev": "node esbuild.config.mjs",
-		"build:prod": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
-		"version": "node version-bump.mjs && git add manifest.json versions.json"
-	},
-	"keywords": [],
-	"author": "Mike Alicea",
-	"license": "MIT",
-	"devDependencies": {
-		"@biomejs/biome": "1.9.4",
-		"@types/node": "^16.11.6",
-		"@types/react": "^18.3.12",
-		"@types/react-dom": "^18.3.1",
-		"builtin-modules": "3.3.0",
-		"dotenv": "^16.4.5",
-		"esbuild": "0.17.3",
-		"obsidian": "latest",
-		"tslib": "2.4.0",
-		"typescript": "4.7.4"
-	},
-	"dependencies": {
-		"@langchain/core": "^0.3.14",
-		"@langchain/openai": "^0.3.11",
-		"assemblyai": "^4.8.0",
-		"langchain": "^0.3.3",
-		"openai": "^4.68.3",
-		"react": "^18.3.1",
-		"react-dom": "^18.3.1",
-		"zod": "^3.23.8"
-	}
+  "name": "obsidian-scribe-plugin",
+  "version": "1.0.7",
+  "description": "An Obsidian plugin for recording voice notes, transcribing the audio, and summarizing the text - All in one",
+  "main": "build/main.js",
+  "scripts": {
+    "dev": "node esbuild.config.mjs",
+    "build:prod": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
+    "version": "node version-bump.mjs && git add manifest.json versions.json"
+  },
+  "keywords": [],
+  "author": "Mike Alicea",
+  "license": "MIT",
+  "devDependencies": {
+    "@biomejs/biome": "1.9.4",
+    "@types/node": "^16.11.6",
+    "@types/react": "^18.3.12",
+    "@types/react-dom": "^18.3.1",
+    "builtin-modules": "3.3.0",
+    "dotenv": "^16.4.5",
+    "esbuild": "0.17.3",
+    "obsidian": "latest",
+    "tslib": "2.4.0",
+    "typescript": "4.7.4"
+  },
+  "dependencies": {
+    "@langchain/core": "^0.3.14",
+    "@langchain/openai": "^0.3.11",
+    "assemblyai": "^4.8.0",
+    "langchain": "^0.3.3",
+    "openai": "^4.68.3",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "zod": "^3.23.8"
+  }
 }

src/index.ts

@@ -14,7 +14,6 @@ import {
   addAudioSourceToFrontmatter,
   addSummaryToNote,
   addTranscriptToNote,
-  createBaseFileName,
   createNewNote,
   renameFile,
   saveAudioRecording,
@@ -31,6 +30,7 @@ import {
 } from './util/mimeType';
 import { extractMermaidChart } from './util/textUtil';
 import { transcribeAudioWithAssemblyAi } from './util/assemblyAiUtil';
+import { formatFilenamePrefix } from './util/filenameUtils';
 
 export interface ScribeState {
   isOpen: boolean;
@@ -128,13 +128,15 @@ export default class ScribePlugin extends Plugin {
 
   async scribe(scribeOptions: ScribeOptions = {}) {
     try {
-      const baseFileName = createBaseFileName();
+      const baseFileName = formatFilenamePrefix(
+        this.settings.recordingFilenamePrefix,
+        this.settings.dateFilenameFormat,
+      );
 
       const { recordingBuffer, recordingFile } =
         await this.handleStopAndSaveRecording(baseFileName);
 
       await this.handleScribeFile({
-        baseNoteAndAudioFileName: baseFileName,
         audioRecordingFile: recordingFile,
         audioRecordingBuffer: recordingBuffer,
         scribeOptions: scribeOptions,
@@ -157,12 +159,10 @@ export default class ScribePlugin extends Plugin {
         new Notice('Scribe: ⚠️ This file type is not supported.');
         return;
       }
-      const baseFileName = createBaseFileName();
 
       const audioFileBuffer = await this.app.vault.readBinary(audioFile);
 
       await this.handleScribeFile({
-        baseNoteAndAudioFileName: baseFileName,
         audioRecordingFile: audioFile,
         audioRecordingBuffer: audioFileBuffer,
       });
@@ -227,18 +227,19 @@ export default class ScribePlugin extends Plugin {
   }
 
   async handleScribeFile({
-    baseNoteAndAudioFileName,
     audioRecordingFile,
     audioRecordingBuffer,
     scribeOptions = {},
   }: {
-    baseNoteAndAudioFileName: string;
     audioRecordingFile: TFile;
     audioRecordingBuffer: ArrayBuffer;
     scribeOptions?: ScribeOptions;
   }) {
     const { isAppendToActiveFile, isOnlyTranscribeActive } = scribeOptions;
-    const scribeNoteFilename = `scribe-${baseNoteAndAudioFileName}`;
+    const scribeNoteFilename = `${formatFilenamePrefix(
+      this.settings.noteFilenamePrefix,
+      this.settings.dateFilenameFormat,
+    )}`;
 
     let note = isAppendToActiveFile
       ? this.app.workspace.getActiveFile()
@@ -271,7 +272,11 @@ export default class ScribePlugin extends Plugin {
 
     const shouldRenameNote = !isAppendToActiveFile;
     if (shouldRenameNote) {
-      const llmFileName = `scribe-${moment().format('YYYY-MM-DD')}-${normalizePath(llmSummary.title)}`;
+      const llmFileName = `${formatFilenamePrefix(
+        this.settings.noteFilenamePrefix,
+        this.settings.dateFilenameFormat,
+      )}${normalizePath(llmSummary.title)}`;
+
       await renameFile(this, note, llmFileName);
     }
   }
@@ -298,7 +303,9 @@ export default class ScribePlugin extends Plugin {
       return transcript;
     } catch (error) {
       new Notice(
-        `Scribe: 🎧 🛑 Something went wrong trying to Transcribe w/  ${this.settings.transcriptPlatform}
+        `Scribe: 🎧 🛑 Something went wrong trying to Transcribe w/  ${
+          this.settings.transcriptPlatform
+        }
         ${error.toString()}`,
       );