Find all the workspaces of a monorepo.
It supports:
# npm
npm i find-workspaces
# yarn
yarn add find-workspaces
# pnpm
pnpm add find-workspaces// esm
import { findWorkspaces } from "find-workspaces";
// commonjs
const { findWorkspaces } = require("find-workspaces");
const workspaces = findWorkspaces();
console.log(workspaces);Finds all workspaces.
Returns Workspace[] or null if dirname is not inside a monorepo.
Type: string | undefined
Default: process.cwd()
The directory to start searching for the monorepo root.
Type: Options
Default: {}
See Options
Finds the monorepo root.
Returns WorkspacesRoot or null if dirname is not inside a monorepo.
Type: string | undefined
Default: process.cwd()
The directory to start searching for the monorepo root.
Type: Options
Default: {}
See Options
Returns a cache which can be provided to findWorkspaces and findWorkspacesRoot.
Type: string | undefined
Default: os.homedir()
The directory to stop searching for the monorepo root.
The provided directory will not be included in the search.
Type: Cache | undefined
An optional cache created by createWorkspacesCache.
Type: string
The location of the workspace as an absolute path.
Type: PackageJson
The parsed package.json file of the workspace.
Type: string
The location of the workspace as an absolute path.
Type: string[]
A list of the glob patterns used to define the workspaces.