npm.io
2.1.1 • Published 1 week ago

@altano/repository-tools

Licence
ISC
Version
2.1.1
Deps
0
Size
25 kB
Vulns
0
Weekly
0
Stars
13

repository-tools

npm Typed with TypeScript ESM only

Misc tools for dealing with repositories of multiple version control systems

Supported Version Control Systems

  • git
  • jujutsu (jj), colocated with git or not
  • mercurial
  • sapling
  • subversion

Tools

findRoot[Sync]

Given a path inside a repository, find the path of the root

Example:

findRootSync("/my-git-repo/some/subdirectory"); // => "/my-git-repo"

Example:

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";

Keywords