Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

find-workspaces

Package Overview
Dependencies
Maintainers
1
Versions
21
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

find-workspaces

Find all the workspaces of a monorepo.

  • 0.3.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
60K
increased by12.67%
Maintainers
1
Weekly downloads
 
Created
Source

find-workspaces npm downloads Coverage Status code style: prettier

Find all the workspaces of a monorepo.

It supports:

Installation

# npm
npm i find-workspaces

# yarn
yarn add find-workspaces

# pnpm
pnpm add find-workspaces

Usage

// esm
import { findWorkspaces } from "find-workspaces";
// commonjs
const { findWorkspaces } = require("find-workspaces");

const workspaces = findWorkspaces();

console.log(workspaces);

API

findWorkspaces(dirname, options)

Finds all workspaces.
Returns Workspace[] or null if dirname is not inside a monorepo.

dirname

Type: string | undefined
Default: process.cwd()

The directory to start searching for the monorepo root.

Options

Type: Options
Default: {}

See Options

findWorkspacesRoot(dirname, options)

Finds the monorepo root. Returns WorkspacesRoot or null if dirname is not inside a monorepo.

dirname

Type: string | undefined
Default: process.cwd()

The directory to start searching for the monorepo root.

Options

Type: Options
Default: {}

See Options

createWorkspacesCache()

Returns a cache which can be provided to findWorkspaces and findWorkspacesRoot.

Options

stopDir

Type: string | undefined
Default: os.homedir()

The directory to stop searching for the monorepo root.
The provided directory will not be included in the search.

cache

Type: Cache | undefined

An optional cache created by createWorkspacesCache.

Workspace

location

Type: string

The location of the workspace as an absolute path.

package

Type: PackageJson

The parsed package.json file of the workspace.

WorkspaceRoot

location

Type: string

The location of the workspace as an absolute path.

globs

Type: string[]

A list of the glob patterns used to define the workspaces.

License

MIT

Keywords

FAQs

Package last updated on 16 Feb 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc