Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention npm scripts, per RFC-831 #302

Merged
merged 1 commit into from
Jan 8, 2024
Merged

Mention npm scripts, per RFC-831 #302

merged 1 commit into from
Jan 8, 2024

Conversation

jenweber
Copy link
Contributor

@jenweber jenweber commented Sep 18, 2023

We aim to teach the use of npm/yarn scripts in addition to bare CLI commands, since in real-world applications, developers may have different configurations specified in package.json scripts than the default commands would provide.

@MehulKChaudhari please review and let me know if you have any feedback!

RFC 831

Since the CLI guides aim to cover the CLI behavior, I did not fully replace things like ember serve with npm start, as we may end up doing for the regular ember guides. Instead I added a little bit of prose suggesting when to use the scripts.

We aim to teach the use of npm/yarn scripts in addition to bare CLI
commands, since in real-world applications, developers may have
different configurations specified in package.json scripts
than the default commands would provide.
@netlify
Copy link

netlify bot commented Sep 18, 2023

Deploy Preview for ember-cli-guides ready!

Name Link
🔨 Latest commit 780699f
🔍 Latest deploy log https://app.netlify.com/sites/ember-cli-guides/deploys/65086217d7cc59000833a68a
😎 Deploy Preview https://deploy-preview-302--ember-cli-guides.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@@ -1,6 +1,6 @@
<!-- alex disable just -->
For most Ember applications, Ember CLI "just works". Run `ember server` in your Terminal and you get
a LiveReload development server at `http://localhost:4200`. Run `ember build`, and you get a `dist/`
For most Ember applications, Ember CLI "just works". Run `ember server` or `npm start` in your Terminal and you get
Copy link

@MehulKChaudhari MehulKChaudhari Sep 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make it more generalised like use package manager whatever your project is using instead of just npm start?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're going to merge this unchanged, our reasoning is that if you are using any other package manager you are likely going to know how to "translate" commands from npm to your chosen package manager 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants