Install

``bash


use pnpm

$ pnpm install -D workspace-root

use yarn

$ yarn add -D workspace-root

use npm

$ npm install -D workspace-root
`

Usage

use import

`js
import { workspaceRoot, workspaceRootSync } from 'workspace-root'

workspaceRoot()
// or
workspaceRootSync()
`

use require

`js
const { workspaceRoot, workspaceRootSync } = require('workspace-root')

workspaceRoot()
// or
workspaceRootSync()
`

API reference

- Usage: workspaceRoot(cwd) & workspaceRootSync(cwd)
- Parameters:

- Types:

`ts
declare function workspaceRoot(cwd?: string): Promise

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

- Demos:

1. simple use

`ts
import { workspaceRoot, workspaceRootSync } from 'workspace-root'

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

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

Issues & Support

Please open an issue here.

License

MIT

[npm-image]: https://img.shields.io/npm/v/workspace-root.svg?style=flat-square
[npm-url]: https://npmjs.org/package/workspace-root
[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696
[codacy-url]: https://www.codacy.com/gh/saqqdy/workspace-root/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/workspace-root&utm_campaign=Badge_Grade
[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/workspace-root.svg?style=flat-square
[codecov-url]: https://codecov.io/github/saqqdy/workspace-root?branch=master
[download-image]: https://img.shields.io/npm/dm/workspace-root.svg?style=flat-square
[download-url]: https://npmjs.org/package/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