A simple utility to get the pnpm workspace information
npm install @node-kit/pnpm-workspace-infoA simple utility to get the pnpm 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]
``bashuse pnpm
$ pnpm install -D @node-kit/pnpm-workspace-info
Usage
use import
`js
import { pnpmWorkspaceInfo, pnpmWorkspaceInfoSync } from '@node-kit/pnpm-workspace-info'pnpmWorkspaceInfo()
// or
pnpmWorkspaceInfoSync()
`use require
`js
const { pnpmWorkspaceInfo, pnpmWorkspaceInfoSync } = require('@node-kit/pnpm-workspace-info')pnpmWorkspaceInfo()
// or
pnpmWorkspaceInfoSync()
`API reference
- Usage:
pnpmWorkspaceInfo(cwd) & pnpmWorkspaceInfoSync(cwd)
- Parameters:| Param | Description | Type | Optional value | Required | Default value |
| ----- | ------------ | -------- | -------------- | -------- | ------------- |
| cwd | running path | string | - | false | - |
- Types:
`ts
declare type ManifestInfo = Record & {
packages: string | string[]
}declare function pnpmWorkspaceInfo(cwd?: string): Promise
declare function pnpmWorkspaceInfoSync(cwd?: string): WorkspaceInfo | null
declare type WorkspaceInfo = Record<
string,
{
path: string
}
>
`- Demos:
1. simple use
`ts
import { pnpmWorkspaceInfo, pnpmWorkspaceInfoSync } from '@node-kit/pnpm-workspace-info'pnpmWorkspaceInfo({
cwd,
packageManager: 'pnpm'
}).then(data => {
console.log('The pnpm workspace info is: ', data) // { projectA: { path: 'packages/projectA' } }
})
console.log('The pnpm workspace info is: ', pnpmWorkspaceInfoSync()) // { projectA: { path: 'packages/projectA' } }
``Please open an issue here.
[npm-image]: https://img.shields.io/npm/v/@node-kit/pnpm-workspace-info.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@node-kit/pnpm-workspace-info
[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696
[codacy-url]: https://www.codacy.com/gh/saqqdy/@node-kit/pnpm-workspace-info/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/@node-kit/pnpm-workspace-info&utm_campaign=Badge_Grade
[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/@node-kit/pnpm-workspace-info.svg?style=flat-square
[codecov-url]: https://codecov.io/github/saqqdy/@node-kit/pnpm-workspace-info?branch=master
[download-image]: https://img.shields.io/npm/dm/@node-kit/pnpm-workspace-info.svg?style=flat-square
[download-url]: https://npmjs.org/package/@node-kit/pnpm-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