JSPM

  • Created
  • Published
  • Downloads 20187
  • Score
    100M100P100Q160525F
  • License MIT

A simple utility to get the pnpm workspace root

Package Exports

  • @node-kit/pnpm-workspace-root
  • @node-kit/pnpm-workspace-root/index

Readme

@node-kit/pnpm-workspace-root

A simple utility to get the pnpm workspace root

NPM version Codacy Badge Test coverage License

Sonar

Install

# 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

  1. use @node-kit/pnpm-workspace-root in async mode
import { pnpmWorkspaceRoot } 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
})
  1. use @node-kit/pnpm-workspace-root in sync mode
import { pnpmWorkspaceRootSync } from '@node-kit/pnpm-workspace-root'

console.log('The pnpm workspace root is: ', pnpmWorkspaceRootSync()) // /Users/user/path/of/package/root or null

Issues & Support

Please open an issue here.

License

MIT