yarnpkg/yarn

Trailing slash breaks workspace features when yarn run inside workspace folder

Open

#5816 opened on May 14, 2018

View on GitHub
 (12 comments) (0 reactions) (1 assignee)JavaScript (41,514 stars) (2,731 forks)batch import
cat-buggood first issuetriaged

Description

Do you want to request a feature or report a bug?

Bug.

What is the current behavior? When the workspaces definition contains a trailing slash, running e. g. yarn workspaces info in the root works just as expected. But when you cd into the workspace folder and run yarn workspaces info, it fails because it cannot detect that that folder is a workspace.

If the current behavior is a bug, please provide the steps to reproduce.

  1. Create a new project directory.
  2. Create a subdirectory called package.
  3. yarn init inside package/.
  4. yarn init in the root.
  5. Add package/ (with trailing slash) as a workspace to the root package.json. 
    ...
"workspaces": {
  "packages": [
    "package/"
  ],
},
...
  6. Run yarn workspaces info in the root. => Outputs workspace list correctly.
  7. Run yarn workspaces info in package/. => Fails with 
    yarn workspaces v1.6.0
error Cannot find the root of your workspace - are you sure you're currently in a workspace?
info Visit https://yarnpkg.com/en/docs/cli/workspaces for documentation about this command.

What is the expected behavior? Running yarn workspaces info should output the workspaces when run both inside root and package/.

If this behavior is intended, the documentation could reflect the reason why.

Please mention your node.js, yarn and operating system version. Node v8.11.1 Yarn v1.6.0 Ubuntu 16.04 LTS

Contributor guide

Tech stack
javascriptnodejs
Domain
developer experiencecli
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of Yarn workspacesUnderstanding of Node.js path handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate how Yarn determines the workspace root when running inside a workspace. Look at the function that checks if a directory is a workspace (likely in `src/cli/commands/workspaces.js` or `src/util/findWorkspaceRoot.js`). The issue is that a trailing slash in the workspace pattern (e.g., "package/") is not normalized when comparing paths. The fix should normalize the pattern or the directory path before comparison. Check if there are any existing tests for workspace root detection and add a test case with trailing slashes.