git-find-remote 1.0.0

package/README.md

@@ -0,0 +1,36 @@
+# git-find-remote
+
+A CLI tool that recursively searches directories and finds Git repositories by remote URL or repository name. Have you ever worked on a project and forgot with you had been working on it on your computer? This is the package for you. It will locate the package on your computer.
+
+## Installation
+
+```bash
+npm install -g git-find-remote
+```
+Or if you dont want to install you can use:
+```bash
+npx git-find-remote your-github-repo-name
+```
+
+## Usage
+
+You can search for your repos in 3 ways.
+1. Using just the repository name:
+```bash
+git-find-remote your-github-repo-name
+```
+2. Including the username for the repository
+```bash
+git-find-remote your-username/your-github-repo-name
+```
+3. Full Github url
+```bash
+git-find-remote https://github.com/your-username/your-github-repo-name
+```
+
+## Features
+- Recursive directory search
+- Supports HTTPS Git URLs
+- Supports SSH Git URLs
+- Search by repository name
+- Ignores node_modules and build folders

package/bin/cli.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+
+const search = require("../lib/search")
+
+const remoteUrl = process.argv[2]
+
+if (!remoteUrl) {
+    console.log("Please provide a git remote URL.")
+    process.exit(1)
+}
+
+search(remoteUrl)

package/lib/git.js

@@ -0,0 +1,54 @@
+const fs = require("fs/promises")
+const path = require("path")
+const { execFile } = require("child_process")
+const { promisify } = require("util")
+
+
+const execFileAsync = promisify(execFile)
+
+
+async function getRemote(folder) {
+
+
+    const gitFolder = path.join(folder, ".git")
+
+
+    try {
+
+        await fs.access(gitFolder)
+
+    } catch {
+
+        // Not a git repository
+        return null
+
+    }
+
+
+    try {
+
+        const { stdout } = await execFileAsync(
+            "git",
+            [
+                "-C",
+                folder,
+                "remote",
+                "get-url",
+                "origin"
+            ]
+        )
+
+
+        return stdout.trim()
+
+
+    } catch {
+
+        return null
+
+    }
+
+}
+
+
+module.exports = getRemote

package/lib/matches.js

@@ -0,0 +1,26 @@
+function matchesRepo(inputRepo, remoteRepo) {
+
+
+    // Exact match:
+    // facebook/react === facebook/react
+    if (inputRepo.full === remoteRepo.full) {
+        return true
+    }
+
+
+    // User only provided repo name:
+    // react === facebook/react
+    if (
+        inputRepo.owner === null &&
+        inputRepo.name === remoteRepo.name
+    ) {
+        return true
+    }
+
+
+    return false
+
+}
+
+
+module.exports = matchesRepo

package/lib/normalize.js

@@ -0,0 +1,45 @@
+function normalizeRepo(input) {
+
+    if (!input) {
+        return null
+    }
+
+
+    let repo = input.trim().toLowerCase()
+
+
+    // Remove .git ending
+    repo = repo.replace(/\.git$/, "")
+
+
+    // Convert SSH GitHub URLs
+    repo = repo.replace(
+        /^git@github\.com:/,
+        ""
+    )
+
+
+    // Convert HTTPS GitHub URLs
+    repo = repo.replace(
+        /^https?:\/\/github\.com\//,
+        ""
+    )
+
+
+    // Remove trailing slash
+    repo = repo.replace(/\/$/, "")
+
+
+    const parts = repo.split("/")
+
+
+    return {
+        full: repo,
+        name: parts[parts.length - 1],
+        owner: parts.length > 1 ? parts[parts.length - 2] : null
+    }
+
+}
+
+
+module.exports = normalizeRepo

package/lib/search.js

@@ -0,0 +1,68 @@
+const fs = require("fs/promises");
+const path = require("path");
+const getRemote = require("./git");
+const normalizeRepo = require("./normalize");
+const matchesRepo = require("./matches");
+
+const ignoredDirectories = new Set([
+  "node_modules",
+  ".git",
+  "dist",
+  "build",
+  ".next",
+  "coverage",
+]);
+
+async function search(remoteInput) {
+  const normalizedInput = normalizeRepo(remoteInput);
+
+  const startingFolder = process.cwd();
+
+  console.log("Searching for:");
+  console.log(normalizedInput);
+  console.log("Searching...");
+
+  await searchFolder(startingFolder, normalizedInput);
+}
+
+async function searchFolder(folder, normalizedInput) {
+  let entries;
+
+  try {
+    entries = await fs.readdir(folder, {
+      withFileTypes: true,
+    });
+  } catch (error) {
+    // Cannot access folder, ignore it
+    return;
+  }
+
+  for (const entry of entries) {
+    // Skip ignored directories
+    if (entry.isDirectory() && ignoredDirectories.has(entry.name)) {
+      continue;
+    }
+
+    const fullPath = path.join(folder, entry.name);
+
+    if (entry.isDirectory()) {
+      // Check if this directory is a git repository
+      const remote = await getRemote(fullPath);
+
+      if (remote) {
+        const normalizedRemote = normalizeRepo(remote);
+
+        if (matchesRepo(normalizedInput, normalizedRemote)) {
+          console.log("FOUND:");
+          console.log(fullPath);
+          console.log("");
+        }
+      }
+
+      // Continue searching deeper
+      await searchFolder(fullPath, normalizedInput);
+    }
+  }
+}
+
+module.exports = search;

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "git-find-remote",
+  "version": "1.0.0",
+  "bin":{
+    "git-find-remote": "./bin/cli.js"
+  },
+  "main": "lib/search.js",
+  "scripts": {
+    "test": "jest"
+  },
+  "keywords": [
+    "git",
+    "github",
+    "find",
+    "finder",
+    "repository",
+    ".git",
+    "remote",
+    "terminal",
+    "cli"
+  ],
+  "author": "OmarDevelopment",
+  "license": "MIT",
+  "description": "",
+    "repository": {
+    "type": "git",
+    "url": "https://github.com/omarakamal/git-find-remote.git",
+    "homepage": "https://github.com/omarakamal/git-find-remote/README.md"
+
+  }
+
+}