updated README and fmt code

thoroc · thoroc · commit 6aa18809c585 · 2025-02-12T11:35:58.000Z
diff --git a/README.md b/README.md
@@ -1,8 +1,11 @@
 # git-mirror
 
-Deno script to clone a github/gitlab repo to `~/Projects` while keeping a tree structure close to the remote url. If the project is already present, then it'll fetch from the remote.
+Deno script to clone a github/gitlab repo to `~/Projects` while keeping a tree
+structure close to the remote url. If the project is already present, then it'll
+fetch from the remote.
 
-__WARNING__ this was developed on a MacOS, so no guaranty are offered to run on a different OS.
+**WARNING** this was developed on a MacOS, so no guaranty are offered to run on
+a different OS.
 
 ## install
 
@@ -16,7 +19,8 @@ __WARNING__ this was developed on a MacOS, so no guaranty are offered to run on
 
 ## Usage
 
-Call `git mirror git@github.com:owner/repo.git` will clone to `~/Projects/owner/repo`.
+Call `git mirror git@github.com:owner/repo.git` will clone to
+`~/Projects/owner/repo`.
 
 ```sh
 Usage:   clone <repo>
@@ -33,5 +37,5 @@ Options:
   -r, --root          <rootDir>  - The root directory.                        (Default: "/Users/<user>/Projects")
   -o, --open-vs-code             - Open the repository in VS Code.            (Default: true)                    
   --no-open-vs-code              - Do not open the repository in VS Code.                                        
-  --dry-run                      - Print the command that would be run. 
+  --dry-run                      - Print the command that would be run.
 ```
diff --git a/git-mirror.ts b/git-mirror.ts
@@ -1,16 +1,16 @@
 #!/usr/bin/env -S deno run --allow-env --allow-read --allow-write --allow-run
-import { Command } from 'jsr:@cliffy/command@^1.0.0-rc.7';
-import { Confirm } from 'jsr:@cliffy/prompt@1.0.0-rc.7/confirm';
-import { exists } from 'jsr:@std/fs';
-import chalk from 'npm:chalk';
-import { HOME_DIR } from './utils/constants.ts';
+import { Command } from "jsr:@cliffy/command@^1.0.0-rc.7";
+import { Confirm } from "jsr:@cliffy/prompt@1.0.0-rc.7/confirm";
+import { exists } from "jsr:@std/fs";
+import chalk from "npm:chalk";
+import { HOME_DIR } from "./utils/constants.ts";
 import {
   cloneRepo,
   fetchRepo,
   findExecutable,
   getLocalPath,
   runExecutable,
-} from './utils/mod.ts';
+} from "./utils/mod.ts";
 
 interface CloneOptions {
   openVsCode?: boolean;
@@ -21,10 +21,10 @@ interface CloneOptions {
 const cloneAction = async (options: CloneOptions, repo: string) => {
   const localRepo = getLocalPath(
     repo,
-    options.rootDir ?? `${HOME_DIR}/Projects`
+    options.rootDir ?? `${HOME_DIR}/Projects`,
   );
   console.log(
-    `Cloning repository: ${chalk.green(repo)} to ${chalk.green(localRepo)}`
+    `Cloning repository: ${chalk.green(repo)} to ${chalk.green(localRepo)}`,
   );
 
   const dirAlreadyExists = await exists(localRepo);
@@ -42,43 +42,44 @@ const cloneAction = async (options: CloneOptions, repo: string) => {
     }
   }
 
-  const openVsCode =
-    options.openVsCode ??
+  const openVsCode = options.openVsCode ??
     (await Confirm.prompt({
-      message: 'Open the repository in VS Code?',
+      message: "Open the repository in VS Code?",
       default: true,
     }));
 
   if (openVsCode) {
     if (options.dryRun) {
       console.log(
-        chalk.bgYellow(`Dry run: Opening repository in VS Code: ${localRepo}`)
+        chalk.bgYellow(`Dry run: Opening repository in VS Code: ${localRepo}`),
       );
     } else {
-      const vscode = await findExecutable('code');
+      const vscode = await findExecutable("code");
       runExecutable(vscode, [localRepo]);
     }
   }
 
   console.log(
-    `To move to the project's directory, please run: "cd ${chalk.green(
-      localRepo
-    )}"`
+    `To move to the project's directory, please run: "cd ${
+      chalk.green(
+        localRepo,
+      )
+    }"`,
   );
 };
 
 await new Command()
-  .name('clone')
-  .version('0.1.2')
-  .description('Clone a Git repository into the ~/Projects directory.')
-  .arguments('<repo:string>')
-  .option('-r, --root <rootDir>', 'The root directory.', {
+  .name("clone")
+  .version("0.1.2")
+  .description("Clone/Fetch a Git repository into a 'Projects' directory")
+  .arguments("<repo:string>")
+  .option("-r, --root <rootDir>", "The root directory.", {
     default: `${HOME_DIR}/Projects`,
   })
-  .option('-o, --open-vs-code', 'Open the repository in VS Code.', {
+  .option("-o, --open-vs-code", "Open the repository in VS Code.", {
     default: true,
   })
-  .option('--no-open-vs-code', 'Do not open the repository in VS Code.')
-  .option('--dry-run', 'Print the command that would be run.')
+  .option("--no-open-vs-code", "Do not open the repository in VS Code.")
+  .option("--dry-run", "Print the command that would be run.")
   .action(cloneAction)
   .parse(Deno.args);
diff --git a/utils/constants.ts b/utils/constants.ts
@@ -1 +1 @@
-export const HOME_DIR = Deno.env.get('HOME');
+export const HOME_DIR = Deno.env.get("HOME");
diff --git a/utils/exec/find-exec.ts b/utils/exec/find-exec.ts
@@ -1,10 +1,10 @@
-import chalk from 'npm:chalk';
+import chalk from "npm:chalk";
 
 export const findExecutable = async (executable: string): Promise<string> => {
   try {
-    const command = await new Deno.Command('which', {
+    const command = await new Deno.Command("which", {
       args: [executable],
-      stdout: 'piped',
+      stdout: "piped",
     });
     const { stdout } = await command.output();
 
diff --git a/utils/exec/run-exec.ts b/utils/exec/run-exec.ts
@@ -1,10 +1,10 @@
 export const runExecutable = async (
   executable: string,
-  args: string[]
+  args: string[],
 ): Promise<Deno.CommandStatus> => {
   const command = await new Deno.Command(executable, {
     args,
-    stdin: 'piped',
+    stdin: "piped",
   });
   const child = await command.spawn();
   const status = await child.status;
diff --git a/utils/file/get-dir-path-from-repo.test.ts b/utils/file/get-dir-path-from-repo.test.ts
@@ -1,16 +1,16 @@
-import { assertEquals } from 'jsr:@std/assert';
-import { describe, it } from 'jsr:@std/testing/bdd';
-import { getDirPathFromRepo } from './get-dir-path-from-repo.ts';
+import { assertEquals } from "jsr:@std/assert";
+import { describe, it } from "jsr:@std/testing/bdd";
+import { getDirPathFromRepo } from "./get-dir-path-from-repo.ts";
 
-describe('getDirPathFromRepo', () => {
+describe("getDirPathFromRepo", () => {
   const TEST_CASES = [
     {
-      repo: 'git@git-host.com:organisation/project.git',
-      expected: 'organisation/project',
+      repo: "git@git-host.com:organisation/project.git",
+      expected: "organisation/project",
     },
     {
-      repo: 'https://git-host.com/organisation/project.git',
-      expected: 'organisation/project',
+      repo: "https://git-host.com/organisation/project.git",
+      expected: "organisation/project",
     },
   ];
 
diff --git a/utils/file/get-dir-path-from-repo.ts b/utils/file/get-dir-path-from-repo.ts
@@ -1,14 +1,14 @@
-import chalk from 'npm:chalk';
+import chalk from "npm:chalk";
 
 export const getDirPathFromRepo = (repo: string): string => {
   let dirPath: string;
 
-  if (repo.startsWith('git@')) {
-    const repoParts = repo.split(':');
-    dirPath = repoParts[1].replace('.git', '');
-  } else if (repo.startsWith('https://')) {
-    const repoParts = repo.split('/');
-    dirPath = repoParts.slice(3).join('/').replace('.git', '');
+  if (repo.startsWith("git@")) {
+    const repoParts = repo.split(":");
+    dirPath = repoParts[1].replace(".git", "");
+  } else if (repo.startsWith("https://")) {
+    const repoParts = repo.split("/");
+    dirPath = repoParts.slice(3).join("/").replace(".git", "");
   } else {
     console.error(chalk.bgRedBright(`Invalid Git repository URL: ${repo}`));
     Deno.exit(1);
diff --git a/utils/file/get-host-from-repo.test.ts b/utils/file/get-host-from-repo.test.ts
@@ -1,16 +1,16 @@
-import { assertEquals } from 'jsr:@std/assert';
-import { describe, it } from 'jsr:@std/testing/bdd';
-import { getHostFromRepo } from './get-host-from-repo.ts';
+import { assertEquals } from "jsr:@std/assert";
+import { describe, it } from "jsr:@std/testing/bdd";
+import { getHostFromRepo } from "./get-host-from-repo.ts";
 
-describe('getHostFromRepo', () => {
+describe("getHostFromRepo", () => {
   const TEST_CASES = [
     {
-      repo: 'git@git-host.com:organisation/project.git',
-      expected: 'git-host',
+      repo: "git@git-host.com:organisation/project.git",
+      expected: "git-host",
     },
     {
-      repo: 'https://git-host.com/organisation/project.git',
-      expected: 'git-host',
+      repo: "https://git-host.com/organisation/project.git",
+      expected: "git-host",
     },
   ];
 
diff --git a/utils/file/get-host-from-repo.ts b/utils/file/get-host-from-repo.ts
@@ -1,14 +1,14 @@
-import chalk from 'npm:chalk';
+import chalk from "npm:chalk";
 
 export const getHostFromRepo = (repo: string): string => {
   let host: string;
 
-  if (repo.startsWith('git@')) {
-    const repoParts = repo.split(':');
-    host = repoParts[0].split('@')[1].split('.')[0];
-  } else if (repo.startsWith('https://')) {
-    const repoParts = repo.split('/');
-    host = repoParts[2].split('.')[0];
+  if (repo.startsWith("git@")) {
+    const repoParts = repo.split(":");
+    host = repoParts[0].split("@")[1].split(".")[0];
+  } else if (repo.startsWith("https://")) {
+    const repoParts = repo.split("/");
+    host = repoParts[2].split(".")[0];
   } else {
     console.error(chalk.bgRedBright(`Invalid Git repository URL: ${repo}`));
     Deno.exit(1);
diff --git a/utils/file/get-local-path.test.ts b/utils/file/get-local-path.test.ts
@@ -1,44 +1,44 @@
-import { assertEquals } from 'jsr:@std/assert';
-import { describe, it } from 'jsr:@std/testing/bdd';
-import { getLocalPath } from './get-local-path.ts';
-import { shortenPath } from './shorten-path.ts';
+import { assertEquals } from "jsr:@std/assert";
+import { describe, it } from "jsr:@std/testing/bdd";
+import { getLocalPath } from "./get-local-path.ts";
+import { shortenPath } from "./shorten-path.ts";
 
-describe('getLocalPath', () => {
+describe("getLocalPath", () => {
   const TEST_CASES = [
     {
-      targetBaseDir: '/home/user/Projects',
-      repo: 'https://git-host.com/project/project.git',
-      expected: '/home/user/Projects/git-host/project/project',
+      targetBaseDir: "/home/user/Projects",
+      repo: "https://git-host.com/project/project.git",
+      expected: "/home/user/Projects/git-host/project/project",
     },
     {
-      targetBaseDir: '/home/user/Projects',
-      repo: 'https://git-host.com/organisation/project.git',
-      expected: '/home/user/Projects/git-host/organisation/project',
+      targetBaseDir: "/home/user/Projects",
+      repo: "https://git-host.com/organisation/project.git",
+      expected: "/home/user/Projects/git-host/organisation/project",
     },
     {
-      targetBaseDir: '/home/user/Projects/git-host',
-      repo: 'https://git-host.com/organisation/project.git',
-      expected: '/home/user/Projects/git-host/organisation/project',
+      targetBaseDir: "/home/user/Projects/git-host",
+      repo: "https://git-host.com/organisation/project.git",
+      expected: "/home/user/Projects/git-host/organisation/project",
     },
     {
-      targetBaseDir: '/home/user/Projects',
-      repo: 'https://git-host.com/organisation/project.git',
-      expected: '/home/user/Projects/git-host/organisation/project',
+      targetBaseDir: "/home/user/Projects",
+      repo: "https://git-host.com/organisation/project.git",
+      expected: "/home/user/Projects/git-host/organisation/project",
     },
     {
-      targetBaseDir: '/home/user/Projects/git-host',
-      repo: 'https://git-host.com/organisation/project.git',
-      expected: '/home/user/Projects/git-host/organisation/project',
+      targetBaseDir: "/home/user/Projects/git-host",
+      repo: "https://git-host.com/organisation/project.git",
+      expected: "/home/user/Projects/git-host/organisation/project",
     },
     {
-      targetBaseDir: '/home/user/Projects/git-host/organisation',
-      repo: 'https://git-host.com/organisation/project.git',
-      expected: '/home/user/Projects/git-host/organisation/project',
+      targetBaseDir: "/home/user/Projects/git-host/organisation",
+      repo: "https://git-host.com/organisation/project.git",
+      expected: "/home/user/Projects/git-host/organisation/project",
     },
     {
-      targetBaseDir: '/home/user/Projects/git-host/organisation/project',
-      repo: 'https://git-host.com/organisation/project.git',
-      expected: '/home/user/Projects/git-host/organisation/project',
+      targetBaseDir: "/home/user/Projects/git-host/organisation/project",
+      repo: "https://git-host.com/organisation/project.git",
+      expected: "/home/user/Projects/git-host/organisation/project",
     },
   ];
 
diff --git a/utils/file/get-local-path.ts b/utils/file/get-local-path.ts
@@ -1,13 +1,13 @@
-import { getDirPathFromRepo } from './get-dir-path-from-repo.ts';
-import { getHostFromRepo } from './get-host-from-repo.ts';
+import { getDirPathFromRepo } from "./get-dir-path-from-repo.ts";
+import { getHostFromRepo } from "./get-host-from-repo.ts";
 
 export const getLocalPath = (repo: string, targetBaseDir: string): string => {
   const host = getHostFromRepo(repo);
   const dirPath = getDirPathFromRepo(repo);
   const targetPath = `${targetBaseDir}/${host}/${dirPath}`;
 
   // find all sequential directories that exist
-  const dirs = targetPath.split('/');
+  const dirs = targetPath.split("/");
   const remainingPath: string[] = [];
 
   for (let i = 0; i < dirs.length; i++) {
@@ -19,5 +19,5 @@ export const getLocalPath = (repo: string, targetBaseDir: string): string => {
     }
   }
 
-  return remainingPath.join('/');
+  return remainingPath.join("/");
 };
diff --git a/utils/file/shorten-path.ts b/utils/file/shorten-path.ts
@@ -7,18 +7,18 @@ interface ShortenOptions {
 
 export const shortenPath = (path: string, options?: ShortenOptions): string => {
   const min = options?.min ?? 3;
-  const separator = options?.separator ?? '/';
+  const separator = options?.separator ?? "/";
   const parts = path.split(separator);
 
   if (parts.length <= min) {
     return path;
   }
 
   const left = options?.left ?? 1;
-  const first = parts.slice(0, left + 1).join('/');
+  const first = parts.slice(0, left + 1).join("/");
 
   const right = options?.right ?? 2;
-  const last = parts.slice(-right).join('/');
+  const last = parts.slice(-right).join("/");
 
   return `${first}/.../${last}`;
 };
diff --git a/utils/git/clone-repo.ts b/utils/git/clone-repo.ts
@@ -1,15 +1,15 @@
-import chalk from 'npm:chalk';
-import { findExecutable } from '../exec/find-exec.ts';
+import chalk from "npm:chalk";
+import { findExecutable } from "../exec/find-exec.ts";
 
 export const cloneRepo = async (
   repo: string,
-  localRepo: string
+  localRepo: string,
 ): Promise<void> => {
-  const git = await findExecutable('git');
+  const git = await findExecutable("git");
 
   const clone = new Deno.Command(git, {
-    args: ['clone', repo, localRepo],
-    stdin: 'piped',
+    args: ["clone", repo, localRepo],
+    stdin: "piped",
   });
   const child = await clone.spawn();
   const status = await child.status;
@@ -18,7 +18,7 @@ export const cloneRepo = async (
     console.error(chalk.bgRedBright(`Error cloning repository`));
   } else {
     console.log(
-      chalk.bgGreenBright(`Repository cloned successfully to ${localRepo}`)
+      chalk.bgGreenBright(`Repository cloned successfully to ${localRepo}`),
     );
   }
 };
diff --git a/utils/git/fetch-repo.ts b/utils/git/fetch-repo.ts
diff --git a/utils/mod.ts b/utils/mod.ts

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-export const HOME_DIR = Deno.env.get('HOME');`
	`1`	`+export const HOME_DIR = Deno.env.get("HOME");`