generated from obsidianmd/obsidian-sample-plugin
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
40 additions
and
134 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,157 +1,63 @@ | ||
import { | ||
App, | ||
Editor, | ||
MarkdownView, | ||
Modal, | ||
Notice, | ||
Plugin, | ||
PluginSettingTab, | ||
Setting, | ||
} from "obsidian"; | ||
import { App, Plugin, PluginSettingTab, Setting } from "obsidian"; | ||
|
||
// Remember to rename these classes and interfaces! | ||
|
||
interface MyPluginSettings { | ||
mySetting: string; | ||
interface SwitchVSCodeSettings { | ||
vaultPath: string; | ||
} | ||
|
||
const DEFAULT_SETTINGS: MyPluginSettings = { | ||
mySetting: "default", | ||
}; | ||
|
||
export default class MyPlugin extends Plugin { | ||
settings: MyPluginSettings; | ||
export default class SwitchVSCode extends Plugin { | ||
settings: SwitchVSCodeSettings; | ||
|
||
async onload() { | ||
this.addSettingTab(new SwitchVSCodeSettingsTab(this.app, this)); | ||
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"); | ||
|
||
// 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"); | ||
}, | ||
id: "Switch-vscode", | ||
name: "Switch current file with Visual Studio Code", | ||
callback: this.SwitchCurrentFile.bind(this), | ||
}); | ||
// 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 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); | ||
}); | ||
|
||
// 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() {} | ||
// open file in vscode | ||
async SwitchCurrentFile() { | ||
const vaultPath = this.settings.vaultPath; | ||
const currentFilePath = this.app.workspace.getActiveFile().path; | ||
if (vaultPath) | ||
console.error("please config vault path in plugin setting"); | ||
currentFilePath | ||
? window.open(`vscode://file/${vaultPath}/${currentFilePath}`) | ||
: console.error("no editor available yet"); | ||
} | ||
|
||
async loadSettings() { | ||
this.settings = Object.assign( | ||
{}, | ||
DEFAULT_SETTINGS, | ||
await this.loadData() | ||
); | ||
this.settings = Object.assign({}, await this.loadData()); | ||
} | ||
|
||
async saveSettings() { | ||
await this.saveData(this.settings); | ||
} | ||
} | ||
|
||
class SampleModal extends Modal { | ||
constructor(app: App) { | ||
super(app); | ||
} | ||
|
||
onOpen() { | ||
const { contentEl } = this; | ||
contentEl.setText("Woah!"); | ||
} | ||
|
||
onClose() { | ||
const { contentEl } = this; | ||
contentEl.empty(); | ||
} | ||
} | ||
|
||
class SampleSettingTab extends PluginSettingTab { | ||
plugin: MyPlugin; | ||
class SwitchVSCodeSettingsTab extends PluginSettingTab { | ||
plugin: SwitchVSCode; | ||
|
||
constructor(app: App, plugin: MyPlugin) { | ||
constructor(app: App, plugin: SwitchVSCode) { | ||
super(app, plugin); | ||
this.plugin = plugin; | ||
} | ||
|
||
display(): void { | ||
const { containerEl } = this; | ||
|
||
containerEl.empty(); | ||
|
||
containerEl.createEl("h2", { text: "Settings for my awesome plugin." }); | ||
|
||
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) => { | ||
console.log("Secret: " + value); | ||
this.plugin.settings.mySetting = value; | ||
await this.plugin.saveSettings(); | ||
}) | ||
); | ||
containerEl.createEl("h2", { text: "Settings" }); | ||
|
||
new Setting(containerEl).setName("vault path").addText((text) => | ||
text | ||
.setValue(this.plugin.settings.vaultPath) | ||
.onChange(async (value) => { | ||
value = value.trim(); | ||
this.plugin.settings.vaultPath = value; | ||
await this.plugin.saveSettings(); | ||
}) | ||
); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,10 @@ | ||
{ | ||
"id": "obsidian-sample-plugin", | ||
"name": "Sample Plugin", | ||
"id": "obsidian-switch-to-vscode", | ||
"name": "switch to vscode", | ||
"version": "1.0.1", | ||
"minAppVersion": "0.12.0", | ||
"description": "This is a sample plugin for Obsidian. This plugin demonstrates some of the capabilities of the Obsidian API.", | ||
"author": "Obsidian", | ||
"authorUrl": "https://obsidian.md", | ||
"isDesktopOnly": false | ||
"description": "open current file in vscode", | ||
"author": "HenryC-3", | ||
"authorUrl": "https://github.com/HenryC-3/obsidian-switch-to-vscode", | ||
"isDesktopOnly": true | ||
} |