obsidian-plugin/geeknees_obsidian-ruby-wasm-plugin
1
0
Fork 0
mirror of https://github.com/geeknees/obsidian-ruby-wasm-plugin.git synced 2026-07-22 10:10:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update versions.json, manifest.json, package.json, tsconfig.json, and esbuild.config.mjs

Browse source
This commit is contained in:
Masumi Kawasaki 2024-04-28 15:13:16 +09:00
parent f40978e090
commit 2d52671dc3
No known key found for this signature in database
GPG key ID: 9E5903751D5634BF
8 changed files with 2450 additions and 206 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

93
README.md
View file

@ -1,95 +1,6 @@
# Obsidian Sample Plugin
# Obsidian RubyWasm 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/"
}
}
```
This is a ruby.wasm plugin for Obsidian (https://obsidian.md).
## API Documentation

14
esbuild.config.mjs
View file

@ -1,15 +1,15 @@
import esbuild from "esbuild";
import process from "process";
import builtins from "builtin-modules";
import { wasmLoader } from "esbuild-plugin-wasm";
const banner =
`/*
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 prod = process.argv[2] === "production";
const context = await esbuild.context({
banner: {
@ -31,13 +31,15 @@ const context = await esbuild.context({
"@lezer/common",
"@lezer/highlight",
"@lezer/lr",
...builtins],
...builtins,
],
format: "cjs",
target: "es2018",
target: "es2020",
logLevel: "info",
sourcemap: prod ? false : "inline",
treeShaking: true,
outfile: "main.js",
plugins: [wasmLoader()],
});
if (prod) {
@ -45,4 +47,4 @@ if (prod) {
process.exit(0);
} else {
await context.watch();
}
}

209
main.ts
View file

@ -1,89 +1,123 @@
import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting } from 'obsidian';
import {
App,
Editor,
MarkdownView,
Modal,
Plugin,
PluginSettingTab,
Setting,
} from "obsidian";
import { DefaultRubyVM } from "@ruby/wasm-wasi/dist/browser";
// Remember to rename these classes and interfaces!
interface MyPluginSettings {
interface RubyWasmPluginSettings {
mySetting: string;
}
const DEFAULT_SETTINGS: MyPluginSettings = {
mySetting: 'default'
}
const DEFAULT_SETTINGS: RubyWasmPluginSettings = {
mySetting: "default",
};
export default class MyPlugin extends Plugin {
settings: MyPluginSettings;
export default class RubyWasmPlugin extends Plugin {
settings: RubyWasmPluginSettings;
// Function to check if inside code block
isInCodeBlock = (editor: Editor, line: number) => {
const totalLines = editor.lineCount();
let inCodeBlock = true;
for (let i = line; i >= 0; i--) {
const lineText = editor.getLine(i).trim();
if (lineText.startsWith("```")) {
inCodeBlock = !inCodeBlock;
}
}
for (let i = line + 1; i < totalLines; i++) {
const lineText = editor.getLine(i).trim();
if (lineText.startsWith("```")) {
inCodeBlock = !inCodeBlock;
break;
}
}
return inCodeBlock;
};
async onload() {
await this.loadSettings();
// This creates an icon in the left ribbon.
const ribbonIconEl = this.addRibbonIcon('dice', 'Sample Plugin', (evt: MouseEvent) => {
// Called when the user clicks the icon.
new Notice('This is a notice!');
});
// Perform additional things with the ribbon
ribbonIconEl.addClass('my-plugin-ribbon-class');
// This adds a status bar item to the bottom of the app. Does not work on mobile apps.
const statusBarItemEl = this.addStatusBarItem();
statusBarItemEl.setText('Status Bar Text');
const response = await fetch(
"https://cdn.jsdelivr.net/npm/@ruby/3.3-wasm-wasi@2.5.1/dist/ruby+stdlib.wasm"
);
const module = await WebAssembly.compileStreaming(response);
const { vm } = await DefaultRubyVM(module);
// This adds a simple command that can be triggered anywhere
this.addCommand({
id: 'open-sample-modal-simple',
name: 'Open sample modal (simple)',
callback: () => {
new SampleModal(this.app).open();
}
id: "run-in-modal-command",
name: "Run in Modal",
editorCallback: (editor: Editor) => {
const code = editor.getSelection();
let result;
try {
result = vm.eval(code).toString();
} catch (e) {
result = e.toString();
}
// console.log(code);
new CodeModal(this.app, code, result).open();
},
});
// This adds an editor command that can perform some operation on the current editor instance
this.addCommand({
id: 'sample-editor-command',
name: 'Sample editor command',
id: "run-in-editor-command",
name: "Run in Editor",
editorCallback: (editor: Editor, view: MarkdownView) => {
console.log(editor.getSelection());
editor.replaceSelection('Sample Editor Command');
}
});
// This adds a complex command that can check whether the current state of the app allows execution of the command
this.addCommand({
id: 'open-sample-modal-complex',
name: 'Open sample modal (complex)',
checkCallback: (checking: boolean) => {
// Conditions to check
const markdownView = this.app.workspace.getActiveViewOfType(MarkdownView);
if (markdownView) {
// If checking is true, we're simply "checking" if the command can be run.
// If checking is false, then we want to actually perform the operation.
if (!checking) {
new SampleModal(this.app).open();
}
// This command will only show up in Command Palette when the check function returns true
return true;
const code = editor.getSelection();
let result;
try {
result = vm.eval(code).toString();
} catch (e) {
result = e.toString();
}
}
// console.log(code);
const cursorLine = editor.getCursor().line;
const insideCode = this.isInCodeBlock(editor, cursorLine);
if (insideCode) {
editor.replaceSelection(`${code}\n# => ${result}`);
} else {
editor.replaceSelection(
`${code}\n\`\`\`\n${result}\n\`\`\``
);
}
},
});
// This adds a settings tab so the user can configure various aspects of the plugin
this.addSettingTab(new SampleSettingTab(this.app, this));
this.addSettingTab(new RubyWasmSettingTab(this.app, this));
// If the plugin hooks up any global DOM events (on parts of the app that doesn't belong to this plugin)
// Using this function will automatically remove the event listener when this plugin is disabled.
this.registerDomEvent(document, 'click', (evt: MouseEvent) => {
console.log('click', evt);
});
// this.registerDomEvent(document, "click", (evt: MouseEvent) => {
// console.log("click", evt);
// });
// When registering intervals, this function will automatically clear the interval when the plugin is disabled.
this.registerInterval(window.setInterval(() => console.log('setInterval'), 5 * 60 * 1000));
// this.registerInterval(
// window.setInterval(() => console.log("setInterval"), 5 * 60 * 1000)
// );
}
onunload() {
}
onunload() {}
async loadSettings() {
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
this.settings = Object.assign(
{},
DEFAULT_SETTINGS,
await this.loadData()
);
}
async saveSettings() {
@ -91,44 +125,69 @@ export default class MyPlugin extends Plugin {
}
}
class SampleModal extends Modal {
constructor(app: App) {
class CodeModal extends Modal {
code: string;
result: string;
constructor(app: App, code: string, result: string) {
super(app);
this.code = code;
this.result = result;
}
onOpen() {
const {contentEl} = this;
contentEl.setText('Woah!');
async onOpen() {
const { contentEl } = this;
// contentEl.createEl("h1", { text: "Code" });
const codeBlock = contentEl.createEl("pre", {
cls: "language-ruby",
});
const codeElement = codeBlock.createEl("code", {
cls: "language-ruby",
});
codeElement.textContent = this.code || "code";
const resultElement = contentEl.createEl("div", {
cls: "ruby-output",
attr: { style: "white-space: pre-wrap;" },
});
resultElement.textContent = this.result || "result";
const closeButton = contentEl.createEl("button", { text: "Close" });
closeButton.style.cssText = "float: right;";
closeButton.addEventListener("click", () => {
this.close();
});
}
onClose() {
const {contentEl} = this;
const { contentEl } = this;
contentEl.empty();
}
}
class SampleSettingTab extends PluginSettingTab {
plugin: MyPlugin;
class RubyWasmSettingTab extends PluginSettingTab {
plugin: RubyWasmPlugin;
constructor(app: App, plugin: MyPlugin) {
constructor(app: App, plugin: RubyWasmPlugin) {
super(app, plugin);
this.plugin = plugin;
}
display(): void {
const {containerEl} = this;
const { containerEl } = this;
containerEl.empty();
new Setting(containerEl)
.setName('Setting #1')
.setDesc('It\'s a secret')
.addText(text => text
.setPlaceholder('Enter your secret')
.setValue(this.plugin.settings.mySetting)
.onChange(async (value) => {
this.plugin.settings.mySetting = value;
await this.plugin.saveSettings();
}));
new Setting(containerEl).setName("ruby.wasm");
// .setDesc("It's a secret");
// .addText((text) =>
// text
// .setPlaceholder("Enter your secret")
// .setValue(this.plugin.settings.mySetting)
// .onChange(async (value) => {
// this.plugin.settings.mySetting = value;
// await this.plugin.saveSettings();
// })
// );
}
}

15
manifest.json
View file

@ -1,11 +1,10 @@
{
"id": "sample-plugin",
"name": "Sample Plugin",
"version": "1.0.0",
"minAppVersion": "0.15.0",
"description": "Demonstrates some of the capabilities of the Obsidian API.",
"author": "Obsidian",
"authorUrl": "https://obsidian.md",
"fundingUrl": "https://obsidian.md/pricing",
"id": "ruby-wasm-plugin",
"name": "ruby.wasm",
"version": "0.0.1",
"minAppVersion": "0.0.1",
"description": "Run ruby code in your notes using WebAssembly",
"author": "geeknees",
"authorUrl": "https://github.com/geeknees/",
"isDesktopOnly": false
}

2274
package-lock.json generated Normal file
View file

File diff suppressed because it is too large Load diff

12
package.json
View file

@ -1,7 +1,7 @@
{
"name": "obsidian-sample-plugin",
"version": "1.0.0",
"description": "This is a sample plugin for Obsidian (https://obsidian.md)",
"name": "obsidian-ruby.wasm-plugin",
"version": "0.0.1",
"description": "This is a ruby.wasm plugin for Obsidian (https://obsidian.md)",
"main": "main.js",
"scripts": {
"dev": "node esbuild.config.mjs",
@ -17,8 +17,14 @@
"@typescript-eslint/parser": "5.29.0",
"builtin-modules": "3.3.0",
"esbuild": "0.17.3",
"esbuild-plugin-wasm": "^1.1.0",
"obsidian": "latest",
"tslib": "2.4.0",
"typescript": "4.7.4"
},
"dependencies": {
"@bjorn3/browser_wasi_shim": "^0.3.0",
"@ruby/3.3-wasm-wasi": "^2.5.1",
"@ruby/wasm-wasi": "^2.5.1"
}
}

37
tsconfig.json
View file

@ -1,24 +1,17 @@
{
"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"
]
"compilerOptions": {
"baseUrl": ".",
"inlineSourceMap": true,
"inlineSources": true,
"module": "ESNext",
"target": "es2020",
"allowJs": true,
"noImplicitAny": true,
"moduleResolution": "bundler",
"importHelpers": true,
"isolatedModules": true,
"strictNullChecks": true,
"lib": ["DOM", "ES5", "ES6", "ES7"]
},
"include": ["**/*.ts"]
}

2
versions.json
View file

@ -1,3 +1,3 @@
{
"1.0.0": "0.15.0"
"0.0.1": "0.0.1"
}