[Console] Exclude empty namespaces in text descriptor #19954

ro0NL · 2016-09-17T10:41:51Z

Q	A
Branch?	"master"
Bug fix?	yes
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	comma-separated list of tickets fixed by the PR, if any
License	MIT
Doc PR	reference to the documentation PR, if any

Before:

$ bin/console

 doctrine
  doctrine:mapping:convert                [orm:convert:mapping] Convert mapping information between supported formats.
 orm <----
 router
  router:match                            Helps debug routes by simulating a path info match

$ bin/console list orm

  [Symfony\Component\Debug\Exception\ContextErrorException]  
  Warning: max(): Array must contain at least one element  

$ bin/console list generate

Available commands for the "generate" namespace:
  generate:bundle      Generates a bundle
  generate:command     Generates a console command
  generate:controller  Generates a controller

After:

$ bin/console

 doctrine
  doctrine:mapping:convert                [orm:convert:mapping] Convert mapping information between supported formats.
 router
  router:match                            Helps debug routes by simulating a path info match

$ bin/console list orm

Available commands for the "orm" namespace:
  orm:convert:mapping  Convert mapping information between supported formats.

$ bin/console list generate

Available commands for the "generate" namespace:
  generate:bundle             Generates a bundle
  generate:command            Generates a console command
  generate:controller         Generates a controller
  generate:doctrine:crud      Generates a CRUD based on a Doctrine entity
  generate:doctrine:entities  Generates entity classes and method stubs from your mapping information
  generate:doctrine:entity    Generates a new Doctrine entity inside a bundle
  generate:doctrine:form      Generates a form type class based on a Doctrine entity

Overrules #19776 but also includes other fixes related to aliases that popped up when writing tests 👍

fabpot · 2016-09-17T16:43:26Z

Can you add a unit test to avoid regressions? Thanks.

ro0NL · 2016-09-17T17:31:56Z

src/Symfony/Component/Console/Tests/Fixtures/application_2.txt

@@ -13,8 +13,9 @@ My Symfony application <info>v1.0</info>
  <info>-v|vv|vvv, --verbose</info>  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

 <comment>Available commands:</comment>
-  <info>help</info>                 Displays help for a command
-  <info>list</info>                 Lists commands
+  <info>help</info>                       Displays help for a command


getColumnWidth considers aliases (descriptor:alias_command3), but we explicitly not render those.. not sure how to solve it..

Can't you have the same logic in getColumnWidth to have the same "exclusion rules"?

ro0NL · 2016-09-17T19:10:15Z

@fabpot maybe 72374eb should target 2.7 to ease future upstream merges/diffs...

fabpot · 2016-09-17T19:18:22Z

Indeed, merging it in 2.7 would greatly help

ro0NL · 2016-09-17T19:21:33Z

Would a PR do? Can you also please have a look at #19776 and decide what to do? I'd prefer this PR as a whole (all fixes can target master).

ro0NL · 2016-09-20T16:21:21Z

src/Symfony/Component/Console/Tests/Fixtures/DescriptorApplication2.php

@@ -20,5 +20,6 @@ public function __construct()
        parent::__construct('My Symfony application', 'v1.0');
        $this->add(new DescriptorCommand1());
        $this->add(new DescriptorCommand2());
+        $this->add(new DescriptorCommand3());


For the record, i chose this approach on testing to include the case in other formats as well (Markdown, XML, etc.). This to avoid future regressions as well.

fabpot · 2016-10-05T03:08:38Z

Can you rebase on current master?

ro0NL · 2016-10-05T17:48:36Z

Done.

fabpot · 2017-03-22T17:34:24Z

@ro0NL Sorry about that but can you rebase one last time? When done, ping me so that I can merge ASAP to avoid any problems. Thanks.

ro0NL · 2017-03-22T18:39:07Z

@fabpot done. Replayed the before/after scenarios once more, and still all good. Waiting for travis though :)

edit: green :)

fabpot · 2017-03-22T18:49:08Z

Thank you @ro0NL.

…(ro0NL) This PR was merged into the 3.3-dev branch. Discussion ---------- [Console] Exclude empty namespaces in text descriptor | Q | A | | --- | --- | | Branch? | "master" | | Bug fix? | yes | | New feature? | no | | BC breaks? | no | | Deprecations? | no | | Tests pass? | yes | | Fixed tickets | comma-separated list of tickets fixed by the PR, if any | | License | MIT | | Doc PR | reference to the documentation PR, if any | Before: ``` $ bin/console doctrine doctrine:mapping:convert [orm:convert:mapping] Convert mapping information between supported formats. orm <---- router router:match Helps debug routes by simulating a path info match $ bin/console list orm [Symfony\Component\Debug\Exception\ContextErrorException] Warning: max(): Array must contain at least one element $ bin/console list generate Available commands for the "generate" namespace: generate:bundle Generates a bundle generate:command Generates a console command generate:controller Generates a controller ``` After: ``` $ bin/console doctrine doctrine:mapping:convert [orm:convert:mapping] Convert mapping information between supported formats. router router:match Helps debug routes by simulating a path info match $ bin/console list orm Available commands for the "orm" namespace: orm:convert:mapping Convert mapping information between supported formats. $ bin/console list generate Available commands for the "generate" namespace: generate:bundle Generates a bundle generate:command Generates a console command generate:controller Generates a controller generate:doctrine:crud Generates a CRUD based on a Doctrine entity generate:doctrine:entities Generates entity classes and method stubs from your mapping information generate:doctrine:entity Generates a new Doctrine entity inside a bundle generate:doctrine:form Generates a form type class based on a Doctrine entity ``` Overrules #19776 but also includes other fixes related to aliases that popped up when writing tests 👍 Commits ------- d5a7608 [Console] Exclude empty namespaces in text descriptor

ro0NL changed the title ~~[Console] Include alias commands in text descriptor~~ [Console] Exlude empty namespaces in text descriptor Sep 17, 2016

ro0NL changed the title ~~[Console] Exlude empty namespaces in text descriptor~~ [Console] Exclude empty namespaces in text descriptor Sep 17, 2016

ro0NL commented Sep 17, 2016

View reviewed changes

ro0NL mentioned this pull request Sep 17, 2016

[Console] Only show namespaces with commands #19776

Closed

ro0NL commented Sep 20, 2016

View reviewed changes

javiereguiluz added this to the 3.2 milestone Nov 7, 2016

fabpot removed this from the 3.2 milestone Nov 16, 2016

nicolas-grekas added this to the 3.x milestone Dec 6, 2016

nicolas-grekas added Feature Console labels Dec 6, 2016

fabpot added the Status: Waiting feedback label Mar 22, 2017

[Console] Exclude empty namespaces in text descriptor

d5a7608

fabpot merged commit d5a7608 into symfony:master Mar 22, 2017

ro0NL deleted the console/command-aliases branch March 22, 2017 18:52

nicolas-grekas modified the milestones: 3.x, 3.3 Mar 24, 2017

ro0NL mentioned this pull request Apr 26, 2017

Hidden Console Commands & Namespaces #22512

Closed

fabpot mentioned this pull request May 1, 2017

Release v3.3.0-BETA1 #22603

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console] Exclude empty namespaces in text descriptor #19954

[Console] Exclude empty namespaces in text descriptor #19954

ro0NL commented Sep 17, 2016 •

edited

Loading

fabpot commented Sep 17, 2016

ro0NL Sep 17, 2016 •

edited

Loading

fabpot Sep 17, 2016

ro0NL Sep 17, 2016

ro0NL commented Sep 17, 2016

fabpot commented Sep 17, 2016

ro0NL commented Sep 17, 2016 •

edited

Loading

ro0NL Sep 20, 2016

fabpot commented Oct 5, 2016

ro0NL commented Oct 5, 2016

fabpot commented Mar 22, 2017

ro0NL commented Mar 22, 2017 •

edited

Loading

fabpot commented Mar 22, 2017

[Console] Exclude empty namespaces in text descriptor #19954

[Console] Exclude empty namespaces in text descriptor #19954

Conversation

ro0NL commented Sep 17, 2016 • edited Loading

fabpot commented Sep 17, 2016

ro0NL Sep 17, 2016 • edited Loading

Choose a reason for hiding this comment

fabpot Sep 17, 2016

Choose a reason for hiding this comment

ro0NL Sep 17, 2016

Choose a reason for hiding this comment

ro0NL commented Sep 17, 2016

fabpot commented Sep 17, 2016

ro0NL commented Sep 17, 2016 • edited Loading

ro0NL Sep 20, 2016

Choose a reason for hiding this comment

fabpot commented Oct 5, 2016

ro0NL commented Oct 5, 2016

fabpot commented Mar 22, 2017

ro0NL commented Mar 22, 2017 • edited Loading

fabpot commented Mar 22, 2017

ro0NL commented Sep 17, 2016 •

edited

Loading

ro0NL Sep 17, 2016 •

edited

Loading

ro0NL commented Sep 17, 2016 •

edited

Loading

ro0NL commented Mar 22, 2017 •

edited

Loading