visulimaVisulima package
One Package to rule them all, finds your root-dir, monorepo or package manager is built on top of @visulima/fs, @visulima/path, normalize-package-data, pathe,and type-fest
Daniel Bannert's open source work is supported by the community on GitHub Sponsors
Install
npm install @visulima/packageyarn add @visulima/packagepnpm add @visulima/packageUsage
findMonorepoRoot
Find the root directory path and strategy for a monorepo based on the given current working directory (cwd).
import { findMonorepoRoot } from "@visulima/package";
// or import { findMonorepoRoot } from '@visulima/package/monorepo';
const root = findMonorepoRoot(); // => /Users/../Projects/visulimafindPackageRoot
Find the root directory path and strategy for a package based on the given current working directory (cwd).
import { findPackageRoot } from "@visulima/package";
// or import { findPackageRoot } from '@visulima/package/package';
const root = findPackageRoot(); // => /Users/../Projects/visulima/packages/packagefindPackageJson
Find the package.json file in the specified directory or its parent directories.
import { findPackageJson } from "@visulima/package";
// or import { findPackageJson } from '@visulima/package/package-json';
const root = findPackageJson(); // => /Users/../Projects/visulima/packages/package/package.jsonwritePackageJson
Writes the package.json file with the given data.
import { writePackageJson } from "@visulima/package";
// or import { writePackageJson } from '@visulima/package/package-json';
writePackageJson({ name: "visulima" } /* ,{ cwd: "./" }*/);parsePackageJson
Parse the package.json file.
import { parsePackageJson } from "@visulima/package";
const packageJson = parsePackageJson(/* object or package.json as string */);findLockFile
Asynchronously finds a lock file in the specified directory or any of its parent directories.
import { findLockFile } from "@visulima/package";
// or import { findLockFile } from '@visulima/package/package-manager';
const lockFile = await findLockFile(); // => /Users/../Projects/visulima/packages/package/package-lock.jsonfindPackageManager
Finds the package manager used in a project based on the presence of lock files or package.json configuration.
If found, returns the package manager and the path to the lock file or package.json.
Throws an error if no lock file or package.json is found.
import { findPackageManager } from "@visulima/package";
// or import { findPackageManager } from '@visulima/package/package-manager';
const { packageManager, path } = findPackageManager(); // => { packageManager: 'npm', path: '/Users/../Projects/visulima/packages/package' }getPackageManagerVersion
Retrieves the version of the specified package manager.
import { getPackageManagerVersion } from "@visulima/package";
// or import { getPackageManagerVersion } from '@visulima/package/package-manager';
const version = await getPackageManagerVersion("npm"); // => 7.5.4Supported Node.js Versions
Libraries in this ecosystem make the best effort to track Node.js’ release schedule. Here’s a post on why we think this is important.
Contributing
If you would like to help take a look at the list of issues and check our Contributing guild.
Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Credits
About
Related Projects
- read-pkg - Read a package.json file.
License
The visulima package is open-sourced software licensed under the MIT