rfcs icon indicating copy to clipboard operation
rfcs copied to clipboard

Published 20 hours ago • verified publisher icon emberjs

RFC: Standardize npm yarn use RFC

Open MehulKChaudhari opened this issue 2 years ago • 4 comments

Rendered text

Standardize the use of yarn and npm scripts in the Ember experience

This change encourages developers to use npm or yarn for certain commands when working with Ember applications, rather than using global Ember CLI commands like ember serve. This aligns Ember with norms in the JavaScript community and helps in reducing the confusion around Ember-specific commands.

MehulKChaudhari avatar Jul 22 '22 13:07 MehulKChaudhari

Just adding a note here that I will be the core team champion for this RFC.

jenweber avatar Jul 24 '22 22:07 jenweber

@MehulKChaudhari @dhanush027 Today the Framework team reviewed this RFC, and they had some suggestions to help make it more broadly applicable! Let me know if you want help making any of these changes:

  • Instead of focusing solely on npm start/test, we can revise the "motivation" section and title to be about using the scripts in package.json rather than focusing on npm/yarn. It is the scripts that are the industry standard we want to point to, not necessarily the CLI tool
  • We can mention the following commands as examples: test, start, build, and prepare
  • We should mention that developers should always refer to Contributing.md for full instructions when working with a new app or addon
  • We can include a link to "prior art" of showing npm start in CLI output. Here's when the text was introduced: https://github.com/ember-cli/ember-cli/commit/6c50caa24b9b0e458d1ec7eec36f8e1807fb48ac

After we make these revisions, we can communicate that this RFC is in FCP (final comment period) which will be a good opportunity to invite people to take another look, or a look for the first time.

jenweber avatar Aug 26 '22 18:08 jenweber

I'd like to help to make these changes to RFC.

dhanushkumar-dev avatar Aug 27 '22 05:08 dhanushkumar-dev

Yes I would like to help with point 2, 3, and 4

MehulKChaudhari avatar Aug 27 '22 06:08 MehulKChaudhari

👋 Hi, wondering what the status is of this RFC?

bertdeblock avatar Oct 01 '22 10:10 bertdeblock

@MehulKChaudhari are you able to update the RFC so the checks pass? @jenweber can help you!

locks avatar Sep 11 '23 16:09 locks

@MehulKChaudhari are you able to update the RFC so the checks pass? @jenweber can help you!

sure will do that

MehulKChaudhari avatar Sep 13 '23 16:09 MehulKChaudhari

It looks like our linter does not correctly ignore new files in the images folder. Should we merge without a green linter for this one, assuming consensus for the RFC content? Comment out that linter? Someone could fix it real quick in another PR? I would like this to not be blocked by our tooling.

jenweber avatar Sep 13 '23 17:09 jenweber

@kategengler do you have time to help out with the tooling?

locks avatar Sep 13 '23 18:09 locks

@locks I am looking at the tooling. It used to ignore the images (really need to figure out automated tests for workflows)

@jenweber I think it is fine to merge over the failures if it has been verified the RFC does pass those checks.

kategengler avatar Sep 13 '23 18:09 kategengler

@jenweber worth nothing you'll have to open the advancement PR yourself using https://github.com/emberjs/rfcs/blob/master/.github/READTHIS.md#trigger-opening-advancement-pryml

kategengler avatar Sep 13 '23 19:09 kategengler