This repository was archived by the owner on Jan 20, 2019. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 51
New ember debug command #2
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| - Start Date: 2015-01-04 | ||
| - RFC PR: (leave this empty) | ||
| - ember-cli Issue: (leave this empty) | ||
|
|
||
| # Summary | ||
|
|
||
| A new command `ember debug` to dump enough information about an ember-cli app to a report(file) that can be attached to issues. | ||
|
|
||
| # Motivation | ||
|
|
||
| An issue in the ember-cli ecosystem might be because of multiple reasons, | ||
| - Bower & npm dependencies used in the project | ||
| - Incorrect Brocfile setup | ||
| - Config is not right | ||
|
|
||
| Its hard for someone to take enough information out of their app and create sample repos to reproduce these issues. Instead they would just run `ember debug`, look through the generated file to make sure nothing super secret is put in to it and submit this file along with their issue. Makes the life of contributors a little more easier since they’d have most of the details they need for initial investigation right there in the generated report. | ||
|
|
||
| # Detailed design | ||
|
|
||
| `ember debug` would gather the following information | ||
| - ember-cli version | ||
| - npm version | ||
| - node version | ||
| - OS | ||
| - bower dependencies | ||
| - npm dependencies | ||
| - Brocfile.js | ||
| - config/environment.js | ||
| - Files counts in node_modues, vendor, bower_components, app folders | ||
| - Output of a command. i.e, sometimes running `ember build` might cause the issue, so when running this command users could possibly pass an argument `--command=`(e.g. --command=debug) which we can run and include the output along with the report. | ||
|
|
||
| # Unresolved questions | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. non i can think of. |
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what format should the output be?
Ideally we optimize for readability as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should also detect and log.