feat: ✨ Add "Open File in GitHub" Command, fix #149

esbuild.config.mjs

@@ -18,7 +18,7 @@ esbuild.build({
     },
     entryPoints: ['src/main.ts'],
     bundle: true,
-    external: ['obsidian'],
+    external: ['obsidian', 'electron'],
     format: 'cjs',
     watch: !prod,
     target: 'es2016',

package.json

@@ -16,6 +16,7 @@
     },
     "devDependencies": {
         "@types/node": "^14.14.2",
+        "electron": "^16.0.5",
         "esbuild": "^0.12.26",
         "esbuild-svelte": "^0.5.4",
         "obsidian": "https://github.com/obsidianmd/obsidian-api/tarball/master",

src/main.ts

@@ -7,6 +7,7 @@ import { ChangedFilesModal } from "src/ui/modals/changedFilesModal";
 import { CustomMessageModal } from "src/ui/modals/customMessageModal";
 import { DEFAULT_SETTINGS, VIEW_CONFIG } from "./constants";
 import { GitManager } from "./gitManager";
+import openInGitHub from "./openInGitHub";
 import { SimpleGit } from "./simpleGit";
 import { ObsidianGitSettings, PluginState } from "./types";
 import addIcons from "./ui/icons";
@@ -61,6 +62,12 @@ export default class ObsidianGit extends Plugin {
             },
         });
 
+        this.addCommand({
+            id: 'view-file-in-github',
+            name: 'Open File in GitHub',
+            editorCallback: (editor, {file}) => openInGitHub(editor, file, this.gitManager),
+        });
+
         this.addCommand({
             id: "pull",
             name: "Pull",

src/openInGitHub.ts

@@ -0,0 +1,15 @@
+import { Editor, Notice, TFile } from "obsidian";
+import { GitManager } from "./gitManager";
+import { shell } from "electron";
+
+export default async function openInGitHub(editor: Editor, file: TFile, manager: GitManager) {
+    const remoteUrl = await manager.getConfig('remote.origin.url') as string;
+    const branch = (await manager.branchInfo()).current;
+    const [url, user, repo] = remoteUrl.match(/(?>^https:\/\/github\.com\/(.*)\/(.*)\.git$)|(?>^git@github\.com:(.*)\/(.*)\.git$)/);
+    //If Github is used
+    if (url) {
+        await shell.openExternal(`https://github.com/${user}/${repo}/blob/${branch}/${file.path}`);
+    } else {
+        new Notice('It seems like you are not using GitHub');
+    }
+}