endeavorance/obsidian-scraps
1
0
Fork 0
Code Issues 2 Pull requests Actions Packages Projects Releases 1 Wiki Activity

Initial commit for Scraps

Browse source
This commit is contained in:
Endeavorance 2024-10-21 10:21:04 -04:00
parent daa0cba23c
commit f75037547f
4 changed files with 2562 additions and 191 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

99
README.md
View file

@ -1,96 +1,15 @@
# Obsidian Sample Plugin
# Scraps for Obsidian
This is a sample plugin for Obsidian (https://obsidian.md).
Create and manage _Scraps_ of information. Thoughts, ideas, snippets, pictures, or whatever you want to toss into your pile of Scraps.
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.
This plugin manages a folder in your Obsidian Vault which contains "Scraps": files organized into folders by date. That's pretty much the whole concept! Think of it like a more formatted Unique Note Creator with the intention of creating a structured place to collect thoughts and snippets over time.
**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
## Commands
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.
- `Scraps: Create new Scrap` - Creates a new file based on the plugin settings
- `Scraps: Convert current file to Scrap` - Moves and renames the current file to be a scrap
- `Scraps: Copy current file to Scraps` - Creates a copy of the current file as a scrap
## First time developing plugins?
## Status
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 the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines).
- 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/"
}
}
```
## API Documentation
See https://github.com/obsidianmd/obsidian-api
This is an early concept and is not meant for wider public use at this time. That said, it works as-is, so if this seems interesting and you know how to manually install Obsidian plugins, give it a try!

257
main.ts
View file

@ -1,89 +1,146 @@
import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting } from 'obsidian';
import {
App,
Plugin,
PluginSettingTab,
Setting,
moment,
Vault,
Notice,
} from "obsidian";
// Remember to rename these classes and interfaces!
interface MyPluginSettings {
mySetting: string;
interface ScrapsPluginSettings {
scrapsRootDir: string;
scrapsPathFormat: string;
scrapsFileName: string;
}
const DEFAULT_SETTINGS: MyPluginSettings = {
mySetting: 'default'
const DEFAULT_SETTINGS: ScrapsPluginSettings = {
scrapsRootDir: "_Scraps",
scrapsPathFormat: "MM MMM/DD",
scrapsFileName: "ddd MMM DD hhmmssa",
};
async function mkdirp(vault: Vault, folderPath: string): Promise<void> {
const pathParts = folderPath.split("/");
// Start building the path incrementally
let currentPath = "";
for (const part of pathParts) {
currentPath = currentPath ? `${currentPath}/${part}` : part;
try {
// Check if folder exists
if (!vault.getAbstractFileByPath(currentPath)) {
// Create the folder if it doesn't exist
await vault.createFolder(currentPath);
}
} catch (error) {
console.error(`Error creating folder ${currentPath}:`, error);
throw error;
}
}
}
export default class MyPlugin extends Plugin {
settings: MyPluginSettings;
export default class ScrapsPlugin extends Plugin {
settings: ScrapsPluginSettings;
async ensureScrapDir(): Promise<string> {
const pathname = `${this.settings.scrapsRootDir}/${moment().format(
this.settings.scrapsPathFormat
)}`;
await mkdirp(this.app.vault, pathname);
return pathname;
}
getScrapFilePath(): string {
return `${this.settings.scrapsRootDir}/${moment().format(
this.settings.scrapsPathFormat
)}/${moment().format(this.settings.scrapsFileName)}.md`;
}
async createScrap() {
await this.ensureScrapDir();
const newScrap = await this.app.vault.create(
this.getScrapFilePath(),
""
);
await this.app.workspace.getLeaf(false).openFile(newScrap);
}
async onload() {
await this.loadSettings();
this.addSettingTab(new ScrapsSettingTab(this.app, this));
// 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();
}
id: "scraps-new",
name: "Scraps: Create new Scrap",
icon: "badge-plus",
callback: async () => {
this.createScrap();
},
});
// 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.addRibbonIcon("badge-plus", "Create new Scrap", async () => {
this.createScrap();
});
this.addCommand({
id: "scraps-convert",
name: "Scraps: Convert current file to Scrap",
icon: "file-plus",
editorCallback: async () => {
const currentFile = this.app.workspace.getActiveFile();
if (currentFile === null) {
new Notice("No file is currently open");
return;
}
}
await this.ensureScrapDir();
await this.app.fileManager.renameFile(
currentFile,
this.getScrapFilePath()
);
},
});
// This adds a settings tab so the user can configure various aspects of the plugin
this.addSettingTab(new SampleSettingTab(this.app, this));
this.addCommand({
id: "scraps-copy",
name: "Scraps: Copy current file to Scraps",
icon: "copy-plus",
editorCallback: async () => {
const currentFile = this.app.workspace.getActiveFile();
// 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 (currentFile === null) {
new Notice("No file is currently open");
return;
}
await this.ensureScrapDir();
const newScrap = await this.app.vault.copy(
currentFile,
this.getScrapFilePath()
);
await this.app.workspace.getLeaf(false).openFile(newScrap);
},
});
// 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());
this.settings = Object.assign(
{},
DEFAULT_SETTINGS,
await this.loadData()
);
}
async saveSettings() {
@ -91,44 +148,56 @@ export default class MyPlugin extends Plugin {
}
}
class SampleModal extends Modal {
constructor(app: App) {
super(app);
}
class ScrapsSettingTab extends PluginSettingTab {
plugin: ScrapsPlugin;
onOpen() {
const {contentEl} = this;
contentEl.setText('Woah!');
}
onClose() {
const {contentEl} = this;
contentEl.empty();
}
}
class SampleSettingTab extends PluginSettingTab {
plugin: MyPlugin;
constructor(app: App, plugin: MyPlugin) {
constructor(app: App, plugin: ScrapsPlugin) {
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();
}));
.setName("Scraps Root Directory")
.setDesc("The directory where all your scraps will be stored")
.addText((text) =>
text
.setPlaceholder("Enter directory")
.setValue(this.plugin.settings.scrapsRootDir)
.onChange(async (value) => {
this.plugin.settings.scrapsRootDir = value;
await this.plugin.saveSettings();
})
);
new Setting(containerEl)
.setName("Scraps Path Format")
.setDesc("The format of the path to the scrap")
.addText((text) =>
text
.setPlaceholder("Enter format")
.setValue(this.plugin.settings.scrapsPathFormat)
.onChange(async (value) => {
this.plugin.settings.scrapsPathFormat = value;
await this.plugin.saveSettings();
})
);
new Setting(containerEl)
.setName("Scraps File Name Format")
.setDesc("The format of the filename")
.addText((text) =>
text
.setPlaceholder("Enter format")
.setValue(this.plugin.settings.scrapsFileName)
.onChange(async (value) => {
this.plugin.settings.scrapsFileName = value;
await this.plugin.saveSettings();
})
);
}
}

14
manifest.json
View file

@ -1,11 +1,11 @@
{
"id": "sample-plugin",
"name": "Sample Plugin",
"version": "1.0.0",
"id": "scraps",
"name": "Scraps",
"version": "0.0.1",
"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",
"description": "Create and manage scraps of information in your vault.",
"author": "Endeavorance",
"authorUrl": "https://endeavorance.camp",
"fundingUrl": "https://patreon.com/endeavorance",
"isDesktopOnly": false
}

2383
package-lock.json generated Normal file
View file

File diff suppressed because it is too large Load diff