add docs and CD, change structure

.github/workflows/release.yml

@@ -0,0 +1,79 @@
+name: Release Obsidian Plugin
+on:
+    push:
+        # Sequence of patterns matched against refs/tags
+        tags:
+            - "*" # Push events to matching any tag format, i.e. 1.0, 20.15.10
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+              with:
+                  fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
+            - name: Use Node.js
+              uses: actions/setup-node@v1
+              with:
+                  node-version: "14.x" # You might need to adjust this value to your own version
+            # Get the version number and put it in a variable
+            - name: Get Version
+              id: version
+              run: |
+                  echo "::set-output name=tag::$(git describe --abbrev=0)"
+            # Build the plugin
+            - name: Build
+              id: build
+              run: |
+                  npm install
+                  npm run build --if-present
+            # Package the required files into a zip
+            - name: Package
+              run: |
+                  mkdir ${{ github.event.repository.name }}
+                  cp main.js manifest.json README.md ${{ github.event.repository.name }}
+                  zip -r ${{ github.event.repository.name }}.zip ${{ github.event.repository.name }}
+            # Create the release on github
+            - name: Create Release
+              id: create_release
+              uses: actions/create-release@v1
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+                  VERSION: ${{ github.ref }}
+              with:
+                  tag_name: ${{ github.ref }}
+                  release_name: ${{ github.ref }}
+                  draft: false
+                  prerelease: false
+            # Upload the packaged release file
+            - name: Upload zip file
+              id: upload-zip
+              uses: actions/upload-release-asset@v1
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              with:
+                  upload_url: ${{ steps.create_release.outputs.upload_url }}
+                  asset_path: ./${{ github.event.repository.name }}.zip
+                  asset_name: ${{ github.event.repository.name }}-${{ steps.version.outputs.tag }}.zip
+                  asset_content_type: application/zip
+            # Upload the main.js
+            - name: Upload main.js
+              id: upload-main
+              uses: actions/upload-release-asset@v1
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              with:
+                  upload_url: ${{ steps.create_release.outputs.upload_url }}
+                  asset_path: ./main.js
+                  asset_name: main.js
+                  asset_content_type: text/javascript
+            # Upload the manifest.json
+            - name: Upload manifest.json
+              id: upload-manifest
+              uses: actions/upload-release-asset@v1
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              with:
+                  upload_url: ${{ steps.create_release.outputs.upload_url }}
+                  asset_path: ./manifest.json
+                  asset_name: manifest.json
+                  asset_content_type: application/json

README.md

@@ -1,68 +1,5 @@
-## Obsidian Sample Plugin
+## Obsidian Frontmatter Tag Suggest
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+Autocompletes tags in the YAML frontmatter. It will show an autocompletion menu if you are on a line starting with `tags:`
 
-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. 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
+That's it. That's the plugin

main.ts

@@ -1,8 +1,87 @@
-import { Plugin } from "obsidian";
-import TagSuggest from "TagSuggest";
+import {
+	Editor,
+	EditorPosition,
+	EditorSuggest,
+	EditorSuggestContext,
+	EditorSuggestTriggerInfo,
+	getAllTags,
+	Plugin,
+	TFile,
+} from "obsidian";
 
 export default class FrontmatterTagSuggestPlugin extends Plugin {
 	async onload() {
 		this.registerEditorSuggest(new TagSuggest(this));
 	}
 }
+
+class TagSuggest extends EditorSuggest<string> {
+	plugin: FrontmatterTagSuggestPlugin;
+	tags: string[];
+
+	constructor(plugin: FrontmatterTagSuggestPlugin) {
+		super(plugin.app);
+		this.plugin = plugin;
+	}
+
+	getTags(): string[] {
+		const app = this.plugin.app;
+		let tags: string[] = [];
+		const files = app.vault.getMarkdownFiles();
+		files.forEach((p) => {
+			const cache = app.metadataCache.getFileCache(p);
+			tags.push(...getAllTags(cache));
+		});
+		return [...new Set(tags)].sort().map((p) => p.split("#").pop());
+	}
+
+	onTrigger(
+		cursor: EditorPosition,
+		editor: Editor,
+		_: TFile
+	): EditorSuggestTriggerInfo | null {
+		const onFrontmatterTagLine = editor
+			.getLine(cursor.line)
+			.toLowerCase()
+			.startsWith("tags:");
+		if (onFrontmatterTagLine) {
+			const sub = editor.getLine(cursor.line).substring(0, cursor.ch);
+			const match = sub.match(/(?<= )\S+$/)?.first();
+			if (match) {
+				this.tags = this.getTags();
+				const matchData = {
+					end: cursor,
+					start: {
+						ch: sub.lastIndexOf(match),
+						line: cursor.line,
+					},
+					query: match,
+				};
+				return matchData;
+			}
+		}
+		return null;
+	}
+
+	getSuggestions(context: EditorSuggestContext): string[] {
+		const suggestions = this.tags.filter((p) =>
+			p.toLowerCase().contains(context.query.toLowerCase())
+		);
+		return suggestions;
+	}
+
+	renderSuggestion(suggestion: string, el: HTMLElement): void {
+		const outer = el.createDiv({ cls: "ES-suggester-container" });
+		outer.createDiv({ cls: "ES-tags" }).setText(`#${suggestion}`);
+	}
+
+	selectSuggestion(suggestion: string): void {
+		if (this.context) {
+			(this.context.editor as Editor).replaceRange(
+				`${suggestion} `,
+				this.context.start,
+				this.context.end
+			);
+		}
+	}
+}