generated from obsidianmd/obsidian-sample-plugin
-
Notifications
You must be signed in to change notification settings - Fork 2
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
10 changed files
with
3,833 additions
and
183 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 |
|---|---|---|
|
|
@@ -20,3 +20,5 @@ data.json | |
|
|
||
| # Exclude macOS Finder (System Explorer) View States | ||
| .DS_Store | ||
|
|
||
| script.sh | ||
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,73 +1,7 @@ | ||
| # Obsidian Sample Plugin | ||
| # Review Notes Plugin for Obsidian | ||
|
|
||
| This is a sample plugin for Obsidian (https://obsidian.md). | ||
| This plugin shows newly created and recently updated files. | ||
|
|
||
| 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. | ||
| ## Screenshot | ||
|
|
||
| **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. | ||
| - Changes the default font color to red using `styles.css`. | ||
| - 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. | ||
| - `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\` | ||
|
|
||
|
|
||
| ## API Documentation | ||
|
|
||
| See https://github.com/obsidianmd/obsidian-api | ||
|  |
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,137 +1,134 @@ | ||
| import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting } from 'obsidian'; | ||
|
|
||
| import { | ||
| App, | ||
| Notice, | ||
| Plugin, | ||
| PluginSettingTab, | ||
| Setting, | ||
| TFile, | ||
| } from "obsidian"; | ||
|
|
||
| import { RecentNotes, File } from "recent-notes-interface"; | ||
|
|
||
| import { VIEW_TYPE_REVIEW_NOTES, ReviewNotesView } from "review-notes-view"; | ||
| // Remember to rename these classes and interfaces! | ||
|
|
||
| interface MyPluginSettings { | ||
| mySetting: string; | ||
| interface PluginSettings { | ||
| setting: string; | ||
| } | ||
|
|
||
| const DEFAULT_SETTINGS: MyPluginSettings = { | ||
| mySetting: 'default' | ||
| } | ||
| const DEFAULT_DATA: RecentNotes = { | ||
| files: [], | ||
| }; | ||
|
|
||
| export default class RecentNotesPlugin extends Plugin { | ||
| settings: PluginSettings; | ||
|
|
||
| export default class MyPlugin extends Plugin { | ||
| settings: MyPluginSettings; | ||
| recentNotes: RecentNotes; | ||
|
|
||
| reviewNotesView: ReviewNotesView; | ||
|
|
||
| async onload() { | ||
| await this.loadSettings(); | ||
| await this.loadRecentNotes(); | ||
|
|
||
| // 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'); | ||
| } | ||
| }); | ||
| // 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; | ||
| } | ||
| } | ||
| }); | ||
| // handles creation of new file and modification to existing file | ||
|
|
||
| // This adds a settings tab so the user can configure various aspects of the plugin | ||
| this.addSettingTab(new SampleSettingTab(this.app, this)); | ||
| this.registerEvent(this.app.vault.on("create", this.savePath)); | ||
|
|
||
| // 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.registerEvent(this.app.vault.on("modify", this.savePath)); | ||
|
|
||
| // 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.registerEvent(this.app.vault.on("rename", this.renamePath)); | ||
|
|
||
| onunload() { | ||
| // register custom view | ||
| this.registerView(VIEW_TYPE_REVIEW_NOTES, (leaf) => { | ||
| this.reviewNotesView = new ReviewNotesView( | ||
| leaf, | ||
| this.recentNotes, | ||
| this | ||
| ); | ||
| return this.reviewNotesView; | ||
| }); | ||
|
|
||
| } | ||
| this.addRibbonIcon("file", "View Recent Notes", () => { | ||
| this.activateView(); | ||
| }); | ||
|
|
||
| async loadSettings() { | ||
| this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData()); | ||
| // This adds a settings tab so the user can configure various aspects of the plugin | ||
| this.addSettingTab(new SettingsTab(this.app, this)); | ||
| } | ||
|
|
||
| async saveSettings() { | ||
| await this.saveData(this.settings); | ||
| async activateView() { | ||
| this.app.workspace.detachLeavesOfType(VIEW_TYPE_REVIEW_NOTES); | ||
|
|
||
| await this.app.workspace.getRightLeaf(false).setViewState({ | ||
| type: VIEW_TYPE_REVIEW_NOTES, | ||
| active: true, | ||
| }); | ||
|
|
||
| this.app.workspace.revealLeaf( | ||
| this.app.workspace.getLeavesOfType(VIEW_TYPE_REVIEW_NOTES)[0] | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| class SampleModal extends Modal { | ||
| constructor(app: App) { | ||
| super(app); | ||
| async onunload() { | ||
| this.app.workspace.detachLeavesOfType(VIEW_TYPE_REVIEW_NOTES); | ||
| } | ||
|
|
||
| onOpen() { | ||
| const {contentEl} = this; | ||
| contentEl.setText('Woah!'); | ||
| savePath = async (file: TFile): Promise<void> => { | ||
| // folder creation | ||
| if (file.basename === undefined) { | ||
| return; | ||
| } | ||
|
|
||
| this.recentNotes.files.findIndex(({ path }) => file.path === path) === | ||
| -1 | ||
| ? this.recentNotes.files.push({ | ||
| path: file.path, | ||
| filename: file.basename, | ||
| // eslint-disable-next-line no-mixed-spaces-and-tabs | ||
| }) | ||
| : undefined; | ||
|
|
||
| await this.saveRecentNotes(); | ||
| }; | ||
|
|
||
| renamePath = async (file: TFile, previousPath: string): Promise<void> => { | ||
| const fileIndex = this.recentNotes.files.findIndex( | ||
| (item) => item.path === previousPath | ||
| ); | ||
|
|
||
| if (fileIndex != -1) { | ||
| // eslint-disable-next-line @typescript-eslint/no-non-null-assertion | ||
| this.recentNotes.files.at(fileIndex)!.path = file.path; | ||
| // eslint-disable-next-line @typescript-eslint/no-non-null-assertion | ||
| this.recentNotes.files.at(fileIndex)!.filename = file.basename; | ||
|
|
||
| await this.saveRecentNotes(); | ||
| } | ||
| }; | ||
|
|
||
| async loadRecentNotes() { | ||
| this.recentNotes = Object.assign(DEFAULT_DATA, await super.loadData()); | ||
| } | ||
|
|
||
| onClose() { | ||
| const {contentEl} = this; | ||
| contentEl.empty(); | ||
| async saveRecentNotes() { | ||
| await this.saveData(this.recentNotes); | ||
| this.reviewNotesView.onOpen(); | ||
| } | ||
| } | ||
|
|
||
| class SampleSettingTab extends PluginSettingTab { | ||
| plugin: MyPlugin; | ||
| class SettingsTab extends PluginSettingTab { | ||
| plugin: RecentNotesPlugin; | ||
|
|
||
| constructor(app: App, plugin: MyPlugin) { | ||
| constructor(app: App, plugin: RecentNotesPlugin) { | ||
| super(app, plugin); | ||
| this.plugin = plugin; | ||
| } | ||
|
|
||
| display(): void { | ||
| const {containerEl} = this; | ||
| 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: "Review Notes Pugin - Settings" }); | ||
| } | ||
| } |
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-review-notes-plugin", | ||
| "name": "Review Notes Plugin", | ||
| "version": "1.0.0", | ||
| "minAppVersion": "0.15.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", | ||
| "description": "This plugin shows recently modified and newly created files", | ||
| "author": "tjandy98", | ||
| "authorUrl": "https://github.com/tjandy98", | ||
| "isDesktopOnly": false | ||
| } |
Oops, something went wrong.