From cd95682b4779bed00239be3e6f1aefea6023344e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=98=99=E2=97=A6=20The=20Tablet=20=E2=9D=80=20GamerGirla?= =?UTF-8?q?ndCo=20=E2=97=A6=E2=9D=A7?= Date: Sun, 21 Jul 2024 20:23:25 -0400 Subject: [PATCH] rename worker, update readme --- README.md | 101 +----------------- esbuild.config.mjs | 2 +- src/main.ts | 3 +- ...{testthing.worker.ts => sqlite3.worker.ts} | 2 +- src/workers.d.ts | 2 +- 5 files changed, 9 insertions(+), 101 deletions(-) rename src/{testthing.worker.ts => sqlite3.worker.ts} (89%) diff --git a/README.md b/README.md index 896b222..f182790 100644 --- a/README.md +++ b/README.md @@ -1,96 +1,5 @@ -# 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 +# obsidian + sqlite3 + opfs proof-of-concept + +creates and queries a sqlite3 database with the [`opfs-sahpool` vfs](https://sqlite.org/wasm/doc/trunk/persistence.md#vfs-opfs-sahpool) + +to build + install, run `./build.ps1 -vault /path/to/your/vault` and open the console :) diff --git a/esbuild.config.mjs b/esbuild.config.mjs index a5b8337..888f546 100644 --- a/esbuild.config.mjs +++ b/esbuild.config.mjs @@ -17,7 +17,7 @@ async function build(prod) { }, target: "es2020", format: "cjs", - sourcemap: prod ? false : "inline", + sourcemap: prod ? false : "inline", }), ], entryPoints: ["src/main.ts"], diff --git a/src/main.ts b/src/main.ts index 2d4f7da..da20acc 100644 --- a/src/main.ts +++ b/src/main.ts @@ -8,8 +8,7 @@ import { PluginSettingTab, Setting, } from "obsidian"; -import TestWorker from "testthing.worker"; -import sqlite3InitModule, { Sqlite3Static } from "@sqlite.org/sqlite-wasm"; +import TestWorker from "sqlite3.worker"; import { sqlite3Worker1Promiser } from "@sqlite.org/sqlite-wasm"; // Remember to rename these classes and interfaces! diff --git a/src/testthing.worker.ts b/src/sqlite3.worker.ts similarity index 89% rename from src/testthing.worker.ts rename to src/sqlite3.worker.ts index 8bde4fc..7ab057a 100644 --- a/src/testthing.worker.ts +++ b/src/sqlite3.worker.ts @@ -14,6 +14,6 @@ onmessage = async (event) => { initialCapacity: 65536, }); sqlite3.initWorker1API(); - console.log(sqlite3.capi.sqlite3_vfs_find("opfs")); + console.log(sqlite3.capi.sqlite3_vfs_find("opfs-sah")); } }; diff --git a/src/workers.d.ts b/src/workers.d.ts index 2f75da6..c053c77 100644 --- a/src/workers.d.ts +++ b/src/workers.d.ts @@ -1,4 +1,4 @@ -declare module "testthing.worker" { +declare module "sqlite3.worker" { const WorkerFactory: new () => Worker; export default WorkerFactory; }