adlarge / fixtures-documentation-bundle Goto Github PK

For now only scalar propertie for addFIxtureEntity are documented. We want to be able to auto document complex objects like arrays, Collection and other linked entities if it's described in config

With doctrine, detect PostCommit to automatically create fixture in documentation with the newly created entity

The use of process to launch command get a deprecated warning. Change the invocation with a string and use an array

entities must be configEntities

When enableAutoDocumentation option set to true, I expect to not fullfill configEntities with all entities and their properties. Its really annoying ;) but the bundle to get all properties and autolink to linked entities.

Hope you could simplify it :)

The goal is to be able to reference an entity in another entity when building doc and, in the resulting doc, to have a link toward the references entity in the page

• While building the doc, add a way to reference another entity
  $doc->addFixture('Products', [ 'id' => 2, 'name' => 'Product 2', 'customer' => $doc->makeLink('Customer', 1) ]);
• We have to be sure to set which property is an id one for each entity (or to construct one if needed)
• use these id as anchors in the doc and generate link to go to these anchors

For alixe fixture load for example we don't have the same command to listen, add in the config a way to set the command to listen

listenedCommand: 'php bin/console doctrine:fixtures:load' must be listenedCommand: 'doctrine:fixtures:load'

Please provide an example for hautelook:fixture:load too.

The goal is to be able to

• config each entity in a yaml file : the name and the fields to document
• intercept when one of these entities is commited and automatically add it to the documentation

Example :
in entities.yaml
`

• Product
  • id
  • name
• Customer
  • id
  • first_name
  • last_name
  • email
    `

To be able to dev and test an easier way

In FixturesDocumentationManager.php, path to var directory is hardcoded.
It leads to a bug on our system as this directory is not writable, and cache dir is set to another location outside project.

$this->jsonFilePath = $this->projectDir . '/var/' . self::FILE_NAME;

Could you change it to "%kernel.cache_dir%" or something similar (or provide a way to configure the path of the path) ?

Fixtures class seems to be listed in reverse alphabetical order in generated index.
Will be better if it is not reversed ? ;)

To better "sell" this useful bundle, maybe it could be interesting to show the auto config first (autoDoc in #21). And all other options could be after or in a dedicated MD file, so the first page is more light.