From affc6c969557e2d0c8e25aa882e2ed0a32be7db4 Mon Sep 17 00:00:00 2001 From: Sivakumar Kailasam Date: Sun, 4 Jan 2015 00:49:03 +0530 Subject: [PATCH 1/3] RFC: ember debug command --- active/0000-ember-debug-command.md | 34 ++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 active/0000-ember-debug-command.md diff --git a/active/0000-ember-debug-command.md b/active/0000-ember-debug-command.md new file mode 100644 index 0000000..89b7d26 --- /dev/null +++ b/active/0000-ember-debug-command.md @@ -0,0 +1,34 @@ +- Start Date: 2015-01-04 +- RFC PR: (leave this empty) +- ember-cli Issue: (leave this empty) + +# Summary + +A new command **debug** to dump enough information about an ember-cli app to a 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 + +This is the bulk of the RFC. Explain the design in enough detail for somebody familiar +with the tool to understand, and for somebody familiar with the implementation to implement. +This should get into specifics and corner-cases, and include examples of how the feature is used. + +# Drawbacks + +Why should we *not* do this? + +# Alternatives + +What other designs have been considered? What is the impact of not doing this? + +# Unresolved questions + +What parts of the design are still TBD? From cc4c578df8153c8cb889651e9c5394b6dde7dff2 Mon Sep 17 00:00:00 2001 From: Sivakumar Kailasam Date: Sun, 4 Jan 2015 01:04:48 +0530 Subject: [PATCH 2/3] RFC: ember debug command --- active/0000-ember-debug-command.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/active/0000-ember-debug-command.md b/active/0000-ember-debug-command.md index 89b7d26..de10a9c 100644 --- a/active/0000-ember-debug-command.md +++ b/active/0000-ember-debug-command.md @@ -10,25 +10,25 @@ A new command **debug** to dump enough information about an ember-cli app to a f An issue in the ember-cli ecosystem might be because of multiple reasons, - Bower & npm dependencies used in the project -- Incorrect brocfile setup +- 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 -This is the bulk of the RFC. Explain the design in enough detail for somebody familiar -with the tool to understand, and for somebody familiar with the implementation to implement. -This should get into specifics and corner-cases, and include examples of how the feature is used. - -# Drawbacks - -Why should we *not* do this? - -# Alternatives - -What other designs have been considered? What is the impact of not doing this? +`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 + - 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 -What parts of the design are still TBD? + From 02d019e54179c10a076229dda71d8da429d0cf92 Mon Sep 17 00:00:00 2001 From: Sivakumar Kailasam Date: Sun, 4 Jan 2015 01:08:30 +0530 Subject: [PATCH 3/3] Update 0000-ember-debug-command.md --- active/0000-ember-debug-command.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/active/0000-ember-debug-command.md b/active/0000-ember-debug-command.md index de10a9c..3ea0e36 100644 --- a/active/0000-ember-debug-command.md +++ b/active/0000-ember-debug-command.md @@ -4,7 +4,7 @@ # Summary -A new command **debug** to dump enough information about an ember-cli app to a file that can be attached to issues. +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 @@ -18,16 +18,16 @@ Its hard for someone to take enough information out of their app and create samp # 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 - - 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. +- 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