refactor: use PluginSettings instead of js object

typora-community-plugin · Aug 21, 2023 · c6235c6 · c6235c6
1 parent af52bb6
commit c6235c6
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 107 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 English | [简体中文](https://github.com/typora-community-plugin/typora-plugin-front-matter/blob/main/README.zh-CN.md)
 
-This a plugin example based on [typora-community-plugin](https://github.com/typora-community-plugin/typora-community-plugin) for [Typora](https://typora.io).
+This a plugin based on [typora-community-plugin](https://github.com/typora-community-plugin/typora-community-plugin) for [Typora](https://typora.io).
 
 Auto edit front matter:
 

diff --git a/package.json b/package.json
@@ -14,17 +14,13 @@
   "author": "",
   "license": "MIT",
   "devDependencies": {
-    "@types/extract-zip": "1.6.2",
-    "@types/glob": "7.2.0",
     "@types/jquery": "3.3.1",
     "@types/lodash": "~4.14.197",
     "@types/node": "16.18.0",
-    "@types/typora": "npm:@typora-community-plugin/typora-types@^1.0.2",
-    "@types/yauzl": "2.10.0",
-    "@typora-community-plugin/core": "^2.0.0-beta.10",
-    "archiver": "^5.3.1",
+    "@types/typora": "npm:@typora-community-plugin/typora-types@^1.0.3",
+    "@typora-community-plugin/core": "2.0.0-beta.21",
+    "archiver": "^5.3.2",
     "esbuild": "^0.18.20",
-    "esbuild-plugin-typora": "npm:@typora-community-plugin/esbuild-plugin-typora@^1.0.3",
-    "iconv-lite": "0.6.3"
+    "esbuild-plugin-typora": "npm:@typora-community-plugin/esbuild-plugin-typora@^1.0.5"
   }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/main.ts b/src/main.ts
@@ -1,21 +1,21 @@
-import { Plugin } from '@typora-community-plugin/core'
+import { Plugin, PluginSettings } from '@typora-community-plugin/core'
 import { editor, getMarkdown } from 'typora'
 import { FrontMatterSettingTab } from './setting-tab'
 import { DEFAULT_SETTINGS, FrontMatterSettings } from './settings'
 
 
-export default class extends Plugin {
-
-  settings: FrontMatterSettings
+export default class extends Plugin<FrontMatterSettings> {
 
   async onload() {
 
     const { app } = this
 
-    await this.loadSettings()
+    this.registerSettings(
+      new PluginSettings(app, this.manifest, {
+        version: 1,
+      }))
 
-    this.register(
-      app.vault.on('mounted', () => this.loadSettings()))
+    this.settings.setDefault(DEFAULT_SETTINGS)
 
     this.register(
       app.workspace.on('file:open', () => {
@@ -26,7 +26,7 @@ export default class extends Plugin {
           editor.stylize.insertMetaBlock()
         }
         if (isEmptyDoc) {
-          docMenu.writeProperty(this.settings.propNameCreated, nowDatetime(this.settings.dateFormat))
+          docMenu.writeProperty(this.settings.get('propNameCreated'), nowDatetime(this.settings.get('dateFormat')))
         }
       }))
 
@@ -37,22 +37,11 @@ export default class extends Plugin {
         if (docMenu.getMetaNode()) {
           editor.stylize.insertMetaBlock()
         }
-        docMenu.writeProperty(this.settings.propNameUpdated, nowDatetime(this.settings.dateFormat))
+        docMenu.writeProperty(this.settings.get('propNameUpdated'), nowDatetime(this.settings.get('dateFormat')))
       }))
 
     this.registerSettingTab(new FrontMatterSettingTab(this))
   }
-
-  onunload() {
-  }
-
-  async loadSettings() {
-    this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData())
-  }
-
-  async saveSettings() {
-    await this.saveData(this.settings)
-  }
 }
 
 function nowDatetime(format: string) {

diff --git a/src/manifest.json b/src/manifest.json
@@ -4,7 +4,7 @@
   "description": "Auto edit front matter.",
   "author": "plylrnsdy",
   "authorUrl": "https://github.com/plylrnsdy",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "minAppVersion": "1.5.0",
-  "minCoreVersion": "2.0.0-beta.10"
+  "minCoreVersion": "2.0.0-beta.21"
 }
diff --git a/src/setting-tab.ts b/src/setting-tab.ts
@@ -34,9 +34,6 @@ export class FrontMatterSettingTab extends SettingTab {
     super()
   }
 
-  onload() {
-  }
-
   show() {
     const { plugin } = this
     const { t } = this.i18n
@@ -47,11 +44,10 @@ export class FrontMatterSettingTab extends SettingTab {
       setting.addName(t.propCreated)
       setting.addDescription(t.propCreatedDesc)
       setting.addText(input => {
-        input.value = plugin.settings.propNameCreated
+        input.value = plugin.settings.get('propNameCreated')
         input.placeholder = DEFAULT_SETTINGS.propNameCreated
         input.oninput = () => {
-          plugin.settings.propNameCreated = input.value ?? DEFAULT_SETTINGS.propNameCreated
-          plugin.saveSettings()
+          plugin.settings.set('propNameCreated', input.value ?? DEFAULT_SETTINGS.propNameCreated)
         }
       })
     })
@@ -60,11 +56,10 @@ export class FrontMatterSettingTab extends SettingTab {
       setting.addName(t.propUpdated)
       setting.addDescription(t.propUpdatedDesc)
       setting.addText(input => {
-        input.value = plugin.settings.propNameUpdated
+        input.value = plugin.settings.get('propNameUpdated')
         input.placeholder = DEFAULT_SETTINGS.propNameUpdated
         input.oninput = () => {
-          plugin.settings.propNameUpdated = input.value ?? DEFAULT_SETTINGS.propNameUpdated
-          plugin.saveSettings()
+          plugin.settings.set('propNameUpdated', input.value ?? DEFAULT_SETTINGS.propNameUpdated)
         }
       })
     })
@@ -73,11 +68,10 @@ export class FrontMatterSettingTab extends SettingTab {
       setting.addName(t.dateFormat)
       setting.addDescription(t.dateFormatDesc)
       setting.addText(input => {
-        input.value = plugin.settings.dateFormat
+        input.value = plugin.settings.get('dateFormat')
         input.placeholder = DEFAULT_SETTINGS.dateFormat
         input.oninput = () => {
-          plugin.settings.dateFormat = input.value ?? DEFAULT_SETTINGS.dateFormat
-          plugin.saveSettings()
+          plugin.settings.set('dateFormat', input.value ?? DEFAULT_SETTINGS.dateFormat)
         }
       })
     })

diff --git a/test/vault/.typora/core.json b/test/vault/.typora/core.json
@@ -1,8 +1,7 @@
 {
-  "version": "2.0.0-beta.1",
+  "version": 1,
   "settings": {
-    "githubPluginListUri": "jsdelivr",
-    "githubDownloadUri": "ghproxy",
+    "githubProxy": "ghproxy",
     "showRibbon": true,
     "showFileTabs": true
   }

diff --git a/test/vault/.typora/data/typora-community-plugin.front-matter.json b/test/vault/.typora/data/typora-community-plugin.front-matter.json
diff --git a/test/vault/doc.md b/test/vault/doc.md
@@ -1,4 +1,10 @@
+---
+created: 2023-08-21 21:04:43
+updated: 2023-08-21 21:04:47
+---
+
 # Title
 
 Lorem, ipsum dolor sit amet consectetur adipisicing elit.
 Adipisci nesciunt dolorem, blanditiis ea facilis, omnis dignissimos, eligendi architecto ducimus veniam necessitatibus illum assumenda id culpa officiis explicabo delectus sequi! Quas.
+