From 2e1928ec600aad274c82e60b2de775dba452a352 Mon Sep 17 00:00:00 2001 From: zigholding Date: Mon, 22 Apr 2024 21:27:53 +0800 Subject: [PATCH] export_readme --- .editorconfig | 10 +++ .eslintignore | 3 + .eslintrc | 23 +++++++ .gitignore | 26 ++++++++ .npmrc | 1 + README.md | 96 +++++++++++++++++++++++++++++ data.json | 3 + esbuild.config.mjs | 48 +++++++++++++++ main.js | 142 ++++++++++++++++++++++++++++++++++++++++++ main.ts | 149 +++++++++++++++++++++++++++++++++++++++++++++ manifest.json | 9 +++ package.json | 24 ++++++++ styles.css | 8 +++ tsconfig.json | 24 ++++++++ version-bump.mjs | 14 +++++ versions.json | 3 + 16 files changed, 583 insertions(+) create mode 100644 .editorconfig create mode 100644 .eslintignore create mode 100644 .eslintrc create mode 100644 .gitignore create mode 100644 .npmrc create mode 100644 README.md create mode 100644 data.json create mode 100644 esbuild.config.mjs create mode 100644 main.js create mode 100644 main.ts create mode 100644 manifest.json create mode 100644 package.json create mode 100644 styles.css create mode 100644 tsconfig.json create mode 100644 version-bump.mjs create mode 100644 versions.json diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..81f3ec3 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,10 @@ +# top-most EditorConfig file +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +indent_style = tab +indent_size = 4 +tab_width = 4 diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..e019f3c --- /dev/null +++ b/.eslintignore @@ -0,0 +1,3 @@ +node_modules/ + +main.js diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 0000000..0807290 --- /dev/null +++ b/.eslintrc @@ -0,0 +1,23 @@ +{ + "root": true, + "parser": "@typescript-eslint/parser", + "env": { "node": true }, + "plugins": [ + "@typescript-eslint" + ], + "extends": [ + "eslint:recommended", + "plugin:@typescript-eslint/eslint-recommended", + "plugin:@typescript-eslint/recommended" + ], + "parserOptions": { + "sourceType": "module" + }, + "rules": { + "no-unused-vars": "off", + "@typescript-eslint/no-unused-vars": ["error", { "args": "none" }], + "@typescript-eslint/ban-ts-comment": "off", + "no-prototype-builtins": "off", + "@typescript-eslint/no-empty-function": "off" + } + } \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d4aeb0a --- /dev/null +++ b/.gitignore @@ -0,0 +1,26 @@ +# vscode +.vscode + +# Intellij +*.iml +.idea + +# npm +node_modules + +# Don't include the compiled main.js file in the repo. +# They should be uploaded to GitHub releases instead. +# main.js + +# Exclude sourcemaps +*.map +tmp* + +# obsidian +# data.json + +# Exclude macOS Finder (System Explorer) View States +.DS_Store + +package-lock.json +otherplugins \ No newline at end of file diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..b973752 --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +tag-version-prefix="" \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..bb0348e --- /dev/null +++ b/README.md @@ -0,0 +1,96 @@ +# Obsidian Sample Plugin + +This is a sample plugin for Obsidian (https://obsidian.md). + +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. +- 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: + +- 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 diff --git a/data.json b/data.json new file mode 100644 index 0000000..30b7063 --- /dev/null +++ b/data.json @@ -0,0 +1,3 @@ +{ + "mySetting": "D:/iLanix/isync/test" +} \ No newline at end of file diff --git a/esbuild.config.mjs b/esbuild.config.mjs new file mode 100644 index 0000000..b13282b --- /dev/null +++ b/esbuild.config.mjs @@ -0,0 +1,48 @@ +import esbuild from "esbuild"; +import process from "process"; +import builtins from "builtin-modules"; + +const banner = +`/* +THIS IS A GENERATED/BUNDLED FILE BY ESBUILD +if you want to view the source, please visit the github repository of this plugin +*/ +`; + +const prod = (process.argv[2] === "production"); + +const context = await esbuild.context({ + banner: { + js: banner, + }, + entryPoints: ["main.ts"], + bundle: true, + external: [ + "obsidian", + "electron", + "@codemirror/autocomplete", + "@codemirror/collab", + "@codemirror/commands", + "@codemirror/language", + "@codemirror/lint", + "@codemirror/search", + "@codemirror/state", + "@codemirror/view", + "@lezer/common", + "@lezer/highlight", + "@lezer/lr", + ...builtins], + format: "cjs", + target: "es2018", + logLevel: "info", + sourcemap: prod ? false : "inline", + treeShaking: true, + outfile: "main.js", +}); + +if (prod) { + await context.rebuild(); + process.exit(0); +} else { + await context.watch(); +} \ No newline at end of file diff --git a/main.js b/main.js new file mode 100644 index 0000000..dcf6aa1 --- /dev/null +++ b/main.js @@ -0,0 +1,142 @@ +/* +THIS IS A GENERATED/BUNDLED FILE BY ESBUILD +if you want to view the source, please visit the github repository of this plugin +*/ + +var __defProp = Object.defineProperty; +var __getOwnPropDesc = Object.getOwnPropertyDescriptor; +var __getOwnPropNames = Object.getOwnPropertyNames; +var __hasOwnProp = Object.prototype.hasOwnProperty; +var __export = (target, all) => { + for (var name in all) + __defProp(target, name, { get: all[name], enumerable: true }); +}; +var __copyProps = (to, from, except, desc) => { + if (from && typeof from === "object" || typeof from === "function") { + for (let key of __getOwnPropNames(from)) + if (!__hasOwnProp.call(to, key) && key !== except) + __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable }); + } + return to; +}; +var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod); + +// main.ts +var main_exports = {}; +__export(main_exports, { + default: () => VaultExpoterPlugin +}); +module.exports = __toCommonJS(main_exports); +var import_obsidian = require("obsidian"); +var fs = require("fs"); +var DEFAULT_SETTINGS = { + mySetting: "default" +}; +var VaultExpoterPlugin = class extends import_obsidian.Plugin { + async onload() { + await this.loadSettings(); + this.app.vt = this; + this.fs = fs; + this.root = this.app.vault.adapter.basePath; + this.addSettingTab(new VExporterSettingTab(this.app, this)); + } + onunload() { + } + async loadSettings() { + this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData()); + } + async saveSettings() { + await this.saveData(this.settings); + } + /** + * 附件 src 到 dst，不在 vault 中，需要绝对路径 + * overwrite，复盖；mtime，新文件； + */ + copy_file_by_path(src, dst, mode = "overwrite>mtime>pass") { + mode = mode.split(">")[0]; + if (!fs.existsSync(src)) { + return; + } + if (fs.existsSync(dst)) { + if (mode === "overwrite") { + fs.unlinkSync(dst); + fs.copyFileSync(src, dst); + } else if (mode === "mtime") { + if (fs.statSync(dst).mtimeMs < fs.statSync(src).mtimeMs) { + fs.unlinkSync(dst); + fs.copyFileSync(src, dst); + } + } + } else { + fs.copyFileSync(src, dst); + } + } + abspath(tfile) { + if (tfile) { + return this.root + "/" + tfile.path; + } else { + return null; + } + } + copy_tfile(tfile, dst) { + if (tfile) { + let src = this.abspath(tfile); + src && this.copy_file_by_path(src, dst); + } + } + async export_readme(tfile, dst, as_readme = true, assets = "assets") { + let nc = this.app.plugins.getPlugin("note-chain"); + if (!tfile) { + tfile = nc.chain.current_note; + } + if (!dst) { + dst = "LocalGitProject"; + } + if (!dst.contains("/")) { + dst = nc.editor.get_frontmatter(tfile, dst); + } + if (!dst) { + dst = await nc.chain.tp_prompt("Path of LocalGitProject"); + if (!dst) { + return; + } + } + dst = dst.replace(/\\/g, "/"); + if (!fs.existsSync(dst)) { + console.log("No Dir:", dst); + } + console.log(dst); + let olinks = nc.chain.get_outlinks(tfile); + let tmp; + if (as_readme) { + tmp = dst + "/readMe.md"; + } else { + tmp = dst + "/" + tfile.basename + ".md"; + } + this.copy_tfile(tfile, tmp); + let adir = dst + "/" + assets; + if (!fs.existsSync(adir)) { + fs.mkdirSync(adir); + } + for (let f of olinks) { + if (!(f.extension === "md")) { + this.copy_tfile(f, adir + "/" + f.basename + "." + f.extension); + } + } + } +}; +var VExporterSettingTab = class extends import_obsidian.PluginSettingTab { + constructor(app, plugin) { + super(app, plugin); + this.plugin = plugin; + } + display() { + const { containerEl } = this; + containerEl.empty(); + new import_obsidian.Setting(containerEl).setName("Setting #1").setDesc("It's a secret").addTextArea((text) => text.setPlaceholder("Enter your secret").setValue(this.plugin.settings.mySetting).onChange(async (value) => { + this.plugin.settings.mySetting = value; + await this.plugin.saveSettings(); + })); + } +}; +//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["main.ts"],
  "sourcesContent": ["import * as Module from 'module';\r\nimport { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting, TFile } from 'obsidian';\r\n\r\n// Remember to rename these classes and interfaces!\r\n\r\nconst fs = require('fs');\r\n\r\ninterface VExporterSettings {\r\n\tmySetting: string;\r\n}\r\n\r\nconst DEFAULT_SETTINGS: VExporterSettings = {\r\n\tmySetting: 'default'\r\n}\r\n\r\nexport default class VaultExpoterPlugin extends Plugin {\r\n\tsettings: VExporterSettings;\r\n\troot : string;\r\n\r\n\tasync onload() {\r\n\t\tawait this.loadSettings();\r\n\t\tthis.app.vt = this;\r\n\t\tthis.fs = fs;\r\n\t\tthis.root = this.app.vault.adapter.basePath;\r\n\t\t// This adds a settings tab so the user can configure various aspects of the plugin\r\n\t\tthis.addSettingTab(new VExporterSettingTab(this.app, this));\r\n\t}\r\n\r\n\tonunload() {\r\n\r\n\t}\r\n\r\n\tasync loadSettings() {\r\n\t\tthis.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());\r\n\t}\r\n\r\n\tasync saveSettings() {\r\n\t\tawait this.saveData(this.settings);\r\n\t}\r\n\r\n\t/**\r\n\t* \u9644\u4EF6 src \u5230 dst\uFF0C\u4E0D\u5728 vault \u4E2D\uFF0C\u9700\u8981\u7EDD\u5BF9\u8DEF\u5F84\r\n\t* overwrite\uFF0C\u590D\u76D6\uFF1Bmtime\uFF0C\u65B0\u6587\u4EF6\uFF1B\r\n\t*/\r\n\tcopy_file_by_path(src:string, dst:string,mode='overwrite>mtime>pass') {\r\n\t\tmode = mode.split('>')[0]\r\n\t\tif(!fs.existsSync(src)){\r\n\t\t\treturn;\r\n\t\t}\r\n\t\tif(fs.existsSync(dst)){\r\n\t\t\tif(mode==='overwrite'){\r\n\t\t\t\tfs.unlinkSync(dst);\r\n\t\t\t\tfs.copyFileSync(src,dst);\r\n\t\t\t}else if(mode==='mtime'){\r\n\t\t\t\t// dst \u66F4\u65B0\u65F6\u95F4\u5C0F\u4E8E src\r\n\t\t\t\tif(fs.statSync(dst).mtimeMs<fs.statSync(src).mtimeMs){\r\n\t\t\t\t\tfs.unlinkSync(dst);\r\n\t\t\t\t\tfs.copyFileSync(src,dst);\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t}else{\r\n\t\t\tfs.copyFileSync(src,dst);\r\n\t\t}\r\n\t}\r\n\r\n\tabspath(tfile:TFile){\r\n\t\tif(tfile){\r\n\t\t\treturn this.root+'/'+tfile.path;\r\n\t\t}else{\r\n\t\t\treturn null;\r\n\t\t}\r\n\t}\r\n\r\n\tcopy_tfile(tfile:TFile, dst:string) {\r\n\t\tif(tfile){\r\n\t\t\tlet src = this.abspath(tfile);\r\n\t\t\tsrc && this.copy_file_by_path(src,dst);\r\n\t\t}\r\n\t}\r\n\t\r\n\tasync export_readme(tfile:TFile,dst:string|null,as_readme=true,assets='assets'){\r\n\t\t\r\n\t\tlet nc = this.app.plugins.getPlugin('note-chain');\r\n\t\tif(!tfile){tfile = nc.chain.current_note;}\r\n\t\t\r\n\t\tif(!dst){\r\n\t\t\tdst = 'LocalGitProject';\r\n\t\t}\r\n\t\tif(!dst.contains('/')){\r\n\t\t\tdst = nc.editor.get_frontmatter(tfile,dst);\r\n\t\t}\r\n\r\n\t\tif(!dst){\r\n\t\t\tdst = await nc.chain.tp_prompt('Path of LocalGitProject');\r\n\t\t\tif(!dst){return;}\r\n\t\t}\r\n\t\tdst = dst.replace(/\\\\/g,'/');\r\n\t\tif(!fs.existsSync(dst)){\r\n\t\t\tconsole.log('No Dir:',dst);\r\n\t\t}\r\n\t\tconsole.log(dst);\r\n\t\tlet olinks = nc.chain.get_outlinks(tfile);\r\n\t\t\r\n\t\tlet tmp;\r\n\t\tif(as_readme){\r\n\t\t\ttmp = dst+'/'+'readMe.md';\r\n\t\t}else{\r\n\t\t\ttmp = dst+'/'+tfile.basename+'.md';\r\n\t\t}\r\n\r\n\t\tthis.copy_tfile(tfile,tmp);\r\n\r\n\t\tlet adir = dst+'/'+assets;\r\n\t\tif(!fs.existsSync(adir)){\r\n\t\t\tfs.mkdirSync(adir);\r\n\t\t}\r\n\t\tfor(let f of olinks){\r\n\t\t\tif(!(f.extension==='md')){\r\n\t\t\t\tthis.copy_tfile(f,adir+'/'+f.basename+'.'+f.extension);\r\n\t\t\t}\r\n\t\t}\r\n\t}\r\n}\r\n\r\nclass VExporterSettingTab extends PluginSettingTab {\r\n\tplugin: VaultExpoterPlugin;\r\n\r\n\tconstructor(app: App, plugin: VaultExpoterPlugin) {\r\n\t\tsuper(app, plugin);\r\n\t\tthis.plugin = plugin;\r\n\t}\r\n\r\n\tdisplay(): void {\r\n\t\tconst {containerEl} = this;\r\n\r\n\t\tcontainerEl.empty();\r\n\r\n\t\tnew Setting(containerEl)\r\n\t\t\t.setName('Setting #1')\r\n\t\t\t.setDesc('It\\'s a secret')\r\n\t\t\t.addTextArea(text => text\r\n\t\t\t\t.setPlaceholder('Enter your secret')\r\n\t\t\t\t.setValue(this.plugin.settings.mySetting)\r\n\t\t\t\t.onChange(async (value) => {\r\n\t\t\t\t\tthis.plugin.settings.mySetting = value;\r\n\t\t\t\t\tawait this.plugin.saveSettings();\r\n\t\t\t\t}));\r\n\t}\r\n}\r\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,sBAAmG;AAInG,IAAM,KAAK,QAAQ,IAAI;AAMvB,IAAM,mBAAsC;AAAA,EAC3C,WAAW;AACZ;AAEA,IAAqB,qBAArB,cAAgD,uBAAO;AAAA,EAItD,MAAM,SAAS;AACd,UAAM,KAAK,aAAa;AACxB,SAAK,IAAI,KAAK;AACd,SAAK,KAAK;AACV,SAAK,OAAO,KAAK,IAAI,MAAM,QAAQ;AAEnC,SAAK,cAAc,IAAI,oBAAoB,KAAK,KAAK,IAAI,CAAC;AAAA,EAC3D;AAAA,EAEA,WAAW;AAAA,EAEX;AAAA,EAEA,MAAM,eAAe;AACpB,SAAK,WAAW,OAAO,OAAO,CAAC,GAAG,kBAAkB,MAAM,KAAK,SAAS,CAAC;AAAA,EAC1E;AAAA,EAEA,MAAM,eAAe;AACpB,UAAM,KAAK,SAAS,KAAK,QAAQ;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,kBAAkB,KAAY,KAAW,OAAK,wBAAwB;AACrE,WAAO,KAAK,MAAM,GAAG,EAAE,CAAC;AACxB,QAAG,CAAC,GAAG,WAAW,GAAG,GAAE;AACtB;AAAA,IACD;AACA,QAAG,GAAG,WAAW,GAAG,GAAE;AACrB,UAAG,SAAO,aAAY;AACrB,WAAG,WAAW,GAAG;AACjB,WAAG,aAAa,KAAI,GAAG;AAAA,MACxB,WAAS,SAAO,SAAQ;AAEvB,YAAG,GAAG,SAAS,GAAG,EAAE,UAAQ,GAAG,SAAS,GAAG,EAAE,SAAQ;AACpD,aAAG,WAAW,GAAG;AACjB,aAAG,aAAa,KAAI,GAAG;AAAA,QACxB;AAAA,MACD;AAAA,IACD,OAAK;AACJ,SAAG,aAAa,KAAI,GAAG;AAAA,IACxB;AAAA,EACD;AAAA,EAEA,QAAQ,OAAY;AACnB,QAAG,OAAM;AACR,aAAO,KAAK,OAAK,MAAI,MAAM;AAAA,IAC5B,OAAK;AACJ,aAAO;AAAA,IACR;AAAA,EACD;AAAA,EAEA,WAAW,OAAa,KAAY;AACnC,QAAG,OAAM;AACR,UAAI,MAAM,KAAK,QAAQ,KAAK;AAC5B,aAAO,KAAK,kBAAkB,KAAI,GAAG;AAAA,IACtC;AAAA,EACD;AAAA,EAEA,MAAM,cAAc,OAAY,KAAgB,YAAU,MAAK,SAAO,UAAS;AAE9E,QAAI,KAAK,KAAK,IAAI,QAAQ,UAAU,YAAY;AAChD,QAAG,CAAC,OAAM;AAAC,cAAQ,GAAG,MAAM;AAAA,IAAa;AAEzC,QAAG,CAAC,KAAI;AACP,YAAM;AAAA,IACP;AACA,QAAG,CAAC,IAAI,SAAS,GAAG,GAAE;AACrB,YAAM,GAAG,OAAO,gBAAgB,OAAM,GAAG;AAAA,IAC1C;AAEA,QAAG,CAAC,KAAI;AACP,YAAM,MAAM,GAAG,MAAM,UAAU,yBAAyB;AACxD,UAAG,CAAC,KAAI;AAAC;AAAA,MAAO;AAAA,IACjB;AACA,UAAM,IAAI,QAAQ,OAAM,GAAG;AAC3B,QAAG,CAAC,GAAG,WAAW,GAAG,GAAE;AACtB,cAAQ,IAAI,WAAU,GAAG;AAAA,IAC1B;AACA,YAAQ,IAAI,GAAG;AACf,QAAI,SAAS,GAAG,MAAM,aAAa,KAAK;AAExC,QAAI;AACJ,QAAG,WAAU;AACZ,YAAM,MAAI;AAAA,IACX,OAAK;AACJ,YAAM,MAAI,MAAI,MAAM,WAAS;AAAA,IAC9B;AAEA,SAAK,WAAW,OAAM,GAAG;AAEzB,QAAI,OAAO,MAAI,MAAI;AACnB,QAAG,CAAC,GAAG,WAAW,IAAI,GAAE;AACvB,SAAG,UAAU,IAAI;AAAA,IAClB;AACA,aAAQ,KAAK,QAAO;AACnB,UAAG,EAAE,EAAE,cAAY,OAAM;AACxB,aAAK,WAAW,GAAE,OAAK,MAAI,EAAE,WAAS,MAAI,EAAE,SAAS;AAAA,MACtD;AAAA,IACD;AAAA,EACD;AACD;AAEA,IAAM,sBAAN,cAAkC,iCAAiB;AAAA,EAGlD,YAAY,KAAU,QAA4B;AACjD,UAAM,KAAK,MAAM;AACjB,SAAK,SAAS;AAAA,EACf;AAAA,EAEA,UAAgB;AACf,UAAM,EAAC,YAAW,IAAI;AAEtB,gBAAY,MAAM;AAElB,QAAI,wBAAQ,WAAW,EACrB,QAAQ,YAAY,EACpB,QAAQ,eAAgB,EACxB,YAAY,UAAQ,KACnB,eAAe,mBAAmB,EAClC,SAAS,KAAK,OAAO,SAAS,SAAS,EACvC,SAAS,OAAO,UAAU;AAC1B,WAAK,OAAO,SAAS,YAAY;AACjC,YAAM,KAAK,OAAO,aAAa;AAAA,IAChC,CAAC,CAAC;AAAA,EACL;AACD;",
  "names": []
}
 diff --git a/main.ts b/main.ts new file mode 100644 index 0000000..03e3a7d --- /dev/null +++ b/main.ts @@ -0,0 +1,149 @@ +import * as Module from 'module'; +import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting, TFile } from 'obsidian'; + +// Remember to rename these classes and interfaces! + +const fs = require('fs'); + +interface VExporterSettings { + mySetting: string; +} + +const DEFAULT_SETTINGS: VExporterSettings = { + mySetting: 'default' +} + +export default class VaultExpoterPlugin extends Plugin { + settings: VExporterSettings; + root : string; + + async onload() { + await this.loadSettings(); + this.app.vt = this; + this.fs = fs; + this.root = this.app.vault.adapter.basePath; + // This adds a settings tab so the user can configure various aspects of the plugin + this.addSettingTab(new VExporterSettingTab(this.app, this)); + } + + onunload() { + + } + + async loadSettings() { + this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData()); + } + + async saveSettings() { + await this.saveData(this.settings); + } + + /** + * 附件 src 到 dst，不在 vault 中，需要绝对路径 + * overwrite，复盖；mtime，新文件； + */ + copy_file_by_path(src:string, dst:string,mode='overwrite>mtime>pass') { + mode = mode.split('>')[0] + if(!fs.existsSync(src)){ + return; + } + if(fs.existsSync(dst)){ + if(mode==='overwrite'){ + fs.unlinkSync(dst); + fs.copyFileSync(src,dst); + }else if(mode==='mtime'){ + // dst 更新时间小于 src + if(fs.statSync(dst).mtimeMs text + .setPlaceholder('Enter your secret') + .setValue(this.plugin.settings.mySetting) + .onChange(async (value) => { + this.plugin.settings.mySetting = value; + await this.plugin.saveSettings(); + })); + } +} diff --git a/manifest.json b/manifest.json new file mode 100644 index 0000000..fb2ecd5 --- /dev/null +++ b/manifest.json @@ -0,0 +1,9 @@ +{ + "id": "vault-exporter", + "name": "Vault Exporter", + "version": "1.0.0", + "minAppVersion": "0.15.0", + "description": "Export current note to another Vault.", + "author": "ZigHolding", + "isDesktopOnly": true +} \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..6a00766 --- /dev/null +++ b/package.json @@ -0,0 +1,24 @@ +{ + "name": "obsidian-sample-plugin", + "version": "1.0.0", + "description": "This is a sample plugin for Obsidian (https://obsidian.md)", + "main": "main.js", + "scripts": { + "dev": "node esbuild.config.mjs", + "build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production", + "version": "node version-bump.mjs && git add manifest.json versions.json" + }, + "keywords": [], + "author": "", + "license": "MIT", + "devDependencies": { + "@types/node": "^16.11.6", + "@typescript-eslint/eslint-plugin": "5.29.0", + "@typescript-eslint/parser": "5.29.0", + "builtin-modules": "3.3.0", + "esbuild": "0.17.3", + "obsidian": "latest", + "tslib": "2.4.0", + "typescript": "4.7.4" + } +} diff --git a/styles.css b/styles.css new file mode 100644 index 0000000..71cc60f --- /dev/null +++ b/styles.css @@ -0,0 +1,8 @@ +/* + +This CSS file will be included with your plugin, and +available in the app when your plugin is enabled. + +If your plugin does not need CSS, delete this file. + +*/ diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..2d6fbdf --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "baseUrl": ".", + "inlineSourceMap": true, + "inlineSources": true, + "module": "ESNext", + "target": "ES6", + "allowJs": true, + "noImplicitAny": true, + "moduleResolution": "node", + "importHelpers": true, + "isolatedModules": true, + "strictNullChecks": true, + "lib": [ + "DOM", + "ES5", + "ES6", + "ES7" + ] + }, + "include": [ + "**/*.ts" + ] +} diff --git a/version-bump.mjs b/version-bump.mjs new file mode 100644 index 0000000..d409fa0 --- /dev/null +++ b/version-bump.mjs @@ -0,0 +1,14 @@ +import { readFileSync, writeFileSync } from "fs"; + +const targetVersion = process.env.npm_package_version; + +// read minAppVersion from manifest.json and bump version to target version +let manifest = JSON.parse(readFileSync("manifest.json", "utf8")); +const { minAppVersion } = manifest; +manifest.version = targetVersion; +writeFileSync("manifest.json", JSON.stringify(manifest, null, "\t")); + +// update versions.json with target version and minAppVersion from manifest.json +let versions = JSON.parse(readFileSync("versions.json", "utf8")); +versions[targetVersion] = minAppVersion; +writeFileSync("versions.json", JSON.stringify(versions, null, "\t")); diff --git a/versions.json b/versions.json new file mode 100644 index 0000000..26382a1 --- /dev/null +++ b/versions.json @@ -0,0 +1,3 @@ +{ + "1.0.0": "0.15.0" +}