3.2.0 • Published 2 years ago
workspace-pkgs v3.2.0
workspace-pkgs
A simple utility to get the workspace project list
Install
# use pnpm
$ pnpm install -D workspace-pkgs
# use yarn
$ yarn add -D workspace-pkgs
# use npm
$ npm install -D workspace-pkgs
Usage
use import
import { workspacePkgs, workspacePkgsSync } from '@node-kit/workspace-pkgs'
workspacePkgs()
// or
workspacePkgsSync()
use require
const { workspacePkgs, workspacePkgsSync } = require('@node-kit/workspace-pkgs')
workspacePkgs()
// or
workspacePkgsSync()
API reference
- Usage:
workspacePkgs(cwd)
&workspacePkgsSync(cwd)
- Parameters:
Param | Description | Type | Optional value | Required | Default value |
---|---|---|---|---|---|
cwd | running path | string | - | false | - |
- Types:
declare function workspacePkgs(cwd?: string): Promise<string[] | null>
declare function workspacePkgsSync(cwd?: string): string[] | null
- Demos:
- simple use
import { workspacePkgs, workspacePkgsSync } from '@node-kit/workspace-pkgs'
workspacePkgs().then(data => {
console.log('The workspace projects is: ', data) // [ 'packages/utils', 'packages/monorepo-root' ]
})
console.log('The workspace projects is: ', workspacePkgsSync()) // [ 'packages/utils', 'packages/monorepo-root' ]
Issues & Support
Please open an issue here.
License
3.2.0
2 years ago
3.1.1
2 years ago
3.1.0
2 years ago
3.0.0-beta.3
2 years ago
3.0.0-beta.2
2 years ago
3.0.0
2 years ago
3.0.0-beta.5
2 years ago
3.0.0-beta.4
2 years ago
2.5.1
2 years ago
2.5.0
2 years ago
2.4.0
2 years ago
2.3.0
2 years ago
2.2.1
2 years ago
2.2.0
2 years ago
2.1.0
2 years ago
2.0.0
2 years ago
2.0.0-beta.1
2 years ago
1.0.0-alpha.0
3 years ago