tpl
/
obsidian-sample-plugin
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update .editorconfig and yarn format:fix

This commit is contained in:
INOUE Takuya 2023-01-19 01:33:52 +09:00
parent 27c0d04b66
commit 60ee7cd215
9 changed files with 232 additions and 223 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.editorconfig
View File

@ -5,6 +5,6 @@ root = true
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = tab
indent_size = 4
tab_width = 4
indent_style = space
indent_size = 2
tab_width = 2

4
.eslintrc
View File

@ -2,9 +2,7 @@
"root": true,
"parser": "@typescript-eslint/parser",
"env": { "node": true },
"plugins": [
"@typescript-eslint"
],
"plugins": ["@typescript-eslint"],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended",

22
esbuild.config.mjs
View File

@ -1,17 +1,17 @@
import esbuild from "esbuild";
import process from "process";
import esbuild from 'esbuild'
import process from 'process'
import builtins from 'builtin-modules'
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'
esbuild.build({
esbuild
.build({
banner: {
js: banner,
},
@ -31,12 +31,14 @@ esbuild.build({
'@lezer/common',
'@lezer/highlight',
'@lezer/lr',
...builtins],
...builtins,
],
format: 'cjs',
watch: !prod,
target: 'es2018',
logLevel: "info",
logLevel: 'info',
sourcemap: prod ? false : 'inline',
treeShaking: true,
outfile: 'main.js',
}).catch(() => process.exit(1));
})
.catch(() => process.exit(1))

114
src/main.ts
View File

@ -1,137 +1,153 @@
import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting } from 'obsidian';
import {
App,
Editor,
MarkdownView,
Modal,
Notice,
Plugin,
PluginSettingTab,
Setting,
} from 'obsidian'
// 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();
await this.loadSettings()
// This creates an icon in the left ribbon.
const ribbonIconEl = this.addRibbonIcon('dice', 'Sample Plugin', (evt: MouseEvent) => {
const ribbonIconEl = this.addRibbonIcon(
'dice',
'Sample Plugin',
(evt: MouseEvent) => {
// Called when the user clicks the icon.
new Notice('This is a notice!');
});
new Notice('This is a notice!')
}
)
// Perform additional things with the ribbon
ribbonIconEl.addClass('my-plugin-ribbon-class');
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 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();
}
});
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');
}
});
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);
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();
new SampleModal(this.app).open()
}
// This command will only show up in Command Palette when the check function returns true
return 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.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);
});
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() {
await this.saveData(this.settings);
await this.saveData(this.settings)
}
}
class SampleModal extends Modal {
constructor(app: App) {
super(app);
super(app)
}
onOpen() {
const {contentEl} = this;
contentEl.setText('Woah!');
const { contentEl } = this
contentEl.setText('Woah!')
}
onClose() {
const {contentEl} = this;
contentEl.empty();
const { contentEl } = this
contentEl.empty()
}
}
class SampleSettingTab extends PluginSettingTab {
plugin: MyPlugin;
plugin: MyPlugin
constructor(app: App, plugin: MyPlugin) {
super(app, plugin);
this.plugin = plugin;
super(app, plugin)
this.plugin = plugin
}
display(): void {
const {containerEl} = this;
const { containerEl } = this
containerEl.empty();
containerEl.empty()
containerEl.createEl('h2', {text: 'Settings for my awesome plugin.'});
containerEl.createEl('h2', { text: 'Settings for my awesome plugin.' })
new Setting(containerEl)
.setName('Setting #1')
.setDesc('It\'s a secret')
.addText(text => text
.setDesc("It's a secret")
.addText((text) =>
text
.setPlaceholder('Enter your secret')
.setValue(this.plugin.settings.mySetting)
.onChange(async (value) => {
console.log('Secret: ' + value);
this.plugin.settings.mySetting = value;
await this.plugin.saveSettings();
}));
console.log('Secret: ' + value)
this.plugin.settings.mySetting = value
await this.plugin.saveSettings()
})
)
}
}

11
tsconfig.json
View File

@ -11,14 +11,7 @@
"importHelpers": true,
"isolatedModules": true,
"strictNullChecks": true,
"lib": [
"DOM",
"ES5",
"ES6",
"ES7"
]
"lib": ["DOM", "ES5", "ES6", "ES7"]
},
"include": [
"**/*.ts"
]
"include": ["**/*.ts"]
}

18
version-bump.mjs
View File

@ -1,14 +1,14 @@
import { readFileSync, writeFileSync } from "fs";
import { readFileSync, writeFileSync } from 'fs'
const targetVersion = process.env.npm_package_version;
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"));
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"));
let versions = JSON.parse(readFileSync('versions.json', 'utf8'))
versions[targetVersion] = minAppVersion
writeFileSync('versions.json', JSON.stringify(versions, null, '\t'))