LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2025 MurphyChen.
+Copyright (C) 2020-2025 by Dynalist Inc.
 
 Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.
 

README.md

@@ -5,15 +5,9 @@ This is an Obsidian plugin designed to open projects or files directly in GitHub
 ![preview1](./.github/img/preview1.png)
 ![preview2](./.github/img/preview2.png)
 
-## Installation
+## Manually installing the plugin
 
-1. Download Release Files:
-    - main.js
-    - manifest.json
-2. Copy Files to Plugin Folder:
-    Paste the downloaded files into your vault’s plugin folder: `VaultFolder/.obsidian/plugins/open-in-github`
-3. Enable the Plugin:
-    Restart Obsidian, go to Settings > Community plugins and enable the plugin.
+- Copy over `main.js`,`manifest.json`,`styles.css` to your vault `VaultFolder/.obsidian/plugins/open-in-github`.
 
 ## Development
 

main.ts

@@ -1,6 +1,7 @@
-import { Notice, Plugin, addIcon, TFile, Vault } from 'obsidian'
+import { Notice, Plugin,  addIcon } from 'obsidian'
+import * as path from 'path'
+import * as fs from 'fs'
 
-// open github icon
 const customIcon = `<svg xmlns="http://www.w3.org/2000/svg" width="96" height="96" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
 <path d="M15 22v-4a4.8 4.8 0 0 0-1-3.5c3 0 6-2 6-5.5.08-1.25-.27-2.48-1-3.5.28-1.15.28-2.35 0-3.5 0 0-1 0-3 1.5-2.64-.5-5.36-.5-8 0C6 2 5 2 5 2c-.3 1.15-.3 2.35 0 3.5A5.403 5.403 0 0 0 4 9c0 3.5 3 5.5 6 5.5-.39.49-.68 1.05-.85 1.65-.17.6-.22 1.23-.15 1.85v4"/>
 <path d="M9 18c-4.51 2-5-2-7-2"/>
@@ -17,213 +18,199 @@ const CONSTS = {
   TITLE: 'Open in GitHub'
 }
 
-// Define constants for git paths relative to vault root
-const GIT_DIR = '.git'
-const GIT_CONFIG_PATH = `${GIT_DIR}/config`
-const GIT_HEAD_PATH = `${GIT_DIR}/HEAD`
+interface OpenInGitHubPluginSettings {
+  mySetting: string
+}
+
+const DEFAULT_SETTINGS: OpenInGitHubPluginSettings = {
+  mySetting: 'default'
+}
 
 export default class OpenInGitHubPlugin extends Plugin {
-  vaultAdapter: Vault['adapter']
+  settings: OpenInGitHubPluginSettings
 
   async onload() {
-    // Use vault adapter
-    this.vaultAdapter = this.app.vault.adapter
-
-    // Check if adapter exists (basic check for environment support)
-    if (!this.vaultAdapter) {
-      console.error("OpenInGitHubPlugin: Vault adapter is not available. Plugin may not work correctly.")
-      new Notice("OpenInGitHubPlugin: Vault adapter not found. Some features might be limited.")
-    }
+    await this.loadSettings()
 
     // add icon
     addIcon(CONSTS.TITLE_ID, customIcon)
 
-    // left open-in-github button
-    this.addRibbonIcon(CONSTS.TITLE_ID, CONSTS.TITLE, (evt) => this.openGitHub(evt)) // Pass event directly
+    // Left open-in-github button
+    const ribbonIconEl = this.addRibbonIcon(CONSTS.TITLE_ID, CONSTS.TITLE, this.openGitHub)
 
     // add file menu
     this.registerEvent(
       this.app.workspace.on('file-menu', (menu, file) => {
-        // Only add if the file is potentially in a git repo
-        if (file instanceof TFile) {
-          menu.addItem((item) => {
-            item
-              .setTitle(CONSTS.TITLE)
-              .setIcon(CONSTS.TITLE_ID)
-              .onClick((e) => this.openGitHub(e as MouseEvent, file)) // Pass file context
-          })
-        }
+        menu.addItem((item) => {
+          item
+            .setTitle(CONSTS.TITLE)
+            .setIcon(CONSTS.TITLE_ID)
+            .onClick((e) => this.openGitHub(e as MouseEvent, true));
+        });
       })
-    )
+    );
 
-    // add editor menu
+    // add editormenu
     this.registerEvent(
       this.app.workspace.on("editor-menu", (menu, editor, view) => {
-        // Only add if the file is potentially in a git repo
-        if (view?.file) {
-          menu.addItem((item) => {
-            item
-              .setTitle(CONSTS.TITLE)
-              .setIcon(CONSTS.TITLE_ID)
-              .onClick((e) => this.openGitHub(e as MouseEvent, view.file as TFile)) // Pass file context
-          })
-        }
+        menu.addItem((item) => {
+          item
+            .setTitle(CONSTS.TITLE)
+            .setIcon(CONSTS.TITLE_ID)
+            .onClick((e) => this.openGitHub(e as MouseEvent, true));
+        });
       })
-    )
+    );
+
+    // Perform additional things with the ribbon
+    ribbonIconEl.addClass('my-plugin-ribbon-class')
+
+    // Bottom right open-file-in-github button
+    // This adds a status bar item to the bottom of the app. Does not work on mobile apps.
+    // const statusBarItemEl = this.addStatusBarItem();
+    // const parser = new DOMParser()
+    // const svgDoc = parser.parseFromString(customIcon(24, 80), 'image/svg+xml')
+    // const svgElement = svgDoc.documentElement as unknown as HTMLElement
+    // svgElement.setAttribute('width', '16');
+    // svgElement.setAttribute('height', '16');
+    // statusBarItemEl.appendChild(svgElement);
+    // statusBarItemEl.addEventListener('click', e => openGitHub(e, true))
+
+    // 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)
   }
 
   /**
    * open github in browser
-   * @param evt The mouse event that triggered the action
-   * @param file The file context (optional), if triggered from file/editor menu
+   * @param evt 
+   * @param openFile 
    */
-  openGitHub = async (evt: MouseEvent, file?: TFile) => {
+  openGitHub = async (evt: MouseEvent, openFile?: boolean) => {
     try {
-      // Determine the file path to use
-      const targetFile = file // this.app.workspace.getActiveFile()
-      const openFileInRepo = !!targetFile // True if we have a file context
-
       const repoUrl = await this.getGitHubRepoUrl()
-      if (!repoUrl) {
-        // Notice is shown within getGitHubRepoUrl if needed
-        return
-      }
-
-      if (openFileInRepo && targetFile) {
-        // Use targetFile.path which is relative to the vault root
-        const filePathRelative = targetFile.path
-        let branch = await this.getCurrentBranch()
-        if (!branch) {
-          // Default to 'main' if branch detection fails
-          branch = 'main'
-          new Notice("Could not detect current branch, defaulting to 'main'.")
+      if (repoUrl) {
+        const fileRelativePath = this.app.workspace.getActiveFile()
+        if (openFile) {
+          if (fileRelativePath?.path) {
+            let branch = await this.getCurrentBranch(fileRelativePath?.path)
+            if (!branch) {
+              branch = 'main'
+            }
+            const fileUrl = `${repoUrl}/blob/${branch}/${fileRelativePath?.path}`
+            window.open(fileUrl, '_blank')
+          } else {
+            new Notice('Not found file relative path!')
+          }
+        } else {
+          window.open(repoUrl, '_blank')
         }
-        const fileUrl = `${repoUrl}/blob/${branch}/${filePathRelative}`
-        window.open(fileUrl, '_blank')
-
-      } else if (!openFileInRepo) {
-        // If no file context (e.g., ribbon click), open the repo root
-        window.open(repoUrl, '_blank')
       } else {
-        // Case where we intended to open a file, but targetFile is null/undefined
-        new Notice('No active file selected to open in GitHub.')
+        new Notice('Could not determine GitHub repository URL.')
       }
-
     } catch (err) {
       new Notice('Failed to open GitHub repository.')
-      console.error("OpenInGitHubPlugin Error:", err)
+      console.error(err)
     }
   }
 
   /**
-   * Get the GitHub repository URL for the current vault using Vault adapter.
+   * Get the GitHub repository URL for the current vault.
    */
   async getGitHubRepoUrl(): Promise<string | null> {
-    if (!this.vaultAdapter) {
-      new Notice('Vault adapter not available. Cannot access file system.')
+    const vaultPath = this.getVaultBasePath()
+    if (!vaultPath) {
+      new Notice('This feature is only supported in the desktop app.')
       return null
     }
 
-    try {
-      // Check if .git directory exists at the vault root
-      const gitDirExists = await this.vaultAdapter.exists(GIT_DIR)
-      if (!gitDirExists) {
-        new Notice('No .git directory found in the vault root.')
-        return null
-      }
-
-      // Check if .git/config file exists
-      const configPathExists = await this.vaultAdapter.exists(GIT_CONFIG_PATH)
-      if (!configPathExists) {
-        new Notice('No .git/config file found.')
-        return null
-      }
-
-      // Read the config file content
-      const configContent = await this.vaultAdapter.read(GIT_CONFIG_PATH)
-
-      // Find the remote "origin" URL
-      const remoteMatch = configContent.match(/\[remote\s+"origin"\][^[]*?\n\s*url\s*=\s*(.*)/)
-      if (!remoteMatch || !remoteMatch[1]) {
-        new Notice('No remote "origin" URL found in .git/config.')
-        return null
-      }
-
-      const remoteUrl = remoteMatch[1].trim()
-      const githubUrl = this.convertToGitHubUrl(remoteUrl)
-
-      if (!githubUrl) {
-        new Notice('Could not parse GitHub URL from remote "origin".')
-        return null
-      }
-
-      return githubUrl
-
-    } catch (error) {
-      console.error("OpenInGitHubPlugin: Error accessing git config:", error)
-      new Notice("Error accessing git configuration.")
+    const gitDir = path.join(vaultPath, '.git')
+    if (!fs.existsSync(gitDir)) {
+      new Notice('No .git directory found in the vault.')
       return null
     }
+
+    const configPath = path.join(gitDir, 'config')
+    if (!fs.existsSync(configPath)) {
+      new Notice('No .git/config file found.')
+      return null
+    }
+
+    const configContent = fs.readFileSync(configPath, 'utf-8')
+    const remoteMatch = configContent.match(/\[remote "origin"\][\s\S]*?url\s*=\s*(.*)/)
+    if (!remoteMatch) {
+      new Notice('No remote "origin" found in .git/config.')
+      return null
+    }
+
+    const remoteUrl = remoteMatch[1].trim()
+    return this.convertToGitHubUrl(remoteUrl)
   }
 
   /**
-   * Convert a Git remote URL to a GitHub web URL.
+   * Convert a Git remote URL to a GitHub URL.
    */
   convertToGitHubUrl(remoteUrl: string): string | null {
     // Handle HTTPS URLs (e.g., https://github.com/user/repo.git)
-    let match = remoteUrl.match(/^https?:\/\/github\.com\/([^/]+\/[^/]+?)(?:\.git)?$/)
-    if (match) {
-      return `https://github.com/${match[1]}`
+    if (remoteUrl.startsWith('https://')) {
+      return remoteUrl.replace(/\.git$/, '')
     }
 
     // Handle SSH URLs (e.g., git@github.com:user/repo.git)
-    match = remoteUrl.match(/^git@github\.com:([^/]+\/[^/]+?)(?:\.git)?$/)
-    if (match) {
-      return `https://github.com/${match[1]}`
+    if (remoteUrl.startsWith('git@')) {
+      return remoteUrl.replace(':', '/').replace('git@', 'https://').replace(/\.git$/, '')
     }
 
-    return null // Return null if format is not recognized
+    return null
   }
 
   /**
-   * Get the current branch of the Git repository using Vault adapter.
+   * Get the base path of the vault (only works in desktop app).
    */
-  async getCurrentBranch(): Promise<string | null> {
-    if (!this.vaultAdapter) {
-      new Notice('Vault adapter not available. Cannot access file system.')
-      return null
-    }
-
-    try {
-      // Check if .git directory exists
-      const gitDirExists = await this.vaultAdapter.exists(GIT_DIR)
-      if (!gitDirExists) {
-        // No notice here, as getGitHubRepoUrl would likely fail first
-        return null
-      }
-
-      // Check if .git/HEAD file exists
-      const headPathExists = await this.vaultAdapter.exists(GIT_HEAD_PATH)
-      if (!headPathExists) {
-        new Notice('No .git/HEAD file found. Cannot determine branch.')
-        return null
-      }
-
-      // Read the HEAD file content
-      const headContent = (await this.vaultAdapter.read(GIT_HEAD_PATH)).trim()
-
-      // Example HEAD content: "ref: refs/heads/main" or "ref: refs/heads/feature/branch"
-      const branchMatch = headContent.match(/^ref:\s+refs\/heads\/(.*)/)
-      if (branchMatch && branchMatch[1]) {
-        return branchMatch[1] // Return the branch name
-      }
-
-      new Notice('Could not parse branch name from .git/HEAD.')
-      return null
-    } catch (error) {
-      console.error("OpenInGitHubPlugin: Error reading git HEAD:", error)
-      new Notice("Error reading git branch information.")
-      return null
+  getVaultBasePath(): string | null {
+    // @ts-ignore
+    if (this.app.vault.adapter?.getBasePath) {
+      // @ts-ignore
+      return this.app.vault.adapter.getBasePath()
     }
+    return null
   }
-}
+
+  /**
+   * Get the current branch of the Git repository.
+   */
+  async getCurrentBranch(filePath: string): Promise<string | null> {
+    const vaultPath = this.getVaultBasePath()
+    if (!vaultPath) {
+      new Notice('This feature is only supported in the desktop app.')
+      return null
+    }
+
+    const gitDir = path.join(vaultPath, '.git')
+    if (!fs.existsSync(gitDir)) {
+      new Notice('No .git directory found in the vault.')
+      return null
+    }
+
+    const headPath = path.join(gitDir, 'HEAD');
+    const headContent = fs.readFileSync(headPath, 'utf-8').trim();
+
+    // Example: ref: refs/heads/main
+    const branchMatch = headContent.match(/ref: refs\/heads\/(.*)/);
+    if (branchMatch) {
+      return branchMatch[1];
+    }
+
+    return null;
+  }
+}

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "open-in-github",
 	"name": "Open in GitHub",
-	"version": "1.0.3",
+	"version": "1.0.0",
 	"minAppVersion": "0.15.0",
 	"description": "Open the current project or file in github.com.",
 	"author": "Murphy Chen",

package.json

@@ -1,7 +1,7 @@
 {
-	"name": "obsidian-open-in-github-plugin",
-	"version": "1.0.3",
-	"description": "This is an Obsidian plugin designed to open project or files directly in GitHub via your browser.",
+	"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",

styles.css

@@ -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.
+
+*/

versions.json

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