aws/aws-cdk

[cli] Support installing dependencies with yarn

Open

#11,234 opened on Oct 31, 2020

View on GitHub
 (8 comments) (5 reactions) (0 assignees)TypeScript (3,530 forks)batch import
effort/smallfeature-requestgood first issuep2package/tools

Repository metrics

Stars
 (10,710 stars)
PR merge metrics
 (Avg merge 14d 11h) (68 merged PRs in 30d)

Description

Provide a way for new projects to use yarn over npm for installing dependencies.

Use Case

I primarily use yarn for all my projects, so when starting new cdk projects I have to delete the package.lock and node modules and reinstall using yarn.

Proposed Solution

It seems like the project by default uses yarn in its codebase, so maybe default to using yarn if it's there, and if not use npm.

Another option is to provide a flag on the init command that will indicate if to use yarn.

Other

I'd like to get feedback on the approach before I start a PR for this.

  • :wave: I may be able to implement this feature request
  • :warning: This feature might incur a breaking change

This is a :rocket: Feature Request

Contributor guide

Research direction
Inspect the current dependency installation logic in the CLI's init command and modify it to detect the presence of yarn and use it instead of npm.
Tech stack
typescriptnodejs
Domain
clidevtools
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptTypeScriptNode.jsYarn
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70