Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Implemented
    • Affects Version/s: None
    • Fix Version/s: Master
    • Component/s: CLI
    • Labels:
      None

      Description

      When users post a question about "function x in Cordova isn't working", there is a default set of info that would be helpful to have, such as the Cordova version, OS version, perhaps the config.xml, and so forth. So how about if there is a "cordova about" command added to the CLI that can programmatically gather that information up, stuff it into a file, and leave the file on the user's system. Then we can ask the users to "run the 'cordova about' command and attach your about.txt file to the Jira issue". The intention is to make it easy and consistent to get information about the user's environment to help us debug issues. The information should be totally transparent, so the user can see what data they are sending.

        Issue Links

          Activity

          Hide
          Filip Maj added a comment -

          Great idea! Perhaps call it "info" ? It would be a project-level command, yes?

          Show
          Filip Maj added a comment - Great idea! Perhaps call it "info" ? It would be a project-level command, yes?
          Hide
          Marcel Kinard added a comment -

          Calling it "info" would also make sense.

          Yes, a project-level command would make sense. I don't see users doing much outside of a project.

          My employer calls this info "must gather", meaning it must be gathered by the user and is required by the support team to start diagnosing the issue.

          What specific pieces of data would be helpful? And would there be differences in that list between platforms?

          Show
          Marcel Kinard added a comment - Calling it "info" would also make sense. Yes, a project-level command would make sense. I don't see users doing much outside of a project. My employer calls this info "must gather", meaning it must be gathered by the user and is required by the support team to start diagnosing the issue. What specific pieces of data would be helpful? And would there be differences in that list between platforms?
          Hide
          Filip Maj added a comment -

          The following would all be useful:

          • the version of the cli tools (output of cordova -v)
          • the list of commands executed
          • config.xml inside www/ folder
          • if specific platforms are involved, then the versions of associated SDKs. For ios, the output of xcodebuild -version. For Android, the output of android list target to see which SDK(s) the user has installed.
          Show
          Filip Maj added a comment - The following would all be useful: the version of the cli tools (output of cordova -v ) the list of commands executed config.xml inside www/ folder if specific platforms are involved, then the versions of associated SDKs. For ios, the output of xcodebuild -version . For Android, the output of android list target to see which SDK(s) the user has installed.
          Hide
          Filip Maj added a comment -

          Adding CLI component.

          Show
          Filip Maj added a comment - Adding CLI component.
          Hide
          Lucas Holmquist added a comment -

          i would like to take this one, can someone assign to me

          Show
          Lucas Holmquist added a comment - i would like to take this one, can someone assign to me
          Hide
          Braden Shepherdson added a comment -

          What's the status of this?

          Show
          Braden Shepherdson added a comment - What's the status of this?
          Hide
          Lucas Holmquist added a comment -

          in progress. I think it's almost ready for a PR, my wife had a baby in the middle of it, so i got side tracked

          Show
          Lucas Holmquist added a comment - in progress. I think it's almost ready for a PR, my wife had a baby in the middle of it, so i got side tracked
          Hide
          Lucas Holmquist added a comment -

          hmm, doesn't look like i can attach a PR, so here it is https://github.com/apache/cordova-cli/pull/38

          Show
          Lucas Holmquist added a comment - hmm, doesn't look like i can attach a PR, so here it is https://github.com/apache/cordova-cli/pull/38
          Hide
          Marcel Kinard added a comment -

          I'll start working on this pull request. I missed your comment that it was ready.

          Show
          Marcel Kinard added a comment - I'll start working on this pull request. I missed your comment that it was ready.
          Hide
          Lucas Holmquist added a comment -

          Marcel Kinard i haven't touched this since the change to Q, you want me to do a bit of refactoring first. will probably be less messy if at some point it gets merged

          Show
          Lucas Holmquist added a comment - Marcel Kinard i haven't touched this since the change to Q, you want me to do a bit of refactoring first. will probably be less messy if at some point it gets merged
          Hide
          Marcel Kinard added a comment -

          Yes, it definitely isn't a clean merge in its current form. Could you do that refactoring? I would like to poke at it and merge it. Thanks!

          Show
          Marcel Kinard added a comment - Yes, it definitely isn't a clean merge in its current form. Could you do that refactoring? I would like to poke at it and merge it. Thanks!
          Hide
          Lucas Holmquist added a comment -

          Marcel Kinard i've refactored and rebased, so here is the updated PR https://github.com/apache/cordova-cli/pull/38

          Show
          Lucas Holmquist added a comment - Marcel Kinard i've refactored and rebased, so here is the updated PR https://github.com/apache/cordova-cli/pull/38
          Hide
          Marcel Kinard added a comment -

          I'm playing with the pull request, and the function looks good.

          When I run "npm test" in cordova-cli, the 3 tests you added fail. Do you need to checkin spec/fixtures/projects/cordova?

          Show
          Marcel Kinard added a comment - I'm playing with the pull request, and the function looks good. When I run "npm test" in cordova-cli, the 3 tests you added fail. Do you need to checkin spec/fixtures/projects/cordova?
          Hide
          Marcel Kinard added a comment -

          And is there anything you'd like to add to cordova-docs, such as in cordova-docs/docs/en/edge/guide/cli/index.md?

          Show
          Marcel Kinard added a comment - And is there anything you'd like to add to cordova-docs, such as in cordova-docs/docs/en/edge/guide/cli/index.md?
          Hide
          Lucas Holmquist added a comment -

          Marcel Kinard, sorry about the tests, look like i had some fixtures locally that were removed, i've refactored the tests a little and also rebased against master

          Show
          Lucas Holmquist added a comment - Marcel Kinard , sorry about the tests, look like i had some fixtures locally that were removed, i've refactored the tests a little and also rebased against master
          Hide
          Lucas Holmquist added a comment -

          and yes, i'll add something to those docs once merged

          Show
          Lucas Holmquist added a comment - and yes, i'll add something to those docs once merged
          Hide
          Marcel Kinard added a comment -

          Lucas: code works, tests work.

          But I don't see that you've filled out an ICLA (contributor license agreement). When that is done, your name should appear on https://people.apache.org/committer-index.html#unlistedclas

          ICLA instructions are at http://www.apache.org/licenses/#clas

          Thanks!

          Show
          Marcel Kinard added a comment - Lucas: code works, tests work. But I don't see that you've filled out an ICLA (contributor license agreement). When that is done, your name should appear on https://people.apache.org/committer-index.html#unlistedclas ICLA instructions are at http://www.apache.org/licenses/#clas Thanks!
          Hide
          Lucas Holmquist added a comment -

          just looked in my email, and it looks like i did, forwarding to your gmail

          Show
          Lucas Holmquist added a comment - just looked in my email, and it looks like i did, forwarding to your gmail
          Hide
          Lucas Holmquist added a comment -

          Looks like i'm on the list, search for just "Luke", looking at the form i submitted, the public name field is just "Luke"

          Show
          Lucas Holmquist added a comment - Looks like i'm on the list, search for just "Luke", looking at the form i submitted, the public name field is just "Luke"
          Hide
          ASF subversion and git services added a comment -

          Commit 3b1724da822d18376bd09150c6b3aadc7d9dbc76 in branch refs/heads/master from Lucas Holmquist
          [ https://git-wip-us.apache.org/repos/asf?p=cordova-cli.git;h=3b1724d ]

          CB-2234 Add 'cordova info' command

          Show
          ASF subversion and git services added a comment - Commit 3b1724da822d18376bd09150c6b3aadc7d9dbc76 in branch refs/heads/master from Lucas Holmquist [ https://git-wip-us.apache.org/repos/asf?p=cordova-cli.git;h=3b1724d ] CB-2234 Add 'cordova info' command
          Hide
          Marcel Kinard added a comment -

          Pull request is merged. You can close the pull request.

          I suggest that docs be submitted under this same Jira issue.

          Show
          Marcel Kinard added a comment - Pull request is merged. You can close the pull request. I suggest that docs be submitted under this same Jira issue.
          Hide
          Lucas Holmquist added a comment -
          Show
          Lucas Holmquist added a comment - ok, here is the doc update https://github.com/apache/cordova-docs/pull/130
          Hide
          ASF subversion and git services added a comment -

          Commit d907273f285e8dc36cc4a7e2972ca5a51ceb0aef in branch refs/heads/master from Lucas Holmquist
          [ https://git-wip-us.apache.org/repos/asf?p=cordova-docs.git;h=d907273 ]

          Add 'help' and 'info' section to CLI docs. CB-2234

          Show
          ASF subversion and git services added a comment - Commit d907273f285e8dc36cc4a7e2972ca5a51ceb0aef in branch refs/heads/master from Lucas Holmquist [ https://git-wip-us.apache.org/repos/asf?p=cordova-docs.git;h=d907273 ] Add 'help' and 'info' section to CLI docs. CB-2234
          Hide
          Marcel Kinard added a comment -

          Pull request for docs has been merged. You can close that pull request. Thanks!

          Show
          Marcel Kinard added a comment - Pull request for docs has been merged. You can close that pull request. Thanks!
          Hide
          Mike Sierra added a comment -

          Current "cordova info" output appears pretty disjointed, with a lot of extra vertical whitespace. Could use a cleanup.

          Show
          Mike Sierra added a comment - Current "cordova info" output appears pretty disjointed, with a lot of extra vertical whitespace. Could use a cleanup.
          Hide
          ASF subversion and git services added a comment -

          Commit 66939608f210c4c24ca51856f6b7719969e673c4 in branch refs/heads/master from Mike Sierra
          [ https://git-wip-us.apache.org/repos/asf?p=cordova-docs.git;h=6693960 ]

          CB-2234 cleanup CLI's 'info' command; location of info.txt file was wrong

          Show
          ASF subversion and git services added a comment - Commit 66939608f210c4c24ca51856f6b7719969e673c4 in branch refs/heads/master from Mike Sierra [ https://git-wip-us.apache.org/repos/asf?p=cordova-docs.git;h=6693960 ] CB-2234 cleanup CLI's 'info' command; location of info.txt file was wrong

            People

            • Assignee:
              Lucas Holmquist
              Reporter:
              Marcel Kinard
            • Votes:
              0 Vote for this issue
              Watchers:
              7 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development