@altano/repository-tools 0.1.0 → 1.0.0

package/README.md

@@ -1,5 +1,7 @@
 # repository-tools
 
+[![npm](https://badgen.net/npm/v/@altano/repository-tools)](https://www.npmjs.com/package/@altano/repository-tools) ![Typed with TypeScript](https://badgen.net/npm/types/@altano/repository-tools) ![ESM only](https://badgen.net/badge/module/esm%20only?icon=js)
+
 Misc tools for dealing with repositories of multiple version control systems
 
 ## Supported Version Control Systems
@@ -26,3 +28,14 @@ Example:
 ```ts
 await findRoot("/my-git-repo/some/subdirectory"); // => "/my-git-repo"
 ```
+
+## Importing
+
+NOTE: As of v1.0.0 this is an ESM-only module package. It can be imported as an ESM module from any Node.js version but if requiring this package from a CJS package, you must use Node.js v20.19.0+ or v22.12.0+. If you get a `ERR_REQUIRE_ESM` error when calling `require("@altano/repository-tools")` make sure you're on a new enough version of Node.js.
+
+You may import all the tools, or import functions directly:
+
+| Using sub-path exports | Import to use                                                      |
+| ---------------------- | ------------------------------------------------------------------ |
+| No                     | `import { findRoot } from "@altano/repository-tools";`             |
+| Yes                    | `import { findRoot } from "@altano/repository-tools/findRoot.js";` |

package/dist/{cjs/exec.d.ts → exec.d.ts}

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { exec, execFile } from "child_process";
 export { execSync, execFileSync } from "child_process";
 export declare const execAsync: typeof exec.__promisify__;

package/dist/{cjs/repositoryCommand.d.ts → repositoryCommand.d.ts}

@@ -1,6 +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 declare const createExecForDirectory: (cwd: string) => ((command: RepositoryCommand, args: readonly string[]) => Promise<string>);
 export {};
 //# sourceMappingURL=repositoryCommand.d.ts.map

package/dist/{esm/repositoryCommand.js → repositoryCommand.js}

@@ -39,7 +39,7 @@ async function repositoryExec(cwd, command, args) {
       ...environment[command]
     }
   }).then(({ stdout, stderr }) => {
-    return stderr ? Promise.reject(stderr.trim()) : stdout.trim();
+    return stderr ? Promise.reject(new Error(stderr.trim())) : stdout.trim();
   });
 }
 function repositoryExecSync(cwd, command, args) {

package/package.json

@@ -1,31 +1,7 @@
 {
   "name": "@altano/repository-tools",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "Misc tools for dealing with repositories of multiple version control systems (git, svn, etc)",
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
-  "exports": {
-    ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js"
-    },
-    "./*": {
-      "import": "./dist/esm/*.js",
-      "require": "./dist/cjs/*.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",
@@ -33,50 +9,68 @@
     "mercurial",
     "sapling"
   ],
+  "homepage": "https://github.com/altano/npm-packages/tree/main/packages/repository-tools",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/altano/npm-packages",
+    "directory": "packages/repository-tools"
+  },
+  "license": "ISC",
   "author": {
     "name": "Alan Norbauer",
     "email": "altano@gmail.com",
     "url": "https://alan.norbauer.com"
   },
-  "license": "ISC",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js",
+    "./*": "./dist/*"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
   "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",
+    "@arethetypeswrong/cli": "^0.17.4",
+    "@types/node": "^22.13.10",
+    "@vitest/coverage-v8": "^3.1.1",
+    "@vitest/expect": "^3.1.1",
+    "depcheck": "^1.4.7",
+    "eslint": "^9.23.0",
     "find-cache-dir": "^5.0.0",
     "memize": "^2.1.0",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^3.2.5",
+    "prettier": "^3.5.3",
     "ts-assert-unreachable": "^0.0.9",
-    "typescript": "^5.4.2",
-    "vite": "^5.2.8",
-    "vitest": "^1.4.0",
+    "typescript": "^5.8.2",
+    "vite": "^6.2.4",
+    "vitest": "^3.1.1",
+    "@altano/testing": "0.0.0",
     "@altano/tsconfig": "0.0.0",
-    "@altano/vitest-plugins": "0.1.1",
-    "eslint-config-altano": "0.0.0"
+    "@altano/build-config": "0.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "build": "tsup --config build-config/tsup.config.node-hybrid.ts",
-    "build:types:cjs": "tsc --project tsconfig.declarations-cjs.json",
-    "build:types:esm": "tsc --project tsconfig.declarations-esm.json",
+    "build": "tsup --config build-config/tsup.config.node.ts",
+    "build:types": "tsc --project tsconfig.declarations.json",
+    "check:exports": "attw --pack . --profile esm-only",
+    "check:types:src": "tsc --noEmit",
+    "check:types:test": "tsc --noEmit --project ./tests/tsconfig.json",
+    "check:unused-dependencies": "depcheck",
     "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": "eslint",
     "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": "vitest --run",
     "test:unit:benchmark": "vitest --run bench",
-    "test:unit:run": "vitest --run",
-    "test:unit:watch": "vitest",
-    "typecheck:src": "tsc --noEmit",
-    "typecheck:test": "tsc --noEmit --project ./tests/tsconfig.json"
+    "test:unit:watch": "vitest"
   }
 }

package/dist/cjs/exec.js

@@ -1,38 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var exec_exports = {};
-__export(exec_exports, {
-  execAsync: () => execAsync,
-  execFileAsync: () => execFileAsync,
-  execFileSync: () => import_child_process2.execFileSync,
-  execSync: () => import_child_process2.execSync
-});
-module.exports = __toCommonJS(exec_exports);
-var import_child_process = require("child_process");
-var import_node_util = require("node:util");
-var import_child_process2 = require("child_process");
-const execAsync = (0, import_node_util.promisify)(import_child_process.exec);
-const execFileAsync = (0, import_node_util.promisify)(import_child_process.execFile);
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  execAsync,
-  execFileAsync,
-  execFileSync,
-  execSync
-});

package/dist/cjs/findRoot.js

@@ -1,69 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var findRoot_exports = {};
-__export(findRoot_exports, {
-  findRoot: () => findRoot
-});
-module.exports = __toCommonJS(findRoot_exports);
-var import_repositoryCommand = require("./repositoryCommand.js");
-async function findGitRoot(directory) {
-  return (0, import_repositoryCommand.repositoryExec)(directory, "git", [
-    "rev-parse",
-    "--quiet",
-    "--show-toplevel"
-  ]);
-}
-async function findSaplingRoot(directory) {
-  return (0, import_repositoryCommand.repositoryExec)(directory, "sl", ["--quiet", "root"]);
-}
-async function findMercurialRoot(directory) {
-  return (0, import_repositoryCommand.repositoryExec)(directory, "hg", ["--quiet", "root"]);
-}
-async function findSubversionRoot(directory) {
-  return (0, import_repositoryCommand.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;
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  findRoot
-});

package/dist/cjs/findRootSync.js

@@ -1,69 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var findRootSync_exports = {};
-__export(findRootSync_exports, {
-  findRootSync: () => findRootSync
-});
-module.exports = __toCommonJS(findRootSync_exports);
-var import_repositoryCommand = require("./repositoryCommand.js");
-function findGitRoot(cwd) {
-  return (0, import_repositoryCommand.repositoryExecSync)(cwd, "git", [
-    "rev-parse",
-    "--quiet",
-    "--show-toplevel"
-  ]);
-}
-function findSaplingRoot(cwd) {
-  return (0, import_repositoryCommand.repositoryExecSync)(cwd, "sl", ["--quiet", "root"]);
-}
-function findMercurialRoot(cwd) {
-  return (0, import_repositoryCommand.repositoryExecSync)(cwd, "hg", ["--quiet", "root"]);
-}
-function findSubversionRoot(cwd) {
-  return (0, import_repositoryCommand.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;
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  findRootSync
-});

package/dist/cjs/index.js

@@ -1,24 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var src_exports = {};
-module.exports = __toCommonJS(src_exports);
-__reExport(src_exports, require("./findRoot.js"), module.exports);
-__reExport(src_exports, require("./findRootSync.js"), module.exports);
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ...require("./findRoot.js"),
-  ...require("./findRootSync.js")
-});

package/dist/cjs/repositoryCommand.js

@@ -1,87 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var repositoryCommand_exports = {};
-__export(repositoryCommand_exports, {
-  createExecForDirectory: () => createExecForDirectory,
-  repositoryExec: () => repositoryExec,
-  repositoryExecSync: () => repositoryExecSync
-});
-module.exports = __toCommonJS(repositoryCommand_exports);
-var import_exec = require("./exec.js");
-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 (0, import_exec.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 = (0, import_exec.execFileSync)(command, args, {
-    cwd,
-    encoding: "utf8",
-    env: {
-      ...process.env,
-      ...environment[command]
-    }
-  }).trim();
-  return result;
-}
-const createExecForDirectory = (cwd) => repositoryExec.bind(null, cwd);
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  createExecForDirectory,
-  repositoryExec,
-  repositoryExecSync
-});

package/dist/cjs/types.js

@@ -1,33 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var types_exports = {};
-__export(types_exports, {
-  repositoryTypes: () => repositoryTypes
-});
-module.exports = __toCommonJS(types_exports);
-const repositoryTypes = [
-  "git",
-  "mercurial",
-  "sapling",
-  "subversion"
-];
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  repositoryTypes
-});

package/dist/esm/exec.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-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/esm/findRoot.d.ts

@@ -1,11 +0,0 @@
-/**
- * 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/esm/findRootSync.d.ts

@@ -1,11 +0,0 @@
-/**
- * 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/esm/index.d.ts

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

package/dist/esm/repositoryCommand.d.ts

@@ -1,6 +0,0 @@
-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/esm/types.d.ts

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