@altano/repository-tools 0.0.4 → 0.1.1

package/README.md

@@ -26,3 +26,18 @@ Example:
 ```ts
 await findRoot("/my-git-repo/some/subdirectory"); // => "/my-git-repo"
 ```
+
+## Importing
+
+This is a dual ESM/CJS package, and publishes both a top-level module with all exports, and sub-path exports. So feel free to import using any of the following:
+
+| Your package type | Using sub-path exports | Import to use                                                           |
+| ----------------- | ---------------------- | ----------------------------------------------------------------------- |
+| ESM               | No                     | `import { findRoot } from "@altano/repository-tools";`                  |
+| ESM               | Yes                    | `import { findRoot } from "@altano/repository-tools/findRoot.js";`      |
+| CJS               | No                     | `const { findRoot } = require("@altano/repository-tools")`              |
+| CJS               | Yes                    | `const { findRoot } = require("@altano/repository-tools/findSync.cjs")` |
+
+## Contributing
+
+This is a dual ESM/CJS package which is really hard to get right. Manually run `pnpm build && pnpm dlx @arethetypeswrong/cli --pack` before making any changes that would affect the build, packaging, or publishing.

package/dist/exec.cjs

@@ -0,0 +1,38 @@
+"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/exec.d.cts

@@ -0,0 +1,7 @@
+import { exec, execFile } from 'child_process';
+export { execFileSync, execSync } from 'child_process';
+
+declare const execAsync: typeof exec.__promisify__;
+declare const execFileAsync: typeof execFile.__promisify__;
+
+export { execAsync, execFileAsync };

package/dist/exec.d.ts

@@ -1,6 +1,7 @@
-/// <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
+import { exec, execFile } from 'child_process';
+export { execFileSync, execSync } from 'child_process';
+
+declare const execAsync: typeof exec.__promisify__;
+declare const execFileAsync: typeof execFile.__promisify__;
+
+export { execAsync, execFileAsync };

package/dist/findRoot.cjs

@@ -0,0 +1,69 @@
+"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.cjs");
+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/findRoot.d.cts

@@ -0,0 +1,12 @@
+/**
+ * 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
+ */
+declare function findRoot(
+/**
+ * The directory path of anything in a version-controlled repository
+ */
+directory: string): Promise<string | null>;
+
+export { findRoot };

package/dist/findRoot.d.ts

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

package/dist/findRootSync.cjs

@@ -0,0 +1,69 @@
+"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.cjs");
+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/findRootSync.d.cts

@@ -0,0 +1,12 @@
+/**
+ * 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
+ */
+declare function findRootSync(
+/**
+ * The directory path of anything in a version-controlled repository
+ */
+directory: string): string | null;
+
+export { findRootSync };

package/dist/findRootSync.d.ts

@@ -3,9 +3,10 @@
  *
  * @returns null if not found or the path of the repository root as a string
  */
-export declare function findRootSync(
+declare function findRootSync(
 /**
  * The directory path of anything in a version-controlled repository
  */
 directory: string): string | null;
-//# sourceMappingURL=findRootSync.d.ts.map
+
+export { findRootSync };

package/dist/index.cjs

@@ -0,0 +1,24 @@
+"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.cjs"), module.exports);
+__reExport(src_exports, require("./findRootSync.cjs"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./findRoot.cjs"),
+  ...require("./findRootSync.cjs")
+});

package/dist/index.d.cts

@@ -0,0 +1,2 @@
+export { findRoot } from './findRoot.cjs';
+export { findRootSync } from './findRootSync.cjs';

package/dist/index.d.ts

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

package/dist/repositoryCommand.cjs

@@ -0,0 +1,87 @@
+"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.cjs");
+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/repositoryCommand.d.cts

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

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

package/dist/types.cjs

@@ -0,0 +1,33 @@
+"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/types.d.cts

@@ -0,0 +1,4 @@
+declare const repositoryTypes: readonly ["git", "mercurial", "sapling", "subversion"];
+type RepositoryType = (typeof repositoryTypes)[number];
+
+export { type RepositoryType, repositoryTypes };

package/dist/types.d.ts

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

package/package.json

@@ -1,14 +1,26 @@
 {
   "name": "@altano/repository-tools",
-  "version": "0.0.4",
+  "version": "0.1.1",
   "description": "Misc tools for dealing with repositories of multiple version control systems (git, svn, etc)",
-  "types": "./dist/index.d.ts",
-  "exports": "./dist/index.js",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./*": {
+      "import": "./dist/*",
+      "require": "./dist/*"
+    }
+  },
   "type": "module",
   "sideEffects": false,
   "files": [
     "dist/**/*.js",
-    "dist/**/*.d.ts"
+    "dist/**/*.cjs",
+    "dist/**/*.d.ts",
+    "dist/**/*.d.cts"
   ],
   "repository": {
     "type": "git",
@@ -51,8 +63,7 @@
     "access": "public"
   },
   "scripts": {
-    "build": "tsup --config build-config/tsup.config.node.ts",
-    "build:types": "tsc --project tsconfig.declarations.json",
+    "build": "tsup --config build-config/tsup.config.node-hybrid.ts",
     "clean": "rm -rf .turbo && rm -rf .tsbuildinfo && rm -rf node_modules && rm -rf dist",
     "dev": "pnpm run build --watch",
     "format": "prettier --check src",
@@ -61,10 +72,11 @@
     "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": "run-s test:unit:run",
     "test:unit:benchmark": "vitest --run bench",
     "test:unit:run": "vitest --run",
     "test:unit:watch": "vitest",
-    "typecheck": "tsc --noEmit"
+    "typecheck:src": "tsc --noEmit",
+    "typecheck:test": "tsc --noEmit --project ./tests/tsconfig.json"
   }
 }