Initial Commit

Author: Ben Preston

.editorconfig

@@ -0,0 +1,10 @@
+# top-most EditorConfig file
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = tab
+indent_size = 4
+tab_width = 4

.eslintignore

@@ -0,0 +1,3 @@
+node_modules/
+
+main.js

.eslintrc

@@ -0,0 +1,23 @@
+{
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "env": { "node": true },
+    "plugins": [
+      "@typescript-eslint"
+    ],
+    "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:@typescript-eslint/recommended"
+    ], 
+    "parserOptions": {
+        "sourceType": "module"
+    },
+    "rules": {
+      "no-unused-vars": "off",
+      "@typescript-eslint/no-unused-vars": ["error", { "args": "none" }],
+      "@typescript-eslint/ban-ts-comment": "off",
+      "no-prototype-builtins": "off",
+      "@typescript-eslint/no-empty-function": "off"
+    } 
+  }

.gitignore

@@ -0,0 +1,26 @@
+
+# vscode
+.vscode 
+
+# used with hot-reload plugin
+.hotreload
+
+# Intellij
+*.iml
+.idea
+
+# npm
+node_modules
+
+# Don't include the compiled main.js file in the repo.
+# They should be uploaded to GitHub releases instead.
+main.js
+
+# Exclude sourcemaps
+*.map
+
+# obsidian
+data.json
+
+# Exclude macOS Finder (System Explorer) View States
+.DS_Store

.npmrc

@@ -0,0 +1 @@
+tag-version-prefix=""

README.md

@@ -0,0 +1,95 @@
+# Obsidian Sample Plugin
+
+This is a sample plugin for Obsidian (https://obsidian.md).
+
+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.
+
+**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
+
+This sample plugin demonstrates some of the basic functionality the plugin API can do.
+- 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.
+
+## First time developing plugins?
+
+Quick starting guide for new plugin devs:
+
+- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
+- 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.
+
+## 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.
+
+> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
+> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
+
+## Adding your plugin to the community plugin list
+
+- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
+- 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\`
+
+## Funding URL
+
+You can include funding URLs where people who use your plugin can financially support it.
+
+The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
+
+```json
+{
+    "fundingUrl": "https://buymeacoffee.com"
+}
+```
+
+If you have multiple URLs, you can also do:
+
+```json
+{
+    "fundingUrl": {
+        "Buy Me a Coffee": "https://buymeacoffee.com",
+        "GitHub Sponsor": "https://github.com/sponsors",
+        "Patreon": "https://www.patreon.com/"
+    }
+}
+```
+
+## API Documentation
+
+See https://github.com/obsidianmd/obsidian-api

esbuild.config.mjs

@@ -0,0 +1,48 @@
+import esbuild from "esbuild";
+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
+*/
+`;
+
+const prod = (process.argv[2] === "production");
+
+const context = await esbuild.context({
+	banner: {
+		js: banner,
+	},
+	entryPoints: ["main.ts"],
+	bundle: true,
+	external: [
+		"obsidian",
+		"electron",
+		"@codemirror/autocomplete",
+		"@codemirror/collab",
+		"@codemirror/commands",
+		"@codemirror/language",
+		"@codemirror/lint",
+		"@codemirror/search",
+		"@codemirror/state",
+		"@codemirror/view",
+		"@lezer/common",
+		"@lezer/highlight",
+		"@lezer/lr",
+		...builtins],
+	format: "cjs",
+	target: "es2018",
+	logLevel: "info",
+	sourcemap: prod ? false : "inline",
+	treeShaking: true,
+	outfile: "main.js",
+});
+
+if (prod) {
+	await context.rebuild();
+	process.exit(0);
+} else {
+	await context.watch();
+}

main.ts

@@ -0,0 +1,127 @@
+import { App, Editor, MarkdownView, Modal, Notice, Plugin } from 'obsidian';
+import { AutoCanvasSettingsTab, AutoCanvasPluginSettings, DEFAULT_SETTINGS, FolderCanvasMap } from "./settings";
+const fs = require('fs');
+var path = require('path');
+
+export default class AutoCanvasPlugin extends Plugin {
+	settings: AutoCanvasPluginSettings;
+
+	async onload() {
+		await this.loadSettings();
+
+		// This adds a settings tab so the user can configure various aspects of the plugin
+		this.addSettingTab(new AutoCanvasSettingsTab(this.app, this));
+
+		this.registerEvent(
+			this.app.vault.on("create", (page) => {
+
+				let targetCanvas = this.tryAddMatch(page);
+				if (targetCanvas)
+					this.openTargetCanvas(targetCanvas)
+			})
+		)
+	}
+
+
+	tryAddMatch(page) {
+
+		const folderPath = page.path.substring(0, page.path.lastIndexOf("/") + 1);
+		for(const [key, val] of Object.entries(this.settings.folderCanvasMaps))
+		{
+			let map = val as FolderCanvasMap;
+			if (map.folder == folderPath)
+			{
+				this.tryAddPageToCanvas(page, map.canvas);
+				return map.canvas;
+			}
+		}
+
+		return null;
+	}
+
+
+	openTargetCanvas(canvasPath) {
+
+		if (this.settings.openTargetCanvasOnNewItem == false)
+			return;
+
+		let activeLeaf;
+		try { activeLeaf = this.app.workspace.getLeaf(); }
+		catch { return; }
+		if (!activeLeaf) { return; }
+
+		setTimeout( async () => {
+			try {
+				let pageData = this.app.vault.fileMap[canvasPath];
+
+				if (!pageData)
+					return;
+
+				await activeLeaf.openFile(pageData);
+				activeLeaf.setEphemeralState({ rename: 'all' });
+			} catch (error)
+			{
+				console.log(error);
+			}
+
+		}, 1500);
+	}
+
+
+	tryAddPageToCanvas(page: any, canvas: string) {
+
+		try {
+
+			let newNodeObj = {
+				"type":"file",
+				"file": page.path,
+				"id": Math.random() * Date.now(),
+				"x": 0,
+				"y": 0,
+				"width": 260,
+				"height": 380
+			}
+
+			let fullPath = path.join(page.vault.adapter.basePath, canvas);
+			
+			fs.readFile(fullPath, 'utf8', (err, data) => {
+
+				if (err){ console.log(err);}
+				if (!data) return;
+
+				let allObjs = JSON.parse(data);
+				allObjs.nodes.push(newNodeObj);
+				console.log(fullPath);
+				fs.writeFile(fullPath, JSON.stringify(allObjs), (err2) => {
+					if (err2)
+						console.log(err2);
+				})
+
+				return;
+			})
+			
+
+			return;
+
+		} catch (error){
+			console.log(error);
+		}
+	}
+
+
+	onunload() {
+
+	}
+
+	async loadSettings() {
+		this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
+	}
+
+	async saveSettings() {
+		await this.saveData(this.settings);
+	}
+}
+
+
+
+

manifest.json

@@ -0,0 +1,11 @@
+{
+	"id": "obsidian-auto-canvas",
+	"name": "Auto Canvas",
+	"version": "1.0.0",
+	"minAppVersion": "0.15.0",
+	"description": "Automatically adds items to a canvas when created in a given folder. Supports a one-to-one mapping from folder to canvas.",
+	"author": "Obsidian",
+	"authorUrl": "https://github.com/prestsauce",
+	"fundingUrl": "",
+	"isDesktopOnly": true
+}