What is find-yarn-workspace-root2?
The find-yarn-workspace-root2 npm package is a utility that helps you locate the root directory of a Yarn workspace. This can be particularly useful in monorepo setups where you need to programmatically determine the workspace root for various operations.
What are find-yarn-workspace-root2's main functionalities?
Find Yarn Workspace Root
This feature allows you to find the root directory of a Yarn workspace. The code sample demonstrates how to use the package to locate the workspace root and print it to the console.
const findYarnWorkspaceRoot = require('find-yarn-workspace-root2');
const workspaceRoot = findYarnWorkspaceRoot();
console.log(workspaceRoot);
Find Yarn Workspace Root from Specific Directory
This feature allows you to find the Yarn workspace root starting from a specific directory. The code sample shows how to specify a directory path and find the workspace root relative to that path.
const findYarnWorkspaceRoot = require('find-yarn-workspace-root2');
const workspaceRoot = findYarnWorkspaceRoot('/path/to/specific/directory');
console.log(workspaceRoot);
Other packages similar to find-yarn-workspace-root2
find-yarn-workspace-root
The find-yarn-workspace-root package provides similar functionality to find-yarn-workspace-root2. It helps locate the root directory of a Yarn workspace. The main difference is that find-yarn-workspace-root2 is a fork with additional improvements and maintenance.
workspace-tools
The workspace-tools package offers a broader set of utilities for working with Yarn and npm workspaces. It includes functionality for finding the workspace root, but also provides additional tools for managing and interacting with workspaces.
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);
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
Releases are handled by Travis CI once a build succeeds on master
. To trigger a release, bump the version using standard-version
:
$(yarn bin)/standard-version
That should update the CHANGELOG, bump the version in package.json
, and create a git tag. Then, just git push && git push --tags
.
Copyright 2017 Square, Inc.