chore: better workflow

Author: nekomeowww

.gitignore

@@ -4,7 +4,6 @@ node_modules
 # Don't include the compiled main.js file in the repo.
 # They should be uploaded to GitHub releases instead.
 main.js
-manifest.json
 
 # Exclude sourcemaps
 *.map

README.md

@@ -1,72 +1,18 @@
-# Obsidian Template Plugin
+# Obsidian Plugin Vue
 
 > [!NOTE]
 > This is one of the plugins of the collections of plugins called [Nólëbase Integrations](https://github.com/nolebase/integrations). You can explore the other plugins in the collection in [the official documentation site of Nólëbase Integrations](https://nolebase-integrations.ayaka.io).
 
 ---
 
-## ⚠️ To you, the plugin developer.
-
-This is a template plugin for you to start developing your own Obsidian plugin. It is a good starting point for you to develop your own plugin. You can clone this repository and start developing your own plugin.
-
-We use the most advanced technologies to develop this plugin, including:
-
-- [TypeScript](https://www.typescriptlang.org/)
-- [unbuild](https://github.com/unjs/unbuild)
-- [eslint](https://eslint.org/)
-
-So everything is configured for you to start developing your own plugin, immediately.
-
-## ⚠️ Before publishing
-
-1. Replace all the `obsidian-plugin-template` with the name of your plugin:
-   1. In the `manifest.json` file.
-   2. In the `package.json` file.
-   3. In the `README.md` file.
-2. Replace all the `Obsidian Template Plugin` with the name of your plugin:
-   1. In the `manifest.json` file.
-   2. In the `package.json` file.
-   3. In the `README.md` file.
-3. Fill in a URL to your repository. You can replace with `https://github.com/nolebase/obsidian-plugin-template`
-4. Fill in the Why, Features, What can you do with it, Demos, How to install, TODOs, feel free to remove the sections that are not needed.
-
-## ⚠️ How to publish?
-
-1. Modify the version in the `manifest.json` file.
-2. Modify the version in the `package.json` file.
-3. Push the changes to the repository.
-4. Go to the [Release] page of the repository.
-5. Create a new release with the tag name as the version number.
-6. Sit back and relax, the plugin will be published with CI/CD pipelines automatically.
-
-## 🤔 Why
-
-Introduce your plugin! Explain why you made it, why would users choose yours!
-
-## 🎨 Features
-
-- 📦 Out of the box support.
-- 🚀 Blazingly fast.
-- 💡 You define it.
-
-## 💡 What can you do with it
-
-- Help users to imagine what they can do, show your imagination.
-
-## 📺 Demos
-
-> Show me what you can do
-
-### How it looks like
-
-Perhaps a GIF?
+**Write your notes in [Obsidian](https://obsidian.md/) with [Vue.js](https://vuejs.org/).**
 
 ## 😎 How to install
 
 > [!WARNING]
-> Currently Obsidian Template Plugin is in alpha stage, it wasn't guaranteed to work properly and keep the compatibility with the future versions of itself.
+> Currently Obsidian Vue Plugin is in alpha stage, it wasn't guaranteed to work properly and keep the compatibility with the future versions of itself.
 >
-> But it is encouraged to try it out and give feedbacks. If you find and bugs or have any suggestions, please feel free to open an issue on [GitHub](https://github.com/nolebase/obsidian-plugin-template/issues).
+> But it is encouraged to try it out and give feedbacks. If you find and bugs or have any suggestions, please feel free to open an issue on [GitHub](https://github.com/nolebase/obsidian-plugin-vue/issues).
 
 Currently, it is a bit hard to install the plugin for now before it is published to the official Obsidian plugin store. Manual downloading and installation is required.
 
@@ -78,21 +24,21 @@ Currently, it is a bit hard to install the plugin for now before it is published
 4. Copy and paste the following link to the first field of the new prompted dialog:
 
 ```txt
-https://github.com/nolebase/obsidian-plugin-template
+https://github.com/nolebase/obsidian-plugin-vue
 ```
 
-5. Find the needed released version on [Release page of Obsidian UnoCSS Plugin](https://github.com/nolebase/obsidian-plugin-template/releases), for example, fill in `0.1.0`.
-6. Enable the "Obsidian Template Plugin" plugin from the `Installed plugins` list.
+5. Find the needed released version on [Release page of Obsidian Vue Plugin](https://github.com/nolebase/obsidian-plugin-vue/releases), for example, fill in `0.1.0`.
+6. Enable the "Vue" plugin from the `Installed plugins` list.
 
 ### Install manually
 
-1. Navigate to the [Release page of Obsidian Template Plugin](https://github.com/nolebase/obsidian-plugin-template/releases)
-2. Find the [latest version of the plugin](https://github.com/nolebase/obsidian-plugin-template/releases/latest).
+1. Navigate to the [Release page of Obsidian Vue Plugin](https://github.com/nolebase/obsidian-plugin-vue/releases)
+2. Find the [latest version of the plugin](https://github.com/nolebase/obsidian-plugin-vue/releases/latest).
 3. Download the `main.js` file and `manifest.json` file.
 4. Open up the `.obsidian/plugins` directory of your Obsidian vault.
 5. If no `.obsidian/plugins` directory exists, create one.
-6. Create a new directory named `obsidian-plugin-template` inside the `.obsidian/plugins` directory.
-7. Move `main.js` file and `manifest.json` file into the `obsidian-plugin-template` directory.
+6. Create a new directory named `obsidian-plugin-vue` inside the `.obsidian/plugins` directory.
+7. Move `main.js` file and `manifest.json` file into the `obsidian-plugin-vue` directory.
 
 The directory structure should look like this after these steps:
 
@@ -103,11 +49,12 @@ The directory structure should look like this after these steps:
 ├── manifest.json
 ```
 
-8. Enable the "Obsidian Template Plugin" plugin from the "Installed plugins" list.
+8. Enable the "Vue" plugin from the "Installed plugins" list.
 
 ## ⏳ TODOs
 
-- [ ] Anything on the roadmap?
+- [ ] Auto completion for CSS classes.
+- [ ] Annotation decoration for Vue identifiable classes.
 
 ## 💻 How to develop
 

build.config.ts

@@ -1,6 +1,5 @@
 import { copyFile, rm } from 'node:fs/promises'
 import { join } from 'node:path'
-
 import { cwd } from 'node:process'
 import builtins from 'builtin-modules'
 import { defineBuildConfig } from 'unbuild'

bump.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'bumpp'
+
+export default defineConfig({
+  commit: 'release: v%s',
+  sign: true,
+  tag: '%s',
+})

eslint.config.mjs renamed to eslint.config.ts

@@ -0,0 +1,10 @@
+{
+  "id": "obsidian-plugin-vue",
+  "name": "Vue",
+  "version": "0.1.0",
+  "minAppVersion": "1.4.0",
+  "description": "An Obsidian plugin that enables you to use Vue.js components in your notes.",
+  "author": "Nolebase",
+  "authorUrl": "https://github.com/nolebase",
+  "isDesktopOnly": false
+}

manifest.json

@@ -34,6 +34,7 @@
     "@unrteljs/eval": "^0.0.5",
     "@vue/compiler-sfc": "^3.5.14",
     "builtin-modules": "^5.0.0",
+    "bumpp": "^10.1.0",
     "eslint": "^9.26.0",
     "hast-util-to-html": "^9.0.5",
     "obsidian": "^1.8.7",