initial commit

.editorconfig

@@ -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

.eslintignore

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

.eslintrc

@@ -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"
+    } 
+  }

.gitignore

@@ -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

.npmrc

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

README.md

@@ -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

esbuild.config.mjs

@@ -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: ["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();
+}

main.ts

@@ -0,0 +1,2 @@
+import { GithubLinkPlugin } from "src/plugin";
+export default GithubLinkPlugin;

manifest.json

@@ -0,0 +1,11 @@
+{
+	"id": "github-link",
+	"name": "GitHub Link",
+	"version": "1.0.0",
+	"minAppVersion": "0.15.0",
+	"description": "Demonstrates some of the capabilities of the Obsidian API.",
+	"author": "Nathonius",
+	"authorUrl": "https://obsidian.md",
+	"fundingUrl": "https://obsidian.md/pricing",
+	"isDesktopOnly": false
+}

package.json

@@ -0,0 +1,31 @@
+{
+	"name": "obsidian-github-link",
+	"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",
+		"octokit": "^3.1.2"
+	},
+	"dependencies": {
+		"@octokit/auth-oauth-device": "^6.0.1",
+		"@octokit/core": "^5.0.2",
+		"@octokit/plugin-rest-endpoint-methods": "^10.2.0",
+		"@octokit/request": "^8.1.6"
+	}
+}

src/auth-modal.ts

@@ -0,0 +1,37 @@
+import { App, Modal, setIcon } from "obsidian";
+
+import { Verification } from "@octokit/auth-oauth-device/dist-types/types";
+
+export class AuthModal extends Modal {
+	constructor(app: App, private readonly verification: Verification) {
+		super(app);
+	}
+	onOpen(): void {
+		this.titleEl.setText("Generate GitHub token");
+		this.contentEl.empty();
+		const wrapper = this.contentEl.createDiv({ cls: "gh-auth-modal" });
+		wrapper.createEl("p", {
+			text: "Copy the following code and paste it at the github link below.",
+		});
+		const codeEl = wrapper.createDiv({
+			cls: "gh-auth-code-section",
+		});
+		codeEl.createSpan({
+			cls: "auth-code",
+			text: this.verification.user_code,
+		});
+		const button = codeEl.createEl("button", {
+			attr: { type: "button", "aria-label": "Copy Code" },
+		});
+		setIcon(button, "copy");
+		button.addEventListener("click", this.copyToClipboard.bind(this));
+		wrapper.createEl("a", {
+			href: this.verification.verification_uri,
+			text: this.verification.verification_uri,
+		});
+	}
+
+	private copyToClipboard() {
+		window.navigator.clipboard.writeText(this.verification.user_code);
+	}
+}

src/github.ts

@@ -0,0 +1,199 @@
+import { RequestUrlParam, requestUrl } from "obsidian";
+
+import { GithubLinkPluginSettings } from "./settings";
+import { OnVerificationCallback } from "@octokit/auth-oauth-device/dist-types/types";
+import { createOAuthDeviceAuth } from "@octokit/auth-oauth-device";
+import { request } from "@octokit/request";
+
+interface ParsedUrl {
+	url: string;
+	host: string;
+	org?: string;
+	repo?: string;
+	issue?: number;
+	pr?: number;
+	code?: {
+		branch?: string;
+		path?: string;
+	};
+	commit?: string;
+}
+
+// TODO: Clean this file up, lots of junk in here
+
+export async function githubRequest(
+	config: RequestUrlParam,
+	settings: GithubLinkPluginSettings
+) {
+	if (!config.headers) {
+		config.headers = {};
+	}
+	config.headers.Accept = "application/vnd.github+json";
+	config.headers["X-GitHub-Api-Version"] = "2022-11-28";
+	if (settings.token) {
+		config.headers.Authorization = `Bearer ${settings.token}`;
+	}
+	try {
+		const response = await requestUrl(config);
+		return response;
+	} catch (err) {
+		console.error(err);
+		throw err;
+	}
+}
+
+export function parseUrl(urlString: string): ParsedUrl {
+	// Some potential URLs:
+	// https://github.com/nathonius/alloy-theme
+	// https://github.com/nathonius/obsidian-trello/issues/45
+	// https://github.com/nathonius/obsidian-trello/pull/54
+	// https://github.com/nathonius/obsidian-trello/blob/main/src/constants.ts
+	// https://github.com/nathonius/obsidian-trello/blob/markdown/src/constants.ts
+	// https://github.com/nathonius/obsidian-trello/blob/markdown/src/constants.ts#L44-L58
+	// https://github.com/nathonius/obsidian-trello/commit/7ea069dd0641441ec20fb194f50e746a21abbaf1
+	// https://github.com/nathonius/obsidian-trello/commit/7ea069dd0641441ec20fb194f50e746a21abbaf1#diff-8fa4b52909f895e8cda060d2035234e0a42ca2c7d3f8f8de1b35a056537bf199R35
+	const url = new URL(urlString);
+	const parsedUrl: ParsedUrl = { url: urlString, host: url.hostname };
+
+	const urlParts = url.pathname.split("/");
+	if (urlParts.length >= 4) {
+		switch (urlParts[3].toLowerCase()) {
+			case "issues":
+				if (urlParts[4]) {
+					const issueNumber = parseInt(urlParts[4], 10);
+					if (!isNaN(issueNumber)) {
+						parsedUrl.issue = issueNumber;
+					}
+				}
+				break;
+			case "pull":
+				if (urlParts[4]) {
+					const prNumber = parseInt(urlParts[4], 10);
+					if (!isNaN(prNumber)) {
+						parsedUrl.pr = prNumber;
+					}
+				}
+				break;
+			case "blob":
+				parsedUrl.code = {};
+				if (urlParts[4]) {
+					parsedUrl.code.branch = urlParts[4];
+				}
+				if (urlParts[5]) {
+					const pathParts = urlParts.slice(5);
+					parsedUrl.code.path = pathParts.join("/");
+				}
+				break;
+			case "commit":
+				if (urlParts[4]) {
+					parsedUrl.commit = urlParts.slice(4).join("/");
+				}
+				break;
+		}
+	}
+	if (urlParts.length >= 3) {
+		parsedUrl.repo = urlParts[2];
+	}
+	if (urlParts.length >= 2) {
+		parsedUrl.org = urlParts[1];
+	}
+
+	return parsedUrl;
+}
+
+async function doFetch(
+	url: RequestInfo | URL,
+	options?: RequestInit | undefined
+): Promise<Response> {
+	// Octokit always uses a url + options, not a Request object
+	if (typeof url !== "string") {
+		throw new Error(
+			"Something has gone horribly wrong and fetch has received unexpected arguments."
+		);
+	}
+	if (options === undefined) {
+		throw new Error("No options given to fetch.");
+	}
+
+	const headers = getHeaders(options.headers);
+	const contentType = headers?.["Content-Type"];
+	const params: RequestUrlParam = {
+		url,
+		headers,
+		method: options.method,
+		body: getBody(options.body),
+		contentType,
+	};
+	const result = await requestUrl(params);
+	const partialResult = {
+		...result,
+		url,
+		headers: new Headers(result.headers),
+		arrayBuffer: () => Promise.resolve(result.arrayBuffer),
+		text: () => Promise.resolve(result.text),
+		json: () => Promise.resolve(result.json),
+	} as Omit<
+		Response,
+		| "ok"
+		| "body"
+		| "statusText"
+		| "redirected"
+		| "type"
+		| "clone"
+		| "bodyUsed"
+		| "blob"
+		| "formData"
+	>;
+	return partialResult as Response;
+}
+
+function getHeaders(
+	headers: HeadersInit | undefined
+): Record<string, string> | undefined {
+	if (!headers) {
+		return undefined;
+	}
+	if (headers instanceof Headers) {
+		const result: Record<string, string> = {};
+		headers.forEach((value, key) => {
+			result[key] = value;
+		});
+		return result;
+	}
+	if (Array.isArray(headers)) {
+		throw new Error(
+			"Got array headers, we don't know what to do with this yet."
+		);
+	}
+	return headers;
+}
+
+function getBody(
+	body: BodyInit | null | undefined
+): string | ArrayBuffer | undefined {
+	if (!body) {
+		return undefined;
+	}
+	if (body instanceof ArrayBuffer || typeof body === "string") {
+		return body;
+	}
+	console.warn(`Got an unknown body parameter type, trying to stringify it.`);
+	console.warn(body);
+	try {
+		return JSON.stringify(body);
+	} catch {
+		console.error("Could not stringify body parameter.");
+		return undefined;
+	}
+}
+
+export const auth = (verificationHandler: OnVerificationCallback) =>
+	createOAuthDeviceAuth({
+		clientType: "oauth-app",
+		clientId: "baf0370cb98e1387d244",
+		scopes: ["repo"],
+		onVerification: verificationHandler,
+		request: request.defaults({
+			request: { fetch: doFetch },
+		}),
+	});

src/plugin.ts

@@ -0,0 +1,14 @@
+import {
+	GithubLinkPluginSettings,
+	GithubLinkPluginSettingsTab,
+} from "./settings";
+
+import { Plugin } from "obsidian";
+
+export class GithubLinkPlugin extends Plugin {
+	public settings: GithubLinkPluginSettings = {};
+	async onload() {
+		this.settings = Object.assign({}, await this.loadData());
+		this.addSettingTab(new GithubLinkPluginSettingsTab(this.app, this));
+	}
+}

src/settings.ts

@@ -0,0 +1,65 @@
+import { App, PluginSettingTab, Setting } from "obsidian";
+
+import { AuthModal } from "./auth-modal";
+import { GithubLinkPlugin } from "./plugin";
+import { Verification } from "@octokit/auth-oauth-device/dist-types/types";
+import { auth } from "./github";
+
+export interface GithubLinkPluginSettings {
+	token?: string;
+}
+
+export class GithubLinkPluginSettingsTab extends PluginSettingTab {
+	authModal: AuthModal | null = null;
+
+	constructor(public app: App, private readonly plugin: GithubLinkPlugin) {
+		super(app, plugin);
+	}
+
+	display() {
+		const { containerEl } = this;
+		containerEl.empty();
+		containerEl.createEl("h2", { text: "GitHub authentication" });
+
+		containerEl.createEl(
+			"p",
+			"No authentication is required to reference public repositories. Providing a token allows referencing private repos, but the token is stored in plain text."
+		);
+
+		new Setting(containerEl)
+			.setName("Token")
+			.setDesc(
+				"A GitHub token, which can be generated automatically (recommended) or by creating a personal access token (not recommended)."
+			)
+			.addButton((button) => {
+				button.setButtonText("Generate Token");
+				button.onClick(this.generateToken.bind(this));
+			})
+			.addText((text) => {
+				text.setPlaceholder("Personal Access Token");
+				if (this.plugin.settings.token) {
+					text.setValue(this.plugin.settings.token);
+				}
+			});
+	}
+
+	private saveSettings() {
+		return this.plugin.saveData(this.plugin.settings);
+	}
+
+	private async generateToken() {
+		const authResult = await auth(this.tokenVerification.bind(this))({
+			type: "oauth",
+		});
+		this.authModal?.close();
+		this.authModal = null;
+		this.plugin.settings.token = authResult.token;
+		await this.saveSettings();
+		this.display();
+	}
+
+	private tokenVerification(verification: Verification) {
+		this.authModal = new AuthModal(this.app, verification);
+		this.authModal.open();
+	}
+}

styles.css

@@ -0,0 +1,16 @@
+.gh-auth-modal {
+	display: flex;
+	flex-direction: column;
+	align-items: center;
+}
+
+.gh-auth-code-section {
+	display: flex;
+	gap: 10px;
+	justify-content: center;
+	align-items: center;
+}
+
+.auth-code {
+	font-size: 3em;
+}

tsconfig.json

@@ -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"
+  ]
+}

version-bump.mjs

@@ -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"));

versions.json

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