# @node-kit/yarn-workspace-info

> A simple utility to get the yarn workspace information

Latest version **3.3.1** (published 2024-11-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @node-kit/yarn-workspace-info
pnpm add @node-kit/yarn-workspace-info
yarn add @node-kit/yarn-workspace-info
bun add @node-kit/yarn-workspace-info
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.3.1 |
| Published | 2024-11-26 |
| First published | 2023-01-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 16.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 26 |
| Author | saqqdy |
| Maintainers | saqqdy |
| Keywords | node-kit, workspace, lerna-workspace, pnpm-workspace, yarn-workspace, yarn-workspace-info, yarn-workspace-information |

## Links

- npm: https://www.npmjs.com/package/@node-kit/yarn-workspace-info
- Repository: https://github.com/saqqdy/node-kit
- Homepage: https://github.com/saqqdy/node-kit/tree/master/packages/yarn-workspace-info#readme
- Issues: https://github.com/saqqdy/node-kit/issues
- npm.io page: https://npm.io/package/@node-kit/yarn-workspace-info

## Dependencies (4)

- [fast-glob](https://npm.io/package/fast-glob.md) ^3.3.2
- [@node-kit/extra.fs](https://npm.io/package/@node-kit/extra.fs.md) 3.3.1
- [@node-kit/extra.path](https://npm.io/package/@node-kit/extra.path.md) 3.3.1
- [@node-kit/yarn-workspace-root](https://npm.io/package/@node-kit/yarn-workspace-root.md) 3.3.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 3.3.1 (latest) — 2024-11-26
- 3.0.0-beta.5 (beta) — 2023-07-02
- 3.3.0 — 2024-11-21
- 3.2.0 — 2023-08-28
- 3.1.1 — 2023-07-10
- 3.1.0 — 2023-07-05
- 3.0.0 — 2023-07-02
- 3.0.0-beta.4 — 2023-07-02
- 3.0.0-beta.3 — 2023-07-01
- 3.0.0-beta.2 — 2023-07-01
- 2.5.1 — 2023-04-24
- 2.5.0 — 2023-04-22
- 2.4.0 — 2023-04-20
- 2.3.0 — 2023-03-01
- 2.2.1 — 2023-02-05
- … 10 more at https://npm.io/package/@node-kit/yarn-workspace-info/versions

## README

<div style="text-align: center;" align="center">

# @node-kit/yarn-workspace-info

A simple utility to get the yarn workspace information

[![NPM version][npm-image]][npm-url]
[![Codacy Badge][codacy-image]][codacy-url]
[![Test coverage][codecov-image]][codecov-url]
[![npm download][download-image]][download-url]
[![License][license-image]][license-url]

[![Sonar][sonar-image]][sonar-url]

</div>

## Install

```bash
# use pnpm
$ pnpm install -D @node-kit/yarn-workspace-info

# use yarn
$ yarn add -D @node-kit/yarn-workspace-info

# use npm
$ npm install -D @node-kit/yarn-workspace-info
```

## Usage

use import

```js
import { yarnWorkspaceInfo, yarnWorkspaceInfoSync } from '@node-kit/yarn-workspace-info'

yarnWorkspaceInfo()
// or
yarnWorkspaceInfoSync()
```

use require

```js
const { yarnWorkspaceInfo, yarnWorkspaceInfoSync } = require('@node-kit/yarn-workspace-info')

yarnWorkspaceInfo()
// or
yarnWorkspaceInfoSync()
```

## API reference

- Usage: `yarnWorkspaceInfo(cwd)` & `yarnWorkspaceInfoSync(cwd)`
- Parameters:

<div class="table-prop">

| Param | Description  | Type     | Optional value | Required | Default value |
| ----- | ------------ | -------- | -------------- | -------- | ------------- |
| cwd   | running path | `string` | -              | `false`  | -             |

</div>

- Types:

```ts
declare type ManifestInfo = Record<string, unknown> & {
  workspaces: string | string[]
}

declare type WorkspaceInfo = Record<
  string,
  {
    path: string
  }
>

declare function yarnWorkspaceInfo(cwd?: string): Promise<WorkspaceInfo | null>

declare function yarnWorkspaceInfoSync(cwd?: string): WorkspaceInfo | null
```

- Demos:

1. simple use

```ts
import { yarnWorkspaceInfo, yarnWorkspaceInfoSync } from '@node-kit/yarn-workspace-info'

yarnWorkspaceInfo({
  cwd,
  packageManager: 'pnpm'
}).then(data => {
  console.log('The yarn workspace info is: ', data) // { projectA: { path: 'packages/projectA' } }
})
console.log('The yarn workspace info is: ', yarnWorkspaceInfoSync()) // { projectA: { path: 'packages/projectA' } }
```

## Issues & Support

Please open an issue [here](https://github.com/saqqdy/node-kit/issues).

## License

[MIT](LICENSE)

[npm-image]: https://img.shields.io/npm/v/@node-kit/yarn-workspace-info.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@node-kit/yarn-workspace-info
[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696
[codacy-url]: https://www.codacy.com/gh/saqqdy/@node-kit/yarn-workspace-info/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/@node-kit/yarn-workspace-info&utm_campaign=Badge_Grade
[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/@node-kit/yarn-workspace-info.svg?style=flat-square
[codecov-url]: https://codecov.io/github/saqqdy/@node-kit/yarn-workspace-info?branch=master
[download-image]: https://img.shields.io/npm/dm/@node-kit/yarn-workspace-info.svg?style=flat-square
[download-url]: https://npmjs.org/package/@node-kit/yarn-workspace-info
[license-image]: https://img.shields.io/badge/License-MIT-blue.svg
[license-url]: LICENSE
[sonar-image]: https://sonarcloud.io/api/project_badges/quality_gate?project=saqqdy_node-kit
[sonar-url]: https://sonarcloud.io/dashboard?id=saqqdy_node-kit

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