# @node-kit/pnpm-workspace-root

> A simple utility to get the pnpm workspace root

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

## Install

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

## 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-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 12.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 26 |
| Author | saqqdy |
| Maintainers | saqqdy |
| Keywords | node-kit, workspace, pnpm-workspace, workspace-root |

## Links

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

## Dependencies (3)

- [find-up](https://npm.io/package/find-up.md) ^5.0.0
- [@pnpm/error](https://npm.io/package/@pnpm/error.md) ^5.0.3
- [@node-kit/extra.fs](https://npm.io/package/@node-kit/extra.fs.md) 3.3.1

## Recent versions

- 3.3.1 (latest) — 2024-11-26
- 3.0.0-beta.5 (beta) — 2023-07-02
- 1.0.0-alpha.8 (alpha) — 2023-01-17
- 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
- … 20 more at https://npm.io/package/@node-kit/pnpm-workspace-root/versions

## README

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

# @node-kit/pnpm-workspace-root

A simple utility to get the pnpm workspace root

[![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/pnpm-workspace-root

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

# use npm
$ npm install -D @node-kit/pnpm-workspace-root
```

## Usage

use import

```js
import { pnpmWorkspaceRoot, pnpmWorkspaceRootSync } from '@node-kit/pnpm-workspace-root'

pnpmWorkspaceRoot()
// or
pnpmWorkspaceRootSync()
```

use require

```js
const { pnpmWorkspaceRoot, pnpmWorkspaceRootSync } = require('@node-kit/pnpm-workspace-root')

pnpmWorkspaceRoot()
// or
pnpmWorkspaceRootSync()
```

## API reference

- Usage: `pnpmWorkspaceRoot(cwd)` & `pnpmWorkspaceRootSync(cwd)`
- Parameters:

<div class="table-prop">

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

</div>

- Types:

```ts
declare function pnpmWorkspaceRoot(cwd?: string): Promise<string | null>

declare function pnpmWorkspaceRootSync(cwd?: string): string | null
```

- Demos:

1. simple use

```ts
import { pnpmWorkspaceRoot, pnpmWorkspaceRootSync } from '@node-kit/pnpm-workspace-root'

pnpmWorkspaceRoot().then(path => {
  console.log('The pnpm workspace root is: ', path) // /Users/user/path/of/package/root or null
})
console.log('The pnpm workspace root is: ', pnpmWorkspaceRootSync()) // /Users/user/path/of/package/root or null
```

## 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/pnpm-workspace-root.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@node-kit/pnpm-workspace-root
[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696
[codacy-url]: https://www.codacy.com/gh/saqqdy/@node-kit/pnpm-workspace-root/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/@node-kit/pnpm-workspace-root&utm_campaign=Badge_Grade
[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/@node-kit/pnpm-workspace-root.svg?style=flat-square
[codecov-url]: https://codecov.io/github/saqqdy/@node-kit/pnpm-workspace-root?branch=master
[download-image]: https://img.shields.io/npm/dm/@node-kit/pnpm-workspace-root.svg?style=flat-square
[download-url]: https://npmjs.org/package/@node-kit/pnpm-workspace-root
[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/pnpm-workspace-root · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._