@altano/repository-tools 0.0.2

package/README.md

@@ -0,0 +1,28 @@
+# repository-tools
+
+Misc tools for dealing with repositories of multiple version control systems
+
+## Supported Version Control Systems
+
+- git
+- mercurial
+- sapling
+- subversion
+
+## Tools
+
+### findRoot[Sync]
+
+Given a path inside a repository, find the path of the root
+
+Example:
+
+```ts
+findRootSync("/my-git-repo/some/subdirectory"); // => "/my-git-repo"
+```
+
+Example:
+
+```ts
+await findRoot("/my-git-repo/some/subdirectory"); // => "/my-git-repo"
+```

package/dist/exec.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="node" />
+import { exec, execFile } from "child_process";
+export { execSync, execFileSync } from "child_process";
+export declare const execAsync: typeof exec.__promisify__;
+export declare const execFileAsync: typeof execFile.__promisify__;
+//# sourceMappingURL=exec.d.ts.map

package/dist/exec.js

@@ -0,0 +1,11 @@
+import { exec, execFile } from "child_process";
+import { promisify } from "node:util";
+import { execSync, execFileSync } from "child_process";
+const execAsync = promisify(exec);
+const execFileAsync = promisify(execFile);
+export {
+  execAsync,
+  execFileAsync,
+  execFileSync,
+  execSync
+};

package/dist/findRoot.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Find the root path of the repository containing the given directory.
+ *
+ * @returns null if not found or the path of the repository root as a string
+ */
+export declare function findRoot(
+/**
+ * The directory path of anything in a version-controlled repository
+ */
+directory: string): Promise<string | null>;
+//# sourceMappingURL=findRoot.d.ts.map

package/dist/findRoot.js

@@ -0,0 +1,45 @@
+import { repositoryExec } from "./repositoryCommand";
+async function findGitRoot(directory) {
+  return repositoryExec(directory, "git", [
+    "rev-parse",
+    "--quiet",
+    "--show-toplevel"
+  ]);
+}
+async function findSaplingRoot(directory) {
+  return repositoryExec(directory, "sl", ["--quiet", "root"]);
+}
+async function findMercurialRoot(directory) {
+  return repositoryExec(directory, "hg", ["--quiet", "root"]);
+}
+async function findSubversionRoot(directory) {
+  return repositoryExec(directory, "svn", ["info", "--show-item", "wc-root"]);
+}
+const findMethods = [
+  findGitRoot,
+  // most used and fastest check
+  findSubversionRoot,
+  // next highest market share
+  findSaplingRoot,
+  // much smaller market share, but much faster
+  findMercurialRoot
+  // slow af
+];
+async function findRoot(directory) {
+  for (const method of findMethods) {
+    try {
+      const result = await method(directory);
+      if (result != null && result !== "") {
+        return result;
+      }
+    } catch (e) {
+      if (e instanceof Error && "code" in e && e.code === "ENOTDIR") {
+        throw new Error(`Given path isn't a directory: ${directory}`);
+      }
+    }
+  }
+  return null;
+}
+export {
+  findRoot
+};

package/dist/findRootSync.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Find the root path of the repository containing the given directory.
+ *
+ * @returns null if not found or the path of the repository root as a string
+ */
+export declare function findRootSync(
+/**
+ * The directory path of anything in a version-controlled repository
+ */
+directory: string): string | null;
+//# sourceMappingURL=findRootSync.d.ts.map

package/dist/findRootSync.js

@@ -0,0 +1,45 @@
+import { repositoryExecSync } from "./repositoryCommand";
+function findGitRoot(cwd) {
+  return repositoryExecSync(cwd, "git", [
+    "rev-parse",
+    "--quiet",
+    "--show-toplevel"
+  ]);
+}
+function findSaplingRoot(cwd) {
+  return repositoryExecSync(cwd, "sl", ["--quiet", "root"]);
+}
+function findMercurialRoot(cwd) {
+  return repositoryExecSync(cwd, "hg", ["--quiet", "root"]);
+}
+function findSubversionRoot(cwd) {
+  return repositoryExecSync(cwd, "svn", ["info", "--show-item", "wc-root"]);
+}
+const findMethods = [
+  findGitRoot,
+  // most used and fastest check
+  findSubversionRoot,
+  // next highest market share
+  findSaplingRoot,
+  // much smaller market share, but much faster
+  findMercurialRoot
+  // slow af
+];
+function findRootSync(directory) {
+  for (const method of findMethods) {
+    try {
+      const result = method(directory);
+      if (result != null && result !== "") {
+        return result;
+      }
+    } catch (e) {
+      if (e instanceof Error && "code" in e && e.code === "ENOTDIR") {
+        throw new Error(`Given path isn't a directory: ${directory}`);
+      }
+    }
+  }
+  return null;
+}
+export {
+  findRootSync
+};

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./findRoot";
+export * from "./findRootSync";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from "./findRoot";
+export * from "./findRootSync";

package/dist/repositoryCommand.d.ts

@@ -0,0 +1,6 @@
+type RepositoryCommand = "git" | "hg" | "sl" | "svn" | "svnadmin" | "svnrdump";
+export declare function repositoryExec(cwd: string, command: RepositoryCommand, args: readonly string[]): Promise<string>;
+export declare function repositoryExecSync(cwd: string, command: RepositoryCommand, args: readonly string[]): string;
+export declare const createExecForDirectory: (cwd: string) => (command: RepositoryCommand, args: readonly string[]) => Promise<string>;
+export {};
+//# sourceMappingURL=repositoryCommand.d.ts.map

package/dist/repositoryCommand.js

@@ -0,0 +1,61 @@
+import { execFileAsync, execFileSync } from "./exec";
+const environment = {
+  git: {
+    // non-interactive
+    GIT_TERMINAL_PROMPT: "0",
+    // don't use global config
+    GIT_CONFIG_GLOBAL: "/dev/null",
+    GIT_CONFIG_SYSTEM: "/dev/null",
+    // user config
+    GIT_COMMITTER_NAME: "alan",
+    GIT_COMMITTER_EMAIL: "alan@example.com",
+    GIT_AUTHOR_NAME: "alan",
+    GIT_AUTHOR_EMAIL: "alan@example.com"
+  },
+  hg: {
+    // don't use global config
+    HGRCPATH: "/dev/null",
+    // don't use global config
+    HGUSER: "alan",
+    EMAIL: "alan@example.com"
+  },
+  sl: {
+    // don't use global config
+    HGRCPATH: "/dev/null",
+    // don't use global config
+    HGUSER: "alan",
+    EMAIL: "alan@example.com"
+  },
+  svn: {},
+  svnadmin: {},
+  svnrdump: {}
+};
+async function repositoryExec(cwd, command, args) {
+  return execFileAsync(command, args, {
+    cwd,
+    encoding: "utf8",
+    env: {
+      ...process.env,
+      ...environment[command]
+    }
+  }).then(({ stdout, stderr }) => {
+    return stderr ? Promise.reject(stderr.trim()) : stdout.trim();
+  });
+}
+function repositoryExecSync(cwd, command, args) {
+  const result = execFileSync(command, args, {
+    cwd,
+    encoding: "utf8",
+    env: {
+      ...process.env,
+      ...environment[command]
+    }
+  }).trim();
+  return result;
+}
+const createExecForDirectory = (cwd) => repositoryExec.bind(null, cwd);
+export {
+  createExecForDirectory,
+  repositoryExec,
+  repositoryExecSync
+};

package/dist/types.d.ts

@@ -0,0 +1,3 @@
+export declare const repositoryTypes: readonly ["git", "mercurial", "sapling", "subversion"];
+export type RepositoryType = (typeof repositoryTypes)[number];
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -0,0 +1,9 @@
+const repositoryTypes = [
+  "git",
+  "mercurial",
+  "sapling",
+  "subversion"
+];
+export {
+  repositoryTypes
+};

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@altano/repository-tools",
+  "version": "0.0.2",
+  "description": "Misc tools for dealing with repositories of multiple version control systems (git, svn, etc)",
+  "types": "./dist/index.d.ts",
+  "exports": "./dist/index.js",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/altano/npm-packages",
+    "directory": "packages/repository-tools"
+  },
+  "homepage": "https://github.com/altano/npm-packages/tree/main/packages/repository-tools",
+  "keywords": [
+    "repository",
+    "root",
+    "git",
+    "mercurial",
+    "sapling"
+  ],
+  "author": {
+    "name": "Alan Norbauer",
+    "email": "altano@gmail.com",
+    "url": "https://alan.norbauer.com"
+  },
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^20.11.25",
+    "@vitest/coverage-v8": "^1.4.0",
+    "@vitest/expect": "^1.4.0",
+    "@vitest/ui": "^1.3.1",
+    "eslint": "^8.57.0",
+    "find-cache-dir": "^5.0.0",
+    "memize": "^2.1.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^3.2.5",
+    "ts-assert-unreachable": "^0.0.9",
+    "typescript": "^5.4.2",
+    "vite": "^5.2.8",
+    "vitest": "^1.4.0",
+    "@altano/tsconfig": "0.0.0",
+    "@altano/vitest-plugins": "0.1.0",
+    "eslint-config-altano": "0.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup --config build-config/tsup.config.node.ts",
+    "build:types": "tsc --project tsconfig.declarations.json",
+    "clean": "rm -rf .turbo && rm -rf .tsbuildinfo && rm -rf node_modules && rm -rf dist",
+    "dev": "pnpm run build --watch",
+    "format": "prettier --check src",
+    "format:fix": "prettier --write src",
+    "lint": "eslint package.json src/**/*.ts*",
+    "lint:fix": "TIMING=1 pnpm lint --fix",
+    "lint:timing": "TIMING=1 pnpm lint",
+    "test:build": "./tests/scripts/createRepositoryBundles.ts",
+    "test:unit": "run-s test:unit:run test:unit:benchmark",
+    "test:unit:benchmark": "vitest --run bench",
+    "test:unit:run": "vitest --run",
+    "test:unit:watch": "vitest",
+    "typecheck": "tsc --noEmit"
+  }
+}