Prepped the plugin for PR.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,33 +1,24 @@
-# Obsidian Sample Plugin
+# Unfilled Stats Highlighter
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+https://img.shields.io/badge/version-1.0.0-green
+
+The Unfilled Stats Highlighter is a practical [Obsidian](https://obsidian.md) plugin designed to streamline your stat/habit tracking process by automatically identifying and prefixing unfilled stats, making them easier to spot and fill out. This plugin is perfect for users who frequently work with templates and require a quick and easy way to locate and complete missing information.
 
 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.
+# License
 
-## First time developing plugins?
+https://img.shields.io/badge/license-MIT-blue
 
-Quick starting guide for new plugin devs:
+# Features
 
-- 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.
+-   **Automatic Prefixing**: The plugin scans your notes for unfilled stats and prefixes them with a customizable marker, making it easier to locate and complete the missing information.
+-   **Customizable Markers**: Choose your preferred prefix for unfilled stats, such as an emoji, special character, or text, to draw attention to the areas that require completion.
+-   **Real-time Updates**: As you fill out the missing information, the plugin automatically removes the prefix, keeping your notes clean and up-to-date.
+-   **Configurable**: The Unfilled Stats Highlighter plugin seamlessly integrates with Obsidian, allowing you to easily configure the highlighter to only target your stat files.
 
 ## Releasing new releases
 
@@ -58,6 +49,7 @@ Quick starting guide for new plugin devs:
 -   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`
@@ -67,30 +59,6 @@ Quick starting guide for new plugin devs:
 -   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

main.ts

@@ -1,23 +1,28 @@
-import { App, MarkdownView, Plugin, PluginSettingTab, Setting } from "obsidian";
+import {
+	App,
+	MarkdownView,
+	Plugin,
+	PluginSettingTab,
+	Setting,
+	normalizePath,
+} from "obsidian";
 
-// Remember to rename these classes and interfaces!
-
-interface EmptyStatsHighlighterSettings {
+interface UnfilledStatsHighlighterSettings {
 	statRegex: string;
 	unfilledStatPrefix: string;
 	templatesDirectory: string;
 	targetHighlightingDirectory: string;
 }
 
-const DEFAULT_SETTINGS: EmptyStatsHighlighterSettings = {
+const DEFAULT_SETTINGS: UnfilledStatsHighlighterSettings = {
 	statRegex: "^.*\\: $",
 	unfilledStatPrefix: "__",
 	templatesDirectory: "Templates",
 	targetHighlightingDirectory: "Journaling",
 };
 
-export default class EmptyStatsHighlighter extends Plugin {
-	settings: EmptyStatsHighlighterSettings;
+export default class UnfilledStatsHighlighter extends Plugin {
+	settings: UnfilledStatsHighlighterSettings;
 
 	// Runs whenever the user starts using the plugin in Obsidian.
 	// This is where you'll configure most of the plugin's capabilities.
@@ -27,7 +32,9 @@ export default class EmptyStatsHighlighter extends Plugin {
 
 		// This adds a settings tab so the user can configure various aspects of
 		// the plugin.
-		this.addSettingTab(new SettingsTab(this.app, this));
+		this.addSettingTab(
+			new UnfilledStatsHighlighterSettingsTab(this.app, this)
+		);
 
 		// If the plugin hooks up any global DOM events (on parts of the app that
 		// doesn't belong to this plugin)
@@ -102,10 +109,10 @@ export default class EmptyStatsHighlighter extends Plugin {
 	}
 }
 
-class SettingsTab extends PluginSettingTab {
-	plugin: EmptyStatsHighlighter;
+class UnfilledStatsHighlighterSettingsTab extends PluginSettingTab {
+	plugin: UnfilledStatsHighlighter;
 
-	constructor(app: App, plugin: EmptyStatsHighlighter) {
+	constructor(app: App, plugin: UnfilledStatsHighlighter) {
 		super(app, plugin);
 		this.plugin = plugin;
 	}
@@ -116,7 +123,7 @@ class SettingsTab extends PluginSettingTab {
 		containerEl.empty();
 
 		containerEl.createEl("h2", {
-			text: "Empty Stats Highlighter Settings",
+			text: "Unfilled Stats Highlighter Settings",
 		});
 
 		new Setting(containerEl)
@@ -157,7 +164,8 @@ class SettingsTab extends PluginSettingTab {
 					.setPlaceholder("Directory")
 					.setValue(this.plugin.settings.templatesDirectory)
 					.onChange(async (value) => {
-						this.plugin.settings.templatesDirectory = value;
+						this.plugin.settings.templatesDirectory =
+							normalizePath(value);
 						await this.plugin.saveSettings();
 					})
 			);
@@ -171,7 +179,7 @@ class SettingsTab extends PluginSettingTab {
 					.setValue(this.plugin.settings.targetHighlightingDirectory)
 					.onChange(async (value) => {
 						this.plugin.settings.targetHighlightingDirectory =
-							value;
+							normalizePath(value);
 						await this.plugin.saveSettings();
 					})
 			);

manifest.json

@@ -1,11 +1,9 @@
 {
 	"id": "obsidian-hd-empty-stats-highlighter",
-	"name": "Empty Stats Highlighter",
-	"version": "0.0.1",
+	"name": "Unfilled Stats Highlighter",
+	"version": "1.0.0",
 	"minAppVersion": "0.15.0",
 	"description": "The Unfilled Stats Highlighter is a practical Obsidian plugin designed to streamline your stat/habit tracking process by automatically identifying and prefixing unfilled stats, making them easier to spot and fill out. This plugin is perfect for users who frequently work with templates and require a quick and easy way to locate and complete missing information.",
-	"author": "HynesDevelopment",
-	"authorUrl": "https://obsidian.md",
-	"fundingUrl": "https://obsidian.md/pricing",
+	"author": "Zachary Hynes",
 	"isDesktopOnly": false
 }