find-workspaces !npm downloads  

Find all the workspaces of a monorepo.

It supports:

- Yarn workspaces
- npm workspaces
- pnpm workspaces
- lerna
- bolt

Installation

``sh


npm

`javascript
// esm
import { findWorkspaces } from "find-workspaces";
// commonjs
const { findWorkspaces } = require("find-workspaces");

const workspaces = findWorkspaces();

console.log(workspaces);
`

API

$3

Finds all workspaces.
Returns [Workspace[]](#workspace) or null if dirname is not inside a monorepo.

#### dirname

Type: string | undefined
Default: process.cwd()

The directory to start searching for the monorepo root.

#### Options

Type: Options
Default: {}

See Options

$3

Finds the monorepo root.
Returns WorkspacesRoot or null if dirname is not inside a monorepo.

#### dirname

Type: string | undefined
Default: process.cwd()

The directory to start searching for the monorepo root.

#### Options

Type: Options
Default: {}

See Options

$3

Returns a cache which can be provided to findWorkspaces and findWorkspacesRoot.

$3

#### stopDir

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.

#### cache

Type: Cache | undefined

An optional cache created by createWorkspacesCache.

$3

#### location

Type: string

The location of the workspace as an absolute path.

#### package

Type: PackageJson

The parsed package.json file of the workspace.

$3

#### location

Type: string

The location of the workspace as an absolute path.

#### globs

Type: string[]`

A list of the glob patterns used to define the workspaces.

License

MIT