find-yarn-workspace-root

What is find-yarn-workspace-root?

The find-yarn-workspace-root npm package is a utility that helps to find the root of a Yarn workspace. It traverses the directory tree up from a given directory until it finds a package.json file with a 'workspaces' field, indicating the root of a Yarn workspace. This is particularly useful in monorepo setups where multiple packages are managed under a single version control system.

What are find-yarn-workspace-root's main functionalities?

Find Yarn Workspace Root

This feature allows you to find the root directory of a Yarn workspace by providing the current directory. It will return the path to the workspace root or null if it's not inside a Yarn workspace.

const findYarnWorkspaceRoot = require('find-yarn-workspace-root');
const workspaceRoot = findYarnWorkspaceRoot(__dirname);

Other packages similar to find-yarn-workspace-root

pkg-dir

The pkg-dir package is similar in that it finds the root directory of a Node.js project or npm package by locating the package.json file. However, it does not specifically look for Yarn workspace roots and is more general-purpose.

find-root

find-root is another package that finds the root of a project by searching for a specific file (by default package.json) in the current directory or any parent directory. It's similar to find-yarn-workspace-root but does not specifically target Yarn workspaces.

find-package-json

find-package-json is a package that iterates over the filesystem to find all the package.json files. It can be used to find the nearest package.json file, but unlike find-yarn-workspace-root, it does not provide specific functionality for identifying Yarn workspace roots.

README

find-yarn-workspace-root

Algorithm for finding the root of a yarn workspace, extracted from yarnpkg.com

Installation

yarn add find-yarn-workspace-root

Usage

const findWorkspaceRoot = require('find-yarn-workspace-root');

const workspaceRoot = findWorkspaceRoot(__dirname); // Absolute path or null

Testing

yarn test

---

Copyright 2017 Square, Inc.

Changelog

1.2.0 (2018-08-09)

Features

• allow new manifest.workspaces.packages format (5521d97)
• make initial path optional (475aaff)

<a name="1.1.0"></a>