aws/aws-cdk

[cli] Support installing dependencies with yarn

Open

#11234 opened on Oct 31, 2020

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

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

Tech stack
typescriptnodejs
Domain
clitooling
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.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Node.jsfamiliarity with npm/yarnunderstanding of CLI commands
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Review the existing CLI init command logic, particularly how dependencies are currently installed using npm. Consider implementing a package manager flag or auto detecting yarn. Check for any yarn related configuration files. Discuss approach in issue #11234 before implementing.