CycloneDX/cyclonedx-node-yarn

feat: Support for projects with multiple/nested workspaces

Open

#35 opened on Mar 15, 2024

View on GitHubContributor guide
 (8 comments) (0 reactions) (0 assignees)JavaScript (10 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (27 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently this plugin will only resolve the dependencies/components for a single workspace at a time, which can introduce additional complexity/complication when working in a multi-workspace monorepo. Enhancing the plugin to recursively traverse all nested workspaces is quite a small change and would simplify the usage of this plugin in more complex projects, especially in cases where isolated reporting of BOM information is not required.

Contributor guide

Research direction
Investigate the code that resolves Yarn workspaces to understand why only a single workspace is processed at a time. Look for traversal logic and identify where recursion could be added to handle nested workspaces. Check existing tests for workspace handling.
Tech stack
javascriptnodejs
Domain
toolingbuild system
Issue type
Feature
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.jsYarn
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75