First commit

main.ts

@@ -1,134 +1,63 @@
-import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting } from 'obsidian';
+import {Plugin, TFile, TFolder} from "obsidian"
 
-// Remember to rename these classes and interfaces!
 
-interface MyPluginSettings {
+export interface SteffoFileIndex {
-	mySetting: string;
+	basenames: {[basename: string]: string},
+	paths: string[],
 }
 
-const DEFAULT_SETTINGS: MyPluginSettings = {
-	mySetting: 'default'
-}
 
-export default class MyPlugin extends Plugin {
+export default class SteffoFileIndexPlugin extends Plugin {
-	settings: MyPluginSettings;
+	static FILE_INDEX_PATH = "steffo-file-index.json"
+
+	async recreateFileIndex() {
+		const files = this.app.vault.getFiles()
+
+		const basenames: {[basename: string]: string} = {}
+		const paths = []
+
+		for(const file of files) {
+			paths.push(file.path)
+			basenames[file.basename] = file.path
+		}
+
+		paths.sort()
+
+		const index: SteffoFileIndex = {basenames, paths}
+		const indexContents = JSON.stringify(index, null, "\t")
+
+		const indexFile = this.app.vault.getAbstractFileByPath(SteffoFileIndexPlugin.FILE_INDEX_PATH)
+		if(indexFile instanceof TFolder) {
+			console.error("Cannot create file index, as there's a folder at:", SteffoFileIndexPlugin.FILE_INDEX_PATH)
+			return
+		}
+		else if(indexFile instanceof TFile) {
+			console.info("File index already exists, overwriting contents of:", SteffoFileIndexPlugin.FILE_INDEX_PATH)
+			await this.app.vault.modify(indexFile, indexContents)
+		}
+		else {
+			console.info("File index does not exist, creating it right now at:", SteffoFileIndexPlugin.FILE_INDEX_PATH)
+			await this.app.vault.create(SteffoFileIndexPlugin.FILE_INDEX_PATH, indexContents)
+		}
+	}
+
+	recreateFileIndexBinding = this.recreateFileIndex.bind(this)
 
 	async onload() {
-		await this.loadSettings();
-
-		// This creates an icon in the left ribbon.
-		const ribbonIconEl = this.addRibbonIcon('dice', 'Sample Plugin', (evt: MouseEvent) => {
-			// Called when the user clicks the icon.
-			new Notice('This is a notice!');
-		});
-		// Perform additional things with the ribbon
-		ribbonIconEl.addClass('my-plugin-ribbon-class');
-
-		// This adds a status bar item to the bottom of the app. Does not work on mobile apps.
-		const statusBarItemEl = this.addStatusBarItem();
-		statusBarItemEl.setText('Status Bar Text');
-
-		// This adds a simple command that can be triggered anywhere
 		this.addCommand({
-			id: 'open-sample-modal-simple',
+			id: 'steffo-file-index-recreate',
-			name: 'Open sample modal (simple)',
+			name: 'Force file index recreation',
-			callback: () => {
+			callback: this.recreateFileIndex.bind(this)
-				new SampleModal(this.app).open();
+		})
-			}
-		});
-		// This adds an editor command that can perform some operation on the current editor instance
-		this.addCommand({
-			id: 'sample-editor-command',
-			name: 'Sample editor command',
-			editorCallback: (editor: Editor, view: MarkdownView) => {
-				console.log(editor.getSelection());
-				editor.replaceSelection('Sample Editor Command');
-			}
-		});
-		// This adds a complex command that can check whether the current state of the app allows execution of the command
-		this.addCommand({
-			id: 'open-sample-modal-complex',
-			name: 'Open sample modal (complex)',
-			checkCallback: (checking: boolean) => {
-				// Conditions to check
-				const markdownView = this.app.workspace.getActiveViewOfType(MarkdownView);
-				if (markdownView) {
-					// If checking is true, we're simply "checking" if the command can be run.
-					// If checking is false, then we want to actually perform the operation.
-					if (!checking) {
-						new SampleModal(this.app).open();
-					}
 
-					// This command will only show up in Command Palette when the check function returns true
+		this.app.vault.on("create", this.recreateFileIndexBinding)
-					return true;
+		this.app.vault.on("delete", this.recreateFileIndexBinding)
-				}
+		this.app.vault.on("rename", this.recreateFileIndexBinding)
-			}
-		});
-
-		// This adds a settings tab so the user can configure various aspects of the plugin
-		this.addSettingTab(new SampleSettingTab(this.app, this));
-
-		// If the plugin hooks up any global DOM events (on parts of the app that doesn't belong to this plugin)
-		// Using this function will automatically remove the event listener when this plugin is disabled.
-		this.registerDomEvent(document, 'click', (evt: MouseEvent) => {
-			console.log('click', evt);
-		});
-
-		// When registering intervals, this function will automatically clear the interval when the plugin is disabled.
-		this.registerInterval(window.setInterval(() => console.log('setInterval'), 5 * 60 * 1000));
 	}
 
 	onunload() {
-
+		this.app.vault.off("create", this.recreateFileIndexBinding)
-	}
+		this.app.vault.off("delete", this.recreateFileIndexBinding)
-
+		this.app.vault.off("rename", this.recreateFileIndexBinding)
-	async loadSettings() {
-		this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
-	}
-
-	async saveSettings() {
-		await this.saveData(this.settings);
-	}
-}
-
-class SampleModal extends Modal {
-	constructor(app: App) {
-		super(app);
-	}
-
-	onOpen() {
-		const {contentEl} = this;
-		contentEl.setText('Woah!');
-	}
-
-	onClose() {
-		const {contentEl} = this;
-		contentEl.empty();
-	}
-}
-
-class SampleSettingTab extends PluginSettingTab {
-	plugin: MyPlugin;
-
-	constructor(app: App, plugin: MyPlugin) {
-		super(app, plugin);
-		this.plugin = plugin;
-	}
-
-	display(): void {
-		const {containerEl} = this;
-
-		containerEl.empty();
-
-		new Setting(containerEl)
-			.setName('Setting #1')
-			.setDesc('It\'s a secret')
-			.addText(text => text
-				.setPlaceholder('Enter your secret')
-				.setValue(this.plugin.settings.mySetting)
-				.onChange(async (value) => {
-					this.plugin.settings.mySetting = value;
-					await this.plugin.saveSettings();
-				}));
 	}
 }

manifest.json

@@ -1,11 +1,11 @@
 {
-	"id": "sample-plugin",
+	"id": "steffo-file-index",
-	"name": "Sample Plugin",
+	"name": "File Index",
-	"version": "1.0.0",
+	"version": "0.1.0",
 	"minAppVersion": "0.15.0",
-	"description": "This is a sample plugin for Obsidian. This plugin demonstrates some of the capabilities of the Obsidian API.",
+	"description": "Create a metadata file about the files present in the Vault ",
-	"author": "Obsidian",
+	"author": "Steffo",
-	"authorUrl": "https://obsidian.md",
+	"authorUrl": "https://www.steffo.eu",
-	"fundingUrl": "https://obsidian.md/pricing",
+	"fundingUrl": "https://ko-fi.com/steffo",
 	"isDesktopOnly": false
 }

package.json

@@ -1,15 +1,15 @@
 {
-	"name": "obsidian-sample-plugin",
+	"name": "steffo-file-index",
-	"version": "1.0.0",
+	"version": "0.1.0",
-	"description": "This is a sample plugin for Obsidian (https://obsidian.md)",
+	"description": "Obsidian plugin to create a metadata file about the files present in the Vault",
 	"main": "main.js",
 	"scripts": {
 		"dev": "node esbuild.config.mjs",
 		"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
 		"version": "node version-bump.mjs && git add manifest.json versions.json"
 	},
-	"keywords": [],
+	"keywords": ["obsidian", "file", "obsiview", "obsidian-plugin"],
-	"author": "",
+	"author": "Stefano Pigozzi <me@steffo.eu>",
 	"license": "MIT",
 	"devDependencies": {
 		"@types/node": "^16.11.6",