[Feat] initial release for obsidian-advanced-new-file

Author: vanadium23

.gitignore

@@ -12,3 +12,4 @@ main.js
 
 # obsidian
 data.json
+.obsidian/

README.md

@@ -1,57 +1,24 @@
-## 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.
-- 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.
-
-### First time developing plugins?
-
-Quick starting guide for new plugin devs:
-
-- 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.
-- 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/`.
-
-### API Documentation
-
-See https://github.com/obsidianmd/obsidian-api
+## Obsidian Advanced New File
+
+Obsidian Advanced New file is a plugin for [Obsidian](https://obsidian.md/), that provide functionality to choose folder over note creation.
+The new note file is created with `Untitled.md` filename just to provide same behavior as default Obsidian.
+
+The plugin is heavily inspired by [Note refactor](https://github.com/lynchjames/note-refactor-obsidian) amd [similar extension](https://marketplace.visualstudio.com/items?itemName=dkundel.vscode-new-file) for Vs Code.
+
+## Feature
+
+**Hint:** you can set command `advanced new file` to shortcut like `Ctrl/Cmd` + `Alt` + `N`.
+
+Spawn command `advanced new file` and choose directory.
+
+![Demo](images/demo.gif)
+
+### How to develop
+
+- 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/`.

TODO.md

@@ -0,0 +1,13 @@
+# Road map obsidian-advanced-new-file
+
+* [x] Add command to trigger panel
+* [x] Add sample panel
+* [x] Add panel to select folders
+* [c] Add panel to enter filename
+  - Decide to create an untitled file like a default obsidian behavior.
+* [x] Create an `Untitled` file in selected folder.
+* [c] Create folders, if no suggestion triggered.
+  - Decide currently only in known folders for creation.
+* [x] Rewrite logic for choosing folders without markdown files.
+* [x] Rewrite [[README]].
+* [ ] Add config for folder exclusion.

images/demo.gif

@@ -1,10 +1,10 @@
 {
-	"id": "obsidian-sample-plugin",
-	"name": "Sample Plugin",
-	"version": "1.0.1",
+	"id": "obsidian-advanced-new-file",
+	"name": "Advanced new file",
+	"version": "1.0.0",
 	"minAppVersion": "0.9.12",
-	"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/about",
+	"description": "This is a plugin for choosing folder on note creation.",
+	"author": "vanadium23",
+	"authorUrl": "https://vanadium23.me/",
 	"isDesktopOnly": false
 }

main.ts

@@ -1,7 +1,7 @@
 {
-  "name": "obsidian-sample-plugin",
-  "version": "0.12.0",
-  "description": "This is a sample plugin for Obsidian (https://obsidian.md)",
+  "name": "obsidian-advanced-new-file",
+  "version": "1.0.0",
+  "description": "Create notes in chosen folder for Obsidian (https://obsidian.md)",
   "main": "main.js",
   "scripts": {
     "dev": "rollup --config rollup.config.js -w",

manifest.json

@@ -12,7 +12,7 @@ if you want to view the source visit the plugins github repository
 `;
 
 export default {
-  input: 'main.ts',
+  input: 'src/main.ts',
   output: {
     dir: '.',
     sourcemap: 'inline',

package.json

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+cp main.js .obsidian/plugins/obsidian-advanced-new-file/
+cp manifest.json .obsidian/plugins/obsidian-advanced-new-file/
+cp styles.css .obsidian/plugins/obsidian-advanced-new-file/

rollup.config.js

@@ -0,0 +1,28 @@
+import { Plugin } from 'obsidian';
+import { ChooseFolderModal } from './modal';
+
+
+export default class AdvancedNewFilePlugin extends Plugin {
+	async onload() {
+		console.log('loading plugin');
+
+		this.addCommand({
+			id: 'advanced-new-file',
+			name: 'Create note',
+			checkCallback: (checking: boolean) => {
+				let leaf = this.app.workspace.activeLeaf;
+				if (leaf) {
+					if (!checking) {
+						new ChooseFolderModal(this.app).open();
+					}
+					return true;
+				}
+				return false;
+			}
+		});
+	}
+
+	onunload() {
+		console.log('unloading plugin');
+	}
+}

scripts/install.sh

@@ -0,0 +1,91 @@
+import { App, FuzzySuggestModal, TFolder, Notice } from 'obsidian';
+
+const EMPTY_TEXT = 'No files found to append content. Enter to create a new one.'
+const PLACEHOLDER_TEXT = 'Type file to append to or create';
+const instructions = [
+    {command: '↑↓', purpose: 'to navigate'},
+    {command: '↵', purpose: 'to choose folder'},
+    {command: 'esc', purpose: 'to dismiss'}
+];
+
+export class ChooseFolderModal extends FuzzySuggestModal<TFolder>{
+    folders: TFolder[];
+    chooseFolder: HTMLDivElement;
+    suggestionEmpty: HTMLDivElement;
+    noSuggestion: boolean;
+
+    constructor(app: App) {
+        super(app);
+        this.init();
+    }
+
+    init() {
+        const files = this.app.vault.getFiles();
+		const folders = new Set() as Set<TFolder>;
+		for (const file of files) {
+			folders.add(file.parent)
+		}
+		this.folders = Array.from(folders);
+        this.emptyStateText = EMPTY_TEXT;
+        this.setPlaceholder(PLACEHOLDER_TEXT);
+        this.setInstructions(instructions);
+        this.initChooseFolderItem();
+    }
+        
+    getItems(): TFolder[] {
+        return this.folders;
+    }
+    
+    getItemText(item: TFolder): string {
+        this.noSuggestion = false;
+        return item.path;
+    }
+    
+    onNoSuggestion() {
+        this.noSuggestion = true;
+        this.resultContainerEl.childNodes.forEach(c => c.parentNode.removeChild(c));
+        this.chooseFolder.innerText = this.inputEl.value;
+        this.itemInstructionMessage(this.chooseFolder, 'No folder found');
+        this.resultContainerEl.appendChild(this.chooseFolder);
+        this.resultContainerEl.appendChild(this.suggestionEmpty);
+    }
+    
+    onChooseItem(item: TFolder, evt: MouseEvent | KeyboardEvent): void {
+        if(this.noSuggestion) {
+            // TODO make something on 
+            return;
+        }
+        this.createNewNote(item);
+    }
+    
+    initChooseFolderItem() {
+        this.chooseFolder = document.createElement('div');
+        this.chooseFolder.addClasses(['suggestion-item', 'is-selected']);
+        this.suggestionEmpty = document.createElement('div');
+        this.suggestionEmpty.addClass('suggestion-empty');
+        this.suggestionEmpty.innerText = EMPTY_TEXT;
+    }
+
+    itemInstructionMessage(resultEl: HTMLElement, message: string) {
+        const el = document.createElement('kbd');
+        el.addClass('suggestion-hotkey');
+        el.innerText = message;
+        resultEl.appendChild(el);
+    }
+
+    async createNewNote(item: TFolder) : Promise<void> {
+        const fileName = `${item.path}/Untitled.md`
+        try {
+            // If files exists, throw error
+            const fileExists = await this.app.vault.adapter.exists(fileName);
+            if(fileExists){
+                throw new Error("Untitled file already exists");
+            }
+            const file = await this.app.vault.create(fileName, "");
+            this.app.workspace.activeLeaf.openFile(file);
+          } catch (error) {
+              new Notice(error);
+          }
+      }
+
+}

src/main.ts

@@ -1,4 +1,4 @@
 /* Sets all the text color to red! */
-body {
+/* body {
     color: red;
-}
+} */

src/modal.ts

@@ -1,4 +1,3 @@
 {
-	"1.0.1": "0.9.12",
 	"1.0.0": "0.9.7"
 }