add support for generating human readable documentation from Configuration classes #1663
Comments
|
+1 for this |
|
@kbond are you still working on https://github.com/kbond/symfony/tree/config_dump_command ? |
|
@lsmith77 I haven't for a while, should I create a PR from that branch to at least prompt a discussion? |
|
yeah sounds like a good idea |
Merged
fabpot
added a commit
that referenced
this issue
Feb 4, 2012
Commits ------- 4847d3a renamed command e97af0b code fixes df94282 [FrameworkBundle] removed unnecessary DebugCommand fa32885 [SecurityBundle] added configuration info 2f8ad93 [MonologBundle] added configuration info 9757958 [FrameworkBundle] added configuration info 58939f1 [TwigBundle] added configuration docs 8dc40e4 [FrameworkBundle] added config:dump console command Discussion ---------- Config dump command Bug fix: no Feature addition: yes Backwards compatibility break: no Symfony2 tests pass: yes Fixes the following tickets: #1663 Todo: add more config info/examples [](http://travis-ci.org/kbond/symfony) This is a config dump command based on the additions of PR #1099. This was initially part of that PR and there is some discussion there about it (#1099) ### Usage: 1. dump by root node: ``app/console config:dump framework`` 2. dump by bundle name: ``app/console config:dump FrameworkBundle`` A few issues/notes: * Only dumps to yaml * Only 1 configuration per bundle (this was brought by @stof here: #1099 (comment)) * Works out of the box for most bundles but not ones that use a non-standard ``Configuration`` class (such as the assetic bundle). In this case ``Extension::getConfiguration()`` must be configurated. I have used it to create some (most) of the config reference docs. It works fine but I find it somewhat crude, any suggestions to improve it would be appreciated. --------------------------------------------------------------------------- by kbond at 2012-01-24T21:00:43Z Few more issues: 1. Should I abstract the logic to a "normalizer" class that converts the Configuration class into a manageable array? I struggle with this idea because isn't that what ``TreeBuilder`` basically is? 2. @stof made a good point that ``config:dump`` doesn't really describe what this does. Would dumping your config be useful? Perhaps ``config:dump framework`` dumps the config for your project while ``config:dump --ref framework`` dumps the default reference? --------------------------------------------------------------------------- by stof at 2012-01-24T21:18:15Z @kbond you cannot really dump the config. Part of it does not go through these extensions at all. And it does not make much sense anyway IMO. the command as is does the right job IMO (i.e. dumping a reference for the extension). But its name should be improved --------------------------------------------------------------------------- by kbond at 2012-01-24T21:20:51Z ``config:reference`` perhaps? --------------------------------------------------------------------------- by fabpot at 2012-02-02T10:05:19Z This command is about displaying the default configuration for a given bundle. So, what about `config:dump-reference`? As I understand, the command name is the last element to figure out before merging, right? --------------------------------------------------------------------------- by stof at 2012-02-02T10:19:49Z @fabpot indeed. --------------------------------------------------------------------------- by stof at 2012-02-02T10:34:16Z and +1 for ``config:dump-reference`` --------------------------------------------------------------------------- by Tobion at 2012-02-02T12:08:03Z why not use the words you chose yourself: `config:dump-default` I think it's more explicit.
|
Should this be closed now ? |
|
indeed |
](http://travis-ci.org/kbond/symfony){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Requested originally by @lsmith77 on http://trac.symfony-project.org/ticket/9597
The text was updated successfully, but these errors were encountered: