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

Contributing

Contributions are welcome! Just clone this repository and install the dependencies:

git clone https://github.com/square/find-yarn-workspace-root.git
cd find-yarn-workspace-root
yarn

Note that you'll need node and yarn installed. Next, verify the tests all pass:

yarn test

Then create a branch for your bugfix/feature, make changes and update the tests, and submit a pull request. Please do not change the version in package.json when submitting a pull request. We determine the next version automatically based on the commits since the last release.

NOTE: Commit messages follow the Angular commit message guidelines.

Releases

To trigger a release, bump the version using standard-version:

1. To update the CHANGELOG, bump the version in package.json, and create a git tag, run:

   $(yarn bin)/standard-version

2. git push && git push --tags

3. npm publish

Copyright 2017 Square, Inc.

Change Log

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

2.0.0 (2020-06-11)

Chores

• deps: update micromatch to v4 (c7e8189)

BREAKING CHANGES

• deps: requires Node >= 8.6

1.2.1 (2018-08-30)

Bug Fixes

• add typescript declaration (7c9c96f)

1.2.0 (2018-08-09)

Features

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

1.1.0 (2018-03-23)

Features

• allow new manifest.workspaces.packages format (5521d97)

Change Log

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.