update readme; rename some things

Author: mProjectsCode

README.md

@@ -1,98 +1,31 @@
-# Obsidian Sample Plugin
+# Lemons Plugin Template
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+## Setup
 
-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.
+This uses [bun](https://bun.sh/), not node. So you need that installed. If you are on windows use WSL, if that does not work... good luck.
 
-**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
+Things to change Checklist:
+- [ ] `manifest.json`
+- [ ] `package.json`
+- [ ] `versions.json`
+- [ ] `automation/config.js`
+- [ ] rename `exampleVault/.obsidian/lemons-plugin-template`
 
-This sample plugin demonstrates some of the basic functionality the plugin API can do.
+If and **only if** you completed these steps, you can run `bun install` and `bun run dev` to start your plugin jorney.
 
--   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.
+## Scripts Explained
 
-## First time developing plugins?
+- `dev` - build into the example vault with hot reload
+- `build` - build for release
+- `test` - run your tests
+- `format` - format your code
+- `lint` - lint your code
+- `lint:fix` - lint your code and fix auto fixable mistakes
+- `release` - run the script to release a new version
 
-Quick starting guide for new plugin devs:
+## References
 
--   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.
--   Make sure your NodeJS is at least v16 (`node --version`).
--   `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
+Sample plugin repo: https://github.com/obsidianmd/obsidian-sample-plugin
+Obsidian help: https://help.obsidian.md/Home
+Obsidian docs: https://docs.obsidian.md/Home
+Obsidian API: https://github.com/obsidianmd/obsidian-api/blob/master/obsidian.d.ts

automation/version.ts renamed to automation/release.ts

@@ -1,6 +1,6 @@
-import { $, $seq, Verboseness, $input, $choise, $confirm, CMD_FMT } from './shellUtils';
+import { $seq, Verboseness, $input, $choise, $confirm, CMD_FMT } from './shellUtils';
 import config from './config.json';
-import { Version, getIncrementOptions, parseVersion, stringifyVersion, versionParser } from 'versionUtils';
+import { Version, getIncrementOptions, parseVersion, stringifyVersion } from 'versionUtils';
 import { UserError } from 'utils';
 
 async function runPreconditions(): Promise<void> {

package.json

@@ -6,12 +6,11 @@
 	"scripts": {
 		"dev": "bun esbuild.dev.config.mjs",
 		"build": "tsc -noEmit -skipLibCheck && bun esbuild.config.mjs production",
-		"version": "node version-bump.mjs && git add manifest.json versions.json",
 		"test": "bun test",
 		"format": "prettier --write .",
 		"lint": "eslint --max-warnings=0 src/**",
 		"lint:fix": "eslint --max-warnings=0 --fix src/**",
-		"commit": "bun run automation/commit.ts"
+		"release": "bun run automation/release.ts"
 	},
 	"keywords": [],
 	"author": "Moritz Jung",