@npmcli/map-workspaces


Retrieves a name:pathname Map for a given workspaces config.

Long version: Reads the workspaces property from a valid workspaces configuration object and traverses the paths and globs defined there in order to find valid nested packages and return a Map of all found packages where keys are package names and values are folder locations.

Install

npm install @npmcli/map-workspaces

Usage:

``js
const mapWorkspaces = require('@npmcli/map-workspaces')
await mapWorkspaces({
cwd,
pkg: {
workspaces: {
packages: [
"a",
"b"
]
}
}
})
// ->
// Map {
// 'a': '/a'
// 'b': '/b'
// }
`

Examples:

$3

Given a folder structure such as:

`
├── package.json
└── apps
├── a
│ └── package.json
├── b
│ └── package.json
└── c
└── package.json
`

`js
const mapWorkspaces = require('@npmcli/map-workspaces')
await mapWorkspaces({
cwd,
pkg: {
workspaces: [
"apps/*"
]
}
})
// ->
// Map {
// 'a': '/apps/a'
// 'b': '/apps/b'
// 'c': '/apps/c'
// }
`

API:

$3

- opts:
- pkg: A valid package.json Object
- cwd: A String defining the base directory to use when reading globs and paths.
- ignore`: An Array of paths to be ignored when using globs to look for nested package.
- ...Also support all other glob options

#### Returns

A Map in which keys are package names and values are the pathnames for each found workspace.

LICENSE

ISC