mirror of
https://github.com/cosmicoptima/loom.git
synced 2026-07-22 07:40:25 +00:00
wijufdhbgd
This commit is contained in:
parent
a31f51b44f
commit
5ed9a45150
7 changed files with 2446 additions and 229 deletions
4
.prettierrc
Normal file
4
.prettierrc
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
{
|
||||||
|
"tabWidth": 2,
|
||||||
|
"useTabs": false
|
||||||
|
}
|
||||||
96
README.md
96
README.md
|
|
@ -1,96 +0,0 @@
|
||||||
# Obsidian Sample Plugin
|
|
||||||
|
|
||||||
This is a sample plugin for Obsidian (https://obsidian.md).
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
**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\`
|
|
||||||
|
|
||||||
## 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
|
|
||||||
284
main.ts
284
main.ts
|
|
@ -1,137 +1,175 @@
|
||||||
import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting } from 'obsidian';
|
import {
|
||||||
|
App,
|
||||||
|
Editor,
|
||||||
|
ItemView,
|
||||||
|
MarkdownView,
|
||||||
|
Notice,
|
||||||
|
Plugin,
|
||||||
|
PluginSettingTab,
|
||||||
|
Setting,
|
||||||
|
WorkspaceLeaf,
|
||||||
|
} from "obsidian";
|
||||||
|
import { Configuration, OpenAIApi } from "openai";
|
||||||
|
|
||||||
// Remember to rename these classes and interfaces!
|
interface GPT3Settings {
|
||||||
|
apiKey: string;
|
||||||
interface MyPluginSettings {
|
model: string;
|
||||||
mySetting: string;
|
maxTokens: number;
|
||||||
|
nodesFolder: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
const DEFAULT_SETTINGS: MyPluginSettings = {
|
const DEFAULT_SETTINGS: GPT3Settings = {
|
||||||
mySetting: 'default'
|
apiKey: "",
|
||||||
|
model: "davinci",
|
||||||
|
maxTokens: 8,
|
||||||
|
nodesFolder: "nodes",
|
||||||
|
};
|
||||||
|
|
||||||
|
export default class GPT3Plugin extends Plugin {
|
||||||
|
settings: GPT3Settings;
|
||||||
|
openai: OpenAIApi;
|
||||||
|
|
||||||
|
async onload() {
|
||||||
|
await this.loadSettings();
|
||||||
|
|
||||||
|
this.addSettingTab(new GPT3SettingTab(this.app, this));
|
||||||
|
|
||||||
|
const configuration = new Configuration({
|
||||||
|
apiKey: this.settings.apiKey,
|
||||||
|
});
|
||||||
|
this.openai = new OpenAIApi(configuration);
|
||||||
|
|
||||||
|
this.addCommand({
|
||||||
|
id: "gpt-3-complete",
|
||||||
|
name: "Complete",
|
||||||
|
icon: "wand",
|
||||||
|
editorCallback: async (editor: Editor, view: MarkdownView) =>
|
||||||
|
this.complete(this.settings.model, this.settings.maxTokens, editor),
|
||||||
|
});
|
||||||
|
|
||||||
|
this.registerView(
|
||||||
|
"loom",
|
||||||
|
(leaf) => new LoomView(leaf),
|
||||||
|
);
|
||||||
|
const loomExists = this.app.workspace.getLeavesOfType("loom").length > 0;
|
||||||
|
if (!loomExists)
|
||||||
|
this.app.workspace.getRightLeaf(false).setViewState({
|
||||||
|
type: "loom",
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async complete(model: string, maxTokens: number, editor: Editor) {
|
||||||
|
let prompt;
|
||||||
|
|
||||||
|
const selection = editor.getSelection();
|
||||||
|
if (selection) prompt = selection;
|
||||||
|
else
|
||||||
|
prompt = (() => {
|
||||||
|
const cursorPosition = editor.getCursor();
|
||||||
|
const text = editor.getValue().split("\n");
|
||||||
|
|
||||||
|
let prompt = text.slice(0, cursorPosition.line + 1);
|
||||||
|
prompt[cursorPosition.line] = prompt[cursorPosition.line].slice(
|
||||||
|
0,
|
||||||
|
cursorPosition.ch
|
||||||
|
);
|
||||||
|
return prompt.join("\n");
|
||||||
|
})();
|
||||||
|
|
||||||
|
const trailingSpace = prompt.match(/\s+$/);
|
||||||
|
prompt = prompt.replace(/\s+$/, "");
|
||||||
|
|
||||||
|
let completion = (
|
||||||
|
await this.openai.createCompletion({
|
||||||
|
model,
|
||||||
|
prompt,
|
||||||
|
max_tokens: maxTokens,
|
||||||
|
temperature: 1,
|
||||||
|
})
|
||||||
|
).data.choices[0].text;
|
||||||
|
if (trailingSpace && completion[0] === " ")
|
||||||
|
completion = completion.slice(1);
|
||||||
|
|
||||||
|
editor.replaceSelection(selection + completion);
|
||||||
|
}
|
||||||
|
|
||||||
|
onunload() {}
|
||||||
|
|
||||||
|
async loadSettings() {
|
||||||
|
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
|
||||||
|
}
|
||||||
|
|
||||||
|
async saveSettings() {
|
||||||
|
await this.saveData(this.settings);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export default class MyPlugin extends Plugin {
|
class LoomView extends ItemView {
|
||||||
settings: MyPluginSettings;
|
constructor(leaf: WorkspaceLeaf) {
|
||||||
|
super(leaf);
|
||||||
|
|
||||||
async onload() {
|
this.containerEl.empty();
|
||||||
await this.loadSettings();
|
}
|
||||||
|
|
||||||
// This creates an icon in the left ribbon.
|
getViewType(): string {
|
||||||
const ribbonIconEl = this.addRibbonIcon('dice', 'Sample Plugin', (evt: MouseEvent) => {
|
return "loom";
|
||||||
// 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.
|
getDisplayText(): string {
|
||||||
const statusBarItemEl = this.addStatusBarItem();
|
return "Loom";
|
||||||
statusBarItemEl.setText('Status Bar Text');
|
}
|
||||||
|
|
||||||
// This adds a simple command that can be triggered anywhere
|
getIcon(): string {
|
||||||
this.addCommand({
|
return "network";
|
||||||
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 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() {
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
async loadSettings() {
|
|
||||||
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
|
|
||||||
}
|
|
||||||
|
|
||||||
async saveSettings() {
|
|
||||||
await this.saveData(this.settings);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
class SampleModal extends Modal {
|
class GPT3SettingTab extends PluginSettingTab {
|
||||||
constructor(app: App) {
|
plugin: MyPlugin;
|
||||||
super(app);
|
|
||||||
}
|
|
||||||
|
|
||||||
onOpen() {
|
constructor(app: App, plugin: MyPlugin) {
|
||||||
const {contentEl} = this;
|
super(app, plugin);
|
||||||
contentEl.setText('Woah!');
|
this.plugin = plugin;
|
||||||
}
|
}
|
||||||
|
|
||||||
onClose() {
|
display(): void {
|
||||||
const {contentEl} = this;
|
const { containerEl } = this;
|
||||||
contentEl.empty();
|
|
||||||
}
|
containerEl.empty();
|
||||||
}
|
|
||||||
|
new Setting(containerEl)
|
||||||
class SampleSettingTab extends PluginSettingTab {
|
.setName("OpenAI API key")
|
||||||
plugin: MyPlugin;
|
.setDesc("Required")
|
||||||
|
.addText((text) =>
|
||||||
constructor(app: App, plugin: MyPlugin) {
|
text.setValue(this.plugin.settings.apiKey).onChange(async (value) => {
|
||||||
super(app, plugin);
|
this.plugin.settings.apiKey = value;
|
||||||
this.plugin = plugin;
|
await this.plugin.saveSettings();
|
||||||
}
|
})
|
||||||
|
);
|
||||||
display(): void {
|
|
||||||
const {containerEl} = this;
|
new Setting(containerEl).setName("Model").addText((text) =>
|
||||||
|
text.setValue(this.plugin.settings.model).onChange(async (value) => {
|
||||||
containerEl.empty();
|
this.plugin.settings.model = value;
|
||||||
|
await this.plugin.saveSettings();
|
||||||
containerEl.createEl('h2', {text: 'Settings for my awesome plugin.'});
|
})
|
||||||
|
);
|
||||||
new Setting(containerEl)
|
|
||||||
.setName('Setting #1')
|
new Setting(containerEl).setName("Length (in tokens)").addText((text) =>
|
||||||
.setDesc('It\'s a secret')
|
text
|
||||||
.addText(text => text
|
.setValue(this.plugin.settings.maxTokens.toString())
|
||||||
.setPlaceholder('Enter your secret')
|
.onChange(async (value) => {
|
||||||
.setValue(this.plugin.settings.mySetting)
|
this.plugin.settings.maxTokens = parseInt(value);
|
||||||
.onChange(async (value) => {
|
await this.plugin.saveSettings();
|
||||||
console.log('Secret: ' + value);
|
})
|
||||||
this.plugin.settings.mySetting = value;
|
);
|
||||||
await this.plugin.saveSettings();
|
|
||||||
}));
|
new Setting(containerEl).setName("Nodes folder").addText((text) =>
|
||||||
}
|
text
|
||||||
|
.setValue(this.plugin.settings.nodesFolder)
|
||||||
|
.onChange(async (value) => {
|
||||||
|
this.plugin.settings.nodesFolder = value;
|
||||||
|
await this.plugin.saveSettings();
|
||||||
|
})
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,11 +1,10 @@
|
||||||
{
|
{
|
||||||
"id": "obsidian-sample-plugin",
|
"id": "obsidian-loom",
|
||||||
"name": "Sample Plugin",
|
"name": "Loom",
|
||||||
"version": "1.0.0",
|
"version": "0.1.0",
|
||||||
"minAppVersion": "0.15.0",
|
"minAppVersion": "0.15.0",
|
||||||
"description": "This is a sample plugin for Obsidian. This plugin demonstrates some of the capabilities of the Obsidian API.",
|
"description": "Loom in Obsidian",
|
||||||
"author": "Obsidian",
|
"author": "celeste",
|
||||||
"authorUrl": "https://obsidian.md",
|
"authorUrl": "https://celeste.exposed",
|
||||||
"fundingUrl": "https://obsidian.md/pricing",
|
|
||||||
"isDesktopOnly": false
|
"isDesktopOnly": false
|
||||||
}
|
}
|
||||||
|
|
|
||||||
2269
package-lock.json
generated
Normal file
2269
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load diff
|
|
@ -1,7 +1,7 @@
|
||||||
{
|
{
|
||||||
"name": "obsidian-sample-plugin",
|
"name": "obsidian-loom",
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"description": "This is a sample plugin for Obsidian (https://obsidian.md)",
|
"description": "Loom in Obsidian",
|
||||||
"main": "main.js",
|
"main": "main.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "node esbuild.config.mjs",
|
"dev": "node esbuild.config.mjs",
|
||||||
|
|
@ -20,5 +20,8 @@
|
||||||
"obsidian": "latest",
|
"obsidian": "latest",
|
||||||
"tslib": "2.4.0",
|
"tslib": "2.4.0",
|
||||||
"typescript": "4.7.4"
|
"typescript": "4.7.4"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"openai": "^3.1.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,3 @@
|
||||||
{
|
{
|
||||||
"1.0.0": "0.15.0"
|
"0.1.0": "0.15.0"
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue