{"action":"created","issue":{"url":"https://api.github.com/repos/andres-montanez/Magallanes/issues/228","labels_url":"https://api.github.com/repos/andres-montanez/Magallanes/issues/228/labels{/name}","comments_url":"https://api.github.com/repos/andres-montanez/Magallanes/issues/228/comments","events_url":"https://api.github.com/repos/andres-montanez/Magallanes/issues/228/events","html_url":"https://github.com/andres-montanez/Magallanes/pull/228","id":77126461,"number":228,"title":"Handle '--help' option for commands","user":{"login":"eps90","id":1702899,"avatar_url":"https://avatars.githubusercontent.com/u/1702899?v=3","gravatar_id":"","url":"https://api.github.com/users/eps90","html_url":"https://github.com/eps90","followers_url":"https://api.github.com/users/eps90/followers","following_url":"https://api.github.com/users/eps90/following{/other_user}","gists_url":"https://api.github.com/users/eps90/gists{/gist_id}","starred_url":"https://api.github.com/users/eps90/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eps90/subscriptions","organizations_url":"https://api.github.com/users/eps90/orgs","repos_url":"https://api.github.com/users/eps90/repos","events_url":"https://api.github.com/users/eps90/events{/privacy}","received_events_url":"https://api.github.com/users/eps90/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/andres-montanez/Magallanes/labels/Feedback%20Needed","name":"Feedback Needed","color":"fbca04"},{"url":"https://api.github.com/repos/andres-montanez/Magallanes/labels/Improvement","name":"Improvement","color":"0052cc"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-05-16T20:42:18Z","updated_at":"2015-05-16T20:43:26Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/andres-montanez/Magallanes/pulls/228","html_url":"https://github.com/andres-montanez/Magallanes/pull/228","diff_url":"https://github.com/andres-montanez/Magallanes/pull/228.diff","patch_url":"https://github.com/andres-montanez/Magallanes/pull/228.patch"},"body":"Hi Magallanes users! Welcome back after such long break :)\r\nSome time ago I've started working on `--help` option for commands. I don't know why I have stopped contributing this idea. Fortunatelly, I've got everything on remote repo on my GitHub account, so I could continue my work :)\r\nThis PR includes only part of `--help` functionality. After running Magallanes binary with command and `--help` option, you should get description of the command such as that on following screenshot:\r\n![zaznaczenie_032](https://cloud.githubusercontent.com/assets/1702899/7667857/309308fe-fc1b-11e4-8969-98b58249f76b.png)\r\n\r\nThere is much more to do than I thought before. Things that should be done in the nearest future includes:\r\n* General `--help` for `mage` binary\r\n* Option to specify command arguments and options (like in Symfony2 commands) to validate command calling and generate help message dynamically and avoid programmers effort in designing help messages\r\n* Prepare help messages for other built-in commands (this PR includes help messages for only few of them)\r\n\r\nHelp message API includes following methods accessible in `AbstractCommand` class:\r\n* `setName` - Name of the command (displayed after phrase _Command_)\r\n* `setHelpMessage` - Short description of the command\r\n* `setSyntaxMessage` - Displays the information how the command should be called properly\r\n* `addUsageExample` - allows to add an usage example with short description what command does"},"comment":{"url":"https://api.github.com/repos/andres-montanez/Magallanes/issues/comments/102687043","html_url":"https://github.com/andres-montanez/Magallanes/pull/228#issuecomment-102687043","issue_url":"https://api.github.com/repos/andres-montanez/Magallanes/issues/228","id":102687043,"user":{"login":"coveralls","id":2354108,"avatar_url":"https://avatars.githubusercontent.com/u/2354108?v=3","gravatar_id":"","url":"https://api.github.com/users/coveralls","html_url":"https://github.com/coveralls","followers_url":"https://api.github.com/users/coveralls/followers","following_url":"https://api.github.com/users/coveralls/following{/other_user}","gists_url":"https://api.github.com/users/coveralls/gists{/gist_id}","starred_url":"https://api.github.com/users/coveralls/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/coveralls/subscriptions","organizations_url":"https://api.github.com/users/coveralls/orgs","repos_url":"https://api.github.com/users/coveralls/repos","events_url":"https://api.github.com/users/coveralls/events{/privacy}","received_events_url":"https://api.github.com/users/coveralls/received_events","type":"User","site_admin":false},"created_at":"2015-05-16T20:43:26Z","updated_at":"2015-05-16T20:43:26Z","body":"\n[![Coverage Status](https://coveralls.io/builds/2580194/badge)](https://coveralls.io/builds/2580194)\n\nCoverage increased (+10.28%) to 34.06% when pulling **b9cf2d1058b7f511ec406a9d550c9b9a178452b8 on edpauto:commands-help** into **bbefc65888ad07e5c02a255c199c0ab4b5757d56 on andres-montanez:develop**.\n"}}