v0.0.1 MVP

README.md

@@ -1,68 +1,32 @@
-## Obsidian Sample Plugin
+## Description
+This plugin leverages the great Dataview plugin capabilities to select multiple values returned by a query and include them in your note
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+for example
+- select some [[<ingredient>]] from your '#Ingredient' notes as required ingredients for a recipe
+- select some of your [[<teamate>]] from your '#Staff' notes as participants for a meeting note
+- select some [[<song>]] from your '#Favorite && #Song' notes as songs for a playlist note
+and so on...
 
-This project uses Typescript to provide type checking and documentation.
-The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.
+Seing all the links related to a query helps selecting them faster and not forgetting some.
 
-**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
+### Demo
+TODO
 
-This sample plugin demonstrates some of the basic functionality the plugin API can do.
-- Changes the default font color to red using `styles.css`.
-- Adds a ribbon icon, which shows a Notice when clicked.
-- Adds a command "Open Sample Modal" which opens a Modal.
-- Adds a plugin setting tab to the settings page.
-- Registers a global click event and output 'click' to the console.
-- Registers a global interval which logs 'setInterval' to the console.
+### Settings
+You can Add/Change/Remove as many queries has you want
 
-### First time developing plugins?
+Add a query by hitting "+".
+You'll have to set a name, a description and the query.
+The query has to be written in the dataviewjs syntax: https://blacksmithgu.github.io/obsidian-dataview/api/intro/ and has to return a dataArray
 
-Quick starting guide for new plugin devs:
+There will be one command per query. Each one is name "Multi Select: {description of the query}"
 
-- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
-- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
-- Install NodeJS, then run `npm i` in the command line under your repo folder.
-- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
-- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
-- Reload Obsidian to load the new version of your plugin.
-- Enable plugin in settings window.
-- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
+Once created, you can modify the query by hitting the pencil button or remove it by hitting the garbage button
 
-### Releasing new releases
-
-- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
-- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
-- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
-- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
-- Publish the release.
-
-### Adding your plugin to the community plugin list
-
-- Publish an initial version.
-- Make sure you have a `README.md` file in the root of your repo.
-- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
-
-### How to use
-
-- Clone this repo.
-- `npm i` or `yarn` to install dependencies
-- `npm run dev` to start compilation in watch mode.
-
-### Manually installing the plugin
-
-- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
-
-### Improve code quality with eslint (optional)
-- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code. 
-- To use eslint with this project, make sure to install eslint from terminal:
-  - `npm install -g eslint`
-- To use eslint to analyze this project use this command:
-  - `eslint main.ts`
-  - eslint will then create a report with suggestions for code improvement by file and line number.
-- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
-  - `eslint .\src\`
-
-
-### API Documentation
-
-See https://github.com/obsidianmd/obsidian-api
+### Usage
+1. In live preview, position the cursor where you want to include links
+2. open the command palette and select the query that you want to execute
+3. Select the results that you want to paste at the cursor position
+4. You can select an alias where the target note contains aliases in its frontmatter
+5. Set append and prepend strings (default prepend string: none, default append string: `", "`)
+6. Hit the checkmark button to paste the links in your note: Et voilà!

esbuild.config.mjs

@@ -3,7 +3,7 @@ import process from "process";
 import builtins from 'builtin-modules'
 
 const banner =
-`/*
+	`/*
 THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
 if you want to view the source, please visit the github repository of this plugin
 */
@@ -17,7 +17,7 @@ esbuild.build({
 	},
 	entryPoints: ['main.ts'],
 	bundle: true,
-	external: ['obsidian', 'electron', ...builtins],
+	external: ['obsidian', 'electron', 'obsidian-dataview', ...builtins],
 	format: 'cjs',
 	watch: !prod,
 	target: 'es2016',

main.ts

@@ -1,81 +1,39 @@
-import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting } from 'obsidian';
+import { MarkdownView, Plugin } from 'obsidian';
+import { MultiSelectSettings, DEFAULT_SETTINGS } from "src/settings/settings"
+import Query from "src/queries/Query"
+import QueryResultModal from "src/queries/queryResultsModal"
+import settingTab from "src/settings/settingTab"
 
-// Remember to rename these classes and interfaces!
+export default class MultiSelect extends Plugin {
+	settings: MultiSelectSettings;
+	initialQueries: Array<Query> = []
 
-interface MyPluginSettings {
-	mySetting: string;
-}
-
-const DEFAULT_SETTINGS: MyPluginSettings = {
-	mySetting: 'default'
-}
-
-export default class MyPlugin extends Plugin {
-	settings: MyPluginSettings;
-
-	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
+	addMultiSelectQueryCommand(query: Query) {
 		this.addCommand({
-			id: 'open-sample-modal-simple',
-			name: 'Open sample modal (simple)',
+			id: `multiSelect-${query.name}`,
+			name: `Multi Select from ${query.name}`,
 			callback: () => {
-				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
-					return true;
+				const leaf = this.app.workspace.activeLeaf
+				if (leaf.view instanceof MarkdownView && leaf.view.editor) {
+					const queryResultModal = new QueryResultModal(this.app, this, query, leaf.view.editor.getCursor(), leaf.view.file)
+					queryResultModal.open()
 				}
-			}
+			},
 		});
+	}
 
-		// 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);
-		});
+	async onload() {
+		await this.loadSettings();
+		this.settings.queries.forEach(savedQuery => {
+			const query = new Query()
+			Object.assign(query, savedQuery)
+			this.initialQueries.push(query)
+		})
+		this.addSettingTab(new settingTab(this.app, this));
+		this.settings.queries.forEach(query => {
+			this.addMultiSelectQueryCommand(query)
+		})
 
-		// 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() {
@@ -87,51 +45,9 @@ export default class MyPlugin extends Plugin {
 	}
 
 	async saveSettings() {
+		this.settings.queries = this.initialQueries
 		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();
-
-		containerEl.createEl('h2', {text: 'Settings for my awesome plugin.'});
-
-		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) => {
-					console.log('Secret: ' + value);
-					this.plugin.settings.mySetting = value;
-					await this.plugin.saveSettings();
-				}));
-	}
-}

manifest.json

@@ -1,10 +1,10 @@
 {
-	"id": "obsidian-sample-plugin",
-	"name": "Sample Plugin",
-	"version": "1.0.1",
-	"minAppVersion": "0.12.0",
-	"description": "This is a sample plugin for Obsidian. This plugin demonstrates some of the capabilities of the Obsidian API.",
-	"author": "Obsidian",
-	"authorUrl": "https://obsidian.md",
+	"id": "obsidian-multiselect",
+	"name": "Multi Select",
+	"version": "0.0.1",
+	"minAppVersion": "0.13.19",
+	"description": "Select multiple notes from a dataview query and include their links the current note",
+	"author": "mdelobelle",
+	"authorUrl": "https://github.com/mdelobelle",
 	"isDesktopOnly": false
-}
+}

package.json

@@ -1,14 +1,15 @@
 {
-	"name": "obsidian-sample-plugin",
-	"version": "0.12.0",
-	"description": "This is a sample plugin for Obsidian (https://obsidian.md)",
+	"name": "obsidian-multiselect",
+	"version": "0.0.1",
+	"description": "Select multiple notes and include their links the current note",
 	"main": "main.js",
+	"types": "types.d.ts",
 	"scripts": {
 		"dev": "node esbuild.config.mjs",
 		"build": "node esbuild.config.mjs production"
 	},
 	"keywords": [],
-	"author": "",
+	"author": "mdelobelle",
 	"license": "MIT",
 	"devDependencies": {
 		"@types/node": "^16.11.6",
@@ -17,7 +18,8 @@
 		"builtin-modules": "^3.2.0",
 		"esbuild": "0.13.12",
 		"obsidian": "^0.12.17",
+		"obsidian-dataview": "^0.4.21",
 		"tslib": "2.3.1",
 		"typescript": "4.4.4"
 	}
-}
+}

src/queries/Query.ts

@@ -0,0 +1,28 @@
+interface Query {
+    id: string
+    name: string
+    description: string
+    dataviewJSQuery?: string
+}
+
+class Query {
+
+    constructor(name: string = "",
+        description: string = "",
+        id: string = "",
+        dataviewJSQuery: string = null) {
+        this.name = name
+        this.description = description
+        this.id = id
+        this.dataviewJSQuery = dataviewJSQuery
+    }
+
+    static copyQuery(target: Query, source: Query) {
+        target.id = source.id
+        target.name = source.name
+        target.description = source.description
+        target.dataviewJSQuery = source.dataviewJSQuery
+    }
+}
+
+export default Query