obsidian-plugin/jesse-r-s-hines_obsidian-open-tab-settings
1
0
Fork 0
mirror of https://github.com/jesse-r-s-hines/obsidian-open-tab-settings.git synced 2026-07-22 05:43:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Tab to spaces

Browse source
This commit is contained in:
Jesse Hines 2025-02-12 19:16:05 -05:00
parent ad11020c1a
commit f6a3922837
11 changed files with 17532 additions and 17827 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.mocharc.json
View file

@ -1,5 +1,5 @@
{
"$schema": "https://json.schemastore.org/mocharc.json",
"spec": "test/unit/**/*.ts",
"require": "tsx"
"$schema": "https://json.schemastore.org/mocharc.json",
"spec": "test/unit/**/*.ts",
"require": "tsx"
}

60
esbuild.config.mjs
View file

@ -12,38 +12,38 @@ if you want to view the source, please visit the github repository of this plugi
const prod = (process.argv[2] === "production");
const context = await esbuild.context({
banner: {
js: banner,
},
entryPoints: ["src/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",
minify: prod,
banner: {
js: banner,
},
entryPoints: ["src/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",
minify: prod,
});
if (prod) {
await context.rebuild();
process.exit(0);
await context.rebuild();
process.exit(0);
} else {
await context.watch();
await context.watch();
}

18
manifest.json
View file

@ -1,11 +1,11 @@
{
"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",
"isDesktopOnly": false
"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",
"isDesktopOnly": false
}

34931
package-lock.json generated
View file

File diff suppressed because it is too large Load diff

72
package.json
View file

@ -1,38 +1,38 @@
{
"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",
"test": "run-s test:*",
"test:unit": "tsc --noEmit && mocha",
"test:e2e": "npm run build && npx wdio run ./wdio.conf.ts"
},
"keywords": [],
"author": "",
"license": "MIT",
"devDependencies": {
"@types/chai": "^5.0.1",
"@types/mocha": "^10.0.10",
"@types/node": "^16.11.6",
"@typescript-eslint/eslint-plugin": "5.29.0",
"@typescript-eslint/parser": "5.29.0",
"@wdio/cli": "^9.7.2",
"@wdio/local-runner": "^9.7.2",
"@wdio/mocha-framework": "^9.7.2",
"@wdio/spec-reporter": "^9.6.3",
"builtin-modules": "3.3.0",
"chai": "^5.1.2",
"esbuild": "0.17.3",
"mocha": "^11.1.0",
"npm-run-all": "^4.1.5",
"obsidian": "latest",
"obsidian-plugin-testing-library": "file:../obsidian-plugin-testing-library",
"tpx": "^0.0.1-beta.1",
"tslib": "2.4.0",
"typescript": "4.7.4"
}
"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",
"test": "run-s test:*",
"test:unit": "tsc --noEmit && mocha",
"test:e2e": "npm run build && npx wdio run ./wdio.conf.ts"
},
"keywords": [],
"author": "",
"license": "MIT",
"devDependencies": {
"@types/chai": "^5.0.1",
"@types/mocha": "^10.0.10",
"@types/node": "^16.11.6",
"@typescript-eslint/eslint-plugin": "5.29.0",
"@typescript-eslint/parser": "5.29.0",
"@wdio/cli": "^9.7.2",
"@wdio/local-runner": "^9.7.2",
"@wdio/mocha-framework": "^9.7.2",
"@wdio/spec-reporter": "^9.6.3",
"builtin-modules": "3.3.0",
"chai": "^5.1.2",
"esbuild": "0.17.3",
"mocha": "^11.1.0",
"npm-run-all": "^4.1.5",
"obsidian": "latest",
"obsidian-plugin-testing-library": "file:../obsidian-plugin-testing-library",
"tpx": "^0.0.1-beta.1",
"tslib": "2.4.0",
"typescript": "4.7.4"
}
}

196
src/main.ts
View file

@ -3,132 +3,132 @@ import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Set
// Remember to rename these classes and interfaces!
interface MyPluginSettings {
mySetting: string;
mySetting: string;
}
const DEFAULT_SETTINGS: MyPluginSettings = {
mySetting: 'default'
mySetting: 'default'
}
export default class MyPlugin extends Plugin {
settings: MyPluginSettings;
settings: MyPluginSettings;
async onload() {
await this.loadSettings();
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 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');
// 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');
// 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();
}
});
// 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',
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 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();
}
});
// 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',
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;
}
}
});
// This command will only show up in Command Palette when the check function returns true
return true;
}
}
});
// This adds a settings tab so the user can configure various aspects of the plugin
this.addSettingTab(new SampleSettingTab(this.app, this));
// This adds a settings tab so the user can configure various aspects of the plugin
this.addSettingTab(new SampleSettingTab(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);
});
// 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);
});
// 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));
}
// 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));
}
onunload() {
onunload() {
}
}
async loadSettings() {
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
}
async loadSettings() {
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
}
async saveSettings() {
await this.saveData(this.settings);
}
async saveSettings() {
await this.saveData(this.settings);
}
}
class SampleModal extends Modal {
constructor(app: App) {
super(app);
}
constructor(app: App) {
super(app);
}
onOpen() {
const {contentEl} = this;
contentEl.setText('Woah!');
}
onOpen() {
const {contentEl} = this;
contentEl.setText('Woah!');
}
onClose() {
const {contentEl} = this;
contentEl.empty();
}
onClose() {
const {contentEl} = this;
contentEl.empty();
}
}
class SampleSettingTab extends PluginSettingTab {
plugin: MyPlugin;
plugin: MyPlugin;
constructor(app: App, plugin: MyPlugin) {
super(app, plugin);
this.plugin = plugin;
}
constructor(app: App, plugin: MyPlugin) {
super(app, plugin);
this.plugin = plugin;
}
display(): void {
const {containerEl} = this;
display(): void {
const {containerEl} = this;
containerEl.empty();
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('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();
}));
}
}

2
src/sum.ts
View file

@ -1,3 +1,3 @@
export function sum(a: number, b: number) {
return a + b
return a + b
}

16
test/specs/test.e2e.ts
View file

@ -2,13 +2,13 @@ import { browser } from '@wdio/globals'
import { expect } from 'chai';
describe('Test my plugin', () => {
before(async () => {
await browser.openVault("./test/vaults/simple");
})
it('test command open-sample-modal-simple', async () => {
await browser.executeObsidianCommand("sample-plugin:open-sample-modal-simple");
before(async () => {
await browser.openVault("./test/vaults/simple");
})
it('test command open-sample-modal-simple', async () => {
await browser.executeObsidianCommand("sample-plugin:open-sample-modal-simple");
expect(await browser.$(".modal-container .modal-content").isExisting()).to.equal(true);
expect(await browser.$(".modal-container .modal-content").getText()).to.equal("Woah!");
})
expect(await browser.$(".modal-container .modal-content").isExisting()).to.equal(true);
expect(await browser.$(".modal-container .modal-content").getText()).to.equal("Woah!");
})
})

6
test/unit/sum.test.ts
View file

@ -2,7 +2,7 @@ import { expect } from 'chai';
import { sum } from '../../src/sum.js';
describe("unit tests", () => {
it('Sum', () => {
expect(sum(1, 2)).to.equal(3)
});
it('Sum', () => {
expect(sum(1, 2)).to.equal(3)
});
});

2
versions.json
View file

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

48
wdio.conf.ts
View file

@ -2,38 +2,38 @@ import { ObsidianWorkerService, ObsidianLauncherService } from "obsidian-plugin-
import * as path from "path"
export const config: WebdriverIO.Config = {
runner: 'local',
tsConfigPath: './test/tsconfig.json',
runner: 'local',
tsConfigPath: './test/tsconfig.json',
specs: [
'./test/specs/**/*.ts'
],
specs: [
'./test/specs/**/*.ts'
],
// How many instances of Obsidian should be launched in parallel during testing.
maxInstances: 4,
// How many instances of Obsidian should be launched in parallel during testing.
maxInstances: 4,
capabilities: [{
browserName: 'obsidian',
browserVersion: "latest",
'wdio:obsidianOptions': {
installerVersion: "earliest",
plugins: ["."],
},
}],
capabilities: [{
browserName: 'obsidian',
browserVersion: "latest",
'wdio:obsidianOptions': {
installerVersion: "earliest",
plugins: ["."],
},
}],
services: [[ObsidianWorkerService, {}], [ObsidianLauncherService, {}]],
services: [[ObsidianWorkerService, {}], [ObsidianLauncherService, {}]],
framework: 'mocha',
framework: 'mocha',
reporters: ['spec'],
reporters: ['spec'],
mochaOpts: {
ui: 'bdd',
timeout: 60000
},
mochaOpts: {
ui: 'bdd',
timeout: 60000
},
cacheDir: path.resolve(".optl-cache"),
cacheDir: path.resolve(".optl-cache"),
logLevel: "warn",
logLevel: "warn",
}