This commit is contained in:
Tim Finley 2024-06-28 12:52:16 -04:00
commit b49d801bda
16 changed files with 2976 additions and 0 deletions

10
.editorconfig Normal file
View File

@ -0,0 +1,10 @@
# top-most EditorConfig file
root = true
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = tab
indent_size = 4
tab_width = 4

3
.eslintignore Normal file
View File

@ -0,0 +1,3 @@
node_modules/
main.js

23
.eslintrc Normal file
View File

@ -0,0 +1,23 @@
{
"root": true,
"parser": "@typescript-eslint/parser",
"env": { "node": true },
"plugins": [
"@typescript-eslint"
],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended"
],
"parserOptions": {
"sourceType": "module"
},
"rules": {
"no-unused-vars": "off",
"@typescript-eslint/no-unused-vars": ["error", { "args": "none" }],
"@typescript-eslint/ban-ts-comment": "off",
"no-prototype-builtins": "off",
"@typescript-eslint/no-empty-function": "off"
}
}

22
.gitignore vendored Normal file
View File

@ -0,0 +1,22 @@
# vscode
.vscode
# Intellij
*.iml
.idea
# npm
node_modules
# Don't include the compiled main.js file in the repo.
# They should be uploaded to GitHub releases instead.
main.js
# Exclude sourcemaps
*.map
# obsidian
data.json
# Exclude macOS Finder (System Explorer) View States
.DS_Store

1
.npmrc Normal file
View File

@ -0,0 +1 @@
tag-version-prefix=""

96
README.md Normal file
View File

@ -0,0 +1,96 @@
# 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.
- 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.
- 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

48
esbuild.config.mjs Normal file
View File

@ -0,0 +1,48 @@
import esbuild from "esbuild";
import process from "process";
import builtins from "builtin-modules";
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 context = await esbuild.context({
banner: {
js: banner,
},
entryPoints: ["src/main.ts"],
bundle: true,
external: [
"obsidian",
"electron",
"@codemirror/autocomplete",
"@codemirror/collab",
"@codemirror/commands",
"@codemirror/language",
"@codemirror/lint",
"@codemirror/search",
"@codemirror/state",
"@codemirror/view",
"@lezer/common",
"@lezer/highlight",
"@lezer/lr",
...builtins],
format: "cjs",
target: "es2018",
logLevel: "info",
sourcemap: prod ? false : "inline",
treeShaking: true,
outfile: "main.js",
});
if (prod) {
await context.rebuild();
process.exit(0);
} else {
await context.watch();
}

11
manifest.json Normal file
View File

@ -0,0 +1,11 @@
{
"id": "discourse-sync",
"name": "Sync to Discourse",
"version": "1.0.0",
"minAppVersion": "0.15.0",
"description": "Sync notes to a Discourse server.",
"author": "Tim Finley",
"authorUrl": "https://finley-group.com",
"fundingUrl": "https://finley-group.com",
"isDesktopOnly": true
}

2382
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

24
package.json Normal file
View File

@ -0,0 +1,24 @@
{
"name": "obsidian-sample-plugin",
"version": "1.0.0",
"description": "This is a sample plugin for Obsidian (https://obsidian.md)",
"main": "main.js",
"scripts": {
"dev": "node esbuild.config.mjs",
"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
"version": "node version-bump.mjs && git add manifest.json versions.json"
},
"keywords": [],
"author": "",
"license": "MIT",
"devDependencies": {
"@types/node": "^16.11.6",
"@typescript-eslint/eslint-plugin": "5.29.0",
"@typescript-eslint/parser": "5.29.0",
"builtin-modules": "3.3.0",
"esbuild": "0.17.3",
"obsidian": "latest",
"tslib": "2.4.0",
"typescript": "4.7.4"
}
}

68
src/config.ts Normal file
View File

@ -0,0 +1,68 @@
import { PluginSettingTab, Setting, App } from 'obsidian';
import DiscourseSyncPlugin from './main';
export interface DiscourseSyncSettings {
baseUrl: string;
apiKey: string;
disUser: string;
category: number;
}
export const DEFAULT_SETTINGS: DiscourseSyncSettings = {
baseUrl: "https://yourforum.example.com",
apiKey: "apikey",
disUser: "DiscourseUsername",
category: 1,
};
export class DiscourseSyncSettingsTab extends PluginSettingTab {
plugin: DiscourseSyncPlugin;
constructor(app: App, plugin: DiscourseSyncPlugin) {
super(app, plugin);
}
display(): void {
const { containerEl } = this;
containerEl.empty();
containerEl.createEl("h2", { text: "Discourse Sync" });
new Setting(containerEl)
.setName("Base URL")
.setDesc("base url of discourse server")
.addText((text) =>
text
.setPlaceholder("https://forum.example.com")
.setValue(this.plugin.settings.baseUrl)
.onChange(async (value) => {
this.plugin.settings.baseUrl = value;
await this.plugin.saveSettings();
})
);
new Setting(containerEl)
.setName("API Key")
.setDesc("user created API Key")
.addText((text) =>
text
.setPlaceholder("api_key")
.setValue(this.plugin.settings.apiKey)
.onChange(async (value) => {
this.plugin.settings.apiKey = value;
await this.plugin.saveSettings();
})
);
new Setting(containerEl)
.setName("Username")
.setDesc("Discourse Username")
.addText((text) =>
text
.setPlaceholder("username")
.setValue(this.plugin.settings.disUser)
.onChange(async (value) => {
this.plugin.settings.disUser = value;
await this.plugin.saveSettings();
}),
);
}
}

239
src/main.ts Normal file
View File

@ -0,0 +1,239 @@
import { App, Menu, MenuItem, Plugin, Modal, requestUrl, TFile } from 'obsidian';
import { DEFAULT_SETTINGS, DiscourseSyncSettings, DiscourseSyncSettingsTab } from './config';
export default class DiscourseSyncPlugin extends Plugin {
settings: DiscourseSyncSettings;
activeFile: { name: string; content: string };
async onload() {
await this.loadSettings();
this.addSettingTab(new DiscourseSyncSettingsTab(this.app, this));
this.registerEvent(
this.app.workspace.on("file-menu", (menu, file: TFile) => {
this.registerDirMenu(menu, file);
}),
);
this.addCommand({
id: "category-modal",
name: "Category Modal",
callback: () => {
this.openCategoryModal();
},
});
}
async loadSettings() {
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
}
async saveSettings() {
await this.saveData(this.settings);
}
extractImageReferences(content: string): string[] {
const regex = /!\[\[(.*?)\]\]/g;
const matches = [];
let match;
while ((match = regex.exec(content)) !== null) {
matches.push(match[1]);
}
console.log("matches:", matches);
return matches;
}
async uploadImages(imageReferences: string[]): Promise<string[]> {
const imageUrls = [];
for (const ref of imageReferences) {
const filePath = this.app.metadataCache.getFirstLinkpathDest(ref, this.activeFile.name)?.path;
if (filePath) {
const file = this.app.vault.getAbstractFileByPath(filePath) as TFile;
if (file) {
try {
const arrayBuffer = await this.app.vault.readBinary(file);
const formData = new FormData();
formData.append("file", new Blob([arrayBuffer]), file.name);
formData.append("type", "composer");
const url = `${this.settings.baseUrl}/uploads.json`;
const headers = {
"Api-Key": this.settings.apiKey,
"Api-Username": this.settings.disUser,
};
const response = await fetch(url, {
method: "POST",
body: formData,
headers,
});
console.log(`Upload Image response: ${response.status}`);
if (response.ok) {
const jsonResponse = response.json();
console.log(`Upload Image jsonResponse: ${JSON.stringify(jsonResponse)}`);
imageUrls.push(jsonResponse.url);
} else {
console.error("Error uploading image:", response.status, await response.text());
}
} catch (error) {
console.error("Exception while uploading image:", error);
}
} else {
console.error(`File not found in vault: ${ref}`);
}
} else {
console.error(`Unable to resolve file path for: ${ref}`);
}
}
return imageUrls;
}
async postTopic(): Promise<{ message: string }> {
const url = `${this.settings.baseUrl}/posts.json`;
const headers = {
"Content-Type": "application/json",
"Api-Key": this.settings.apiKey,
"Api-Username": this.settings.disUser,
}
let content = this.activeFile.content;
const imageReferences = this.extractImageReferences(content);
const imageUrls = await this.uploadImages(imageReferences);
imageReferences.forEach((ref, index) => {
const obsRef = `![[${ref}]]`;
const discoRef = `![${ref}](${imageUrls[index]})`;
content = content.replace(obsRef, discoRef);
});
const body = JSON.stringify({
title: this.activeFile.name,
raw: content,
category: this.settings.category
});
console.log("POST Body:", body);
const response = await requestUrl({
url: url,
method: "POST",
contentType: "application/json",
body,
headers,
});
if (response.status !== 200) {
console.error("Error publishing to Discourse:", response.status);
console.error("Response body:", response.text);
if (response.status == 422) {
console.error("there's an error with this post, try making a longer title");
}
return { message: "Error publishing to Discourse" };
}
//const jsonResponse = response.json;
//console.log(`jsonResponse: ${JSON.stringify(jsonResponse, null, 2)}`);
return { message: "Success" };
}
private async fetchCategories() {
const url = `${this.settings.baseUrl}/categories.json?include_subcategories=true`;
const headers = {
"Content-Type": "application/json",
"Api-Key": this.settings.apiKey,
"Api-Username": this.settings.disUser,
};
try {
const response = await requestUrl({
url: url,
method: "GET",
contentType: "application/json",
headers,
});
const data = await response.json;
const categories = data.category_list.categories;
const allCategories = categories.flatMap((category: any) => {
const subcategories = category.subcategory_list?.map((sub: any) => ({
id: sub.id,
name: sub.name,
})) || [];
return [
{ id: category.id, name: category.name },
...subcategories,
];
});
return allCategories;
} catch (error) {
console.error("Error fetching categories:", error);
return [];
}
}
registerDirMenu(menu: Menu, file: TFile) {
const syncDiscourse = (item: MenuItem) => {
item.setTitle("Sync to Discourse");
item.onClick(async () => {
this.activeFile = {
name: file.basename,
content: await this.app.vault.read(file)
};
await this.syncToDiscourse();
});
}
menu.addItem(syncDiscourse)
}
private async openCategoryModal() {
const categories = await this.fetchCategories();
if (categories.length > 0) {
new SelectCategoryModal(this.app, this, categories).open();
} else {
console.error("No categories");
}
}
private async syncToDiscourse() {
await this.openCategoryModal();
}
onunload() {}
}
export class SelectCategoryModal extends Modal {
plugin: DiscourseSyncPlugin;
categories: {id: number; name: string}[];
constructor(app: App, plugin: DiscourseSyncPlugin, categories: {id: number; name: string }[]) {
super(app);
this.plugin = plugin;
this.categories = categories
}
onOpen() {
const { contentEl } = this;
contentEl.createEl("h1", { text: 'Select a category for syncing' });
const selectEl = contentEl.createEl('select');
this.categories.forEach(category => {
const option = selectEl.createEl('option', { text: category.name });
option.value = category.id.toString();
});
const submitButton = contentEl.createEl('button', { text: 'Submit' });
submitButton.onclick = async () => {
const selectedCategoryId = selectEl.value;
this.plugin.settings.category = parseInt(selectedCategoryId);
await this.plugin.saveSettings();
const reply = await this.plugin.postTopic();
console.log(`postTopic message: ${reply.message}`);
console.log(`ID: ${selectedCategoryId}`);
this.close();
};
}
onClose() {
const { contentEl } = this;
contentEl.empty();
}
}

8
styles.css Normal file
View File

@ -0,0 +1,8 @@
/*
This CSS file will be included with your plugin, and
available in the app when your plugin is enabled.
If your plugin does not need CSS, delete this file.
*/

24
tsconfig.json Normal file
View File

@ -0,0 +1,24 @@
{
"compilerOptions": {
"baseUrl": ".",
"inlineSourceMap": true,
"inlineSources": true,
"module": "ESNext",
"target": "ES6",
"allowJs": true,
"noImplicitAny": true,
"moduleResolution": "node",
"importHelpers": true,
"isolatedModules": true,
"strictNullChecks": true,
"lib": [
"DOM",
"ES5",
"ES6",
"ES7"
]
},
"include": [
"**/*.ts"
]
}

14
version-bump.mjs Normal file
View File

@ -0,0 +1,14 @@
import { readFileSync, writeFileSync } from "fs";
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"));
// 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"));

3
versions.json Normal file
View File

@ -0,0 +1,3 @@
{
"1.0.0": "0.15.0"
}