# workspace-info

> yarn workspace info implementation for yarn v2 berry, lerna and npm workspaces

Latest version **0.0.5** (published 2020-08-28) · ISC license · 0 weekly downloads

## Install

```sh
npm install workspace-info
pnpm add workspace-info
yarn add workspace-info
bun add workspace-info
```

Provides the command `workspace-info`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2020-08-28 |
| First published | 2020-08-28 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 33.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Tommaso De Rossi, morse |
| Maintainers | xmorse |

## Links

- npm: https://www.npmjs.com/package/workspace-info
- npm.io page: https://npm.io/package/workspace-info

## Dependencies (7)

- [glob](https://npm.io/package/glob.md) ^7.1.6
- [tslib](https://npm.io/package/tslib.md) ^2.0.0
- [yargs](https://npm.io/package/yargs.md) ^15.4.1
- [minimatch](https://npm.io/package/minimatch.md) ^3.0.4
- [@npmcli/map-workspaces](https://npm.io/package/@npmcli/map-workspaces.md) ^0.0.0-pre.1
- [read-package-json-fast](https://npm.io/package/read-package-json-fast.md) ^1.2.1
- [@npmcli/name-from-folder](https://npm.io/package/@npmcli/name-from-folder.md) ^1.0.1

## Recent versions

- 0.0.5 (latest) — 2020-08-28
- 0.0.4 — 2020-08-28
- 0.0.3 — 2020-08-28
- 0.0.2 — 2020-08-28

## README

# workspace-info

`yarn workspace info --json` implementation for yarn v2 berry, lerna and npm workspaces

```
yarn add workspace-info
```

## Usage as cli

```
workspace-info --cwd tests/example-workspace
```

by default peer dependencies are not included, use `--peer` to include them
```
workspace-info --peer
```

## Usage as lib

```js
import { getWorkspaceInfo } from 'workspace-info'

console.log(
    await getWorkspaceInfo({
        cwd,
        useLerna: false,
    }),
)

// {
//     a: {
//         location: '.../tests/example-workspace/packages/a',
//         mismatchedWorkspaceDependencies: [],
//         workspaceDependencies: ['b', 'd'],
//     },
//     b: {
//         location: '.../tests/example-workspace/packages/b',
//         mismatchedWorkspaceDependencies: [],
//         workspaceDependencies: ['d'],
//     },
//     c: {
//         location: '.../tests/example-workspace/packages/c',
//         mismatchedWorkspaceDependencies: [],
//         workspaceDependencies: ['b'],
//     },
//     d: {
//         location: '.../tests/example-workspace/packages/d',
//         mismatchedWorkspaceDependencies: [],
//         workspaceDependencies: ['c'],
//     },
// }
```

---
_Source: https://npm.io/package/workspace-info · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._