👍 Support aliases.json to define custom aliases

Author: lambdalisue

bin/browse.ts

@@ -1,7 +1,9 @@
-#!/usr/bin/env -S deno run --allow-run --allow-read
+#!/usr/bin/env -S deno run --allow-run --allow-read --allow-env
 import { parse } from "https://deno.land/[email protected]/flags/mod.ts";
+import { join } from "https://deno.land/[email protected]/path/mod.ts";
 import { ensure, is } from "https://deno.land/x/[email protected]/mod.ts";
 import { systemopen } from "https://deno.land/x/[email protected]/mod.ts";
+import config_dir from "https://deno.land/x/[email protected]/config_dir/mod.ts";
 import {
   getCommitAbbrevRef,
   getCommitSHA1,
@@ -27,6 +29,7 @@ export async function getURL(
   commitish: string,
   options: Options = {},
 ): Promise<URL> {
+  options.aliases = options.aliases ?? await readAliasesFile();
   if (options.home) {
     return getHomeURL(options);
   }
@@ -49,6 +52,23 @@ export async function getURL(
   return getObjectURL(commitish, options.path ?? ".", options);
 }
 
+export async function readAliasesFile(): Promise<Record<string, string>> {
+  const cdir = config_dir();
+  if (!cdir) {
+    return {};
+  }
+  try {
+    return await import(join(cdir, "browse", "aliases.json"), {
+      assert: { type: "json" },
+    });
+  } catch (err) {
+    if (err instanceof TypeError) {
+      return {};
+    }
+    throw err;
+  }
+}
+
 async function main(args: string[]): Promise<void> {
   const opts = parse(args, {
     boolean: [

bin/browse_usage.txt

@@ -12,6 +12,29 @@ OPTIONS
       --permalink      Use a permalink instead of a regular URL.
       --remote=REMOTE  Use a URL from the specified remote repository.
 
+ALIASES
+  To enable support for non-standard repository URLs (e.g., GitHub Enterprise), you can create aliases
+  for the repository URL. To define these aliases, create a file named "aliases.json" within the
+  specified configuration directory, as illustrated below:
+
+  {
+    "my.github.com": "github.com",
+    // Add more aliases as needed
+  }
+
+  This file needs to be stored in the "browse" directory within the configuration directory, as 
+  indicated by the following paths based on your operating system:
+
+  ┌─────────┬────────────────────────────────────────────┬──────────────────────────────────────────┐
+  │ OS      │ Value                                      │ Example                                  │
+  ├─────────┼────────────────────────────────────────────┼──────────────────────────────────────────┤
+  │ Linux   │ ($XDG_CONFIG_HOME or $HOME/.config)/browse │ /home/alisue/.config/browse              │
+  ├─────────┼────────────────────────────────────────────┼──────────────────────────────────────────┤
+  │ macOS   │ $HOME/Library/Preferences/browse           │ /Users/alisue/Library/Preferences/browse │
+  ├─────────┼────────────────────────────────────────────┼──────────────────────────────────────────┤
+  │ Windows │ $APPDATA\browse                            │ C:\Users\alisue\AppData\Roaming\browse   │
+  └─────────┴────────────────────────────────────────────┴──────────────────────────────────────────┘
+
 EXAMPLES
   $ browse
   #=> Opens a tree page of the current working directory in the HEAD commit of the current branch