Readme updates for BehatSpec and extensions + merge phpspec2-support branch history to master #35
Conversation
|
This PR would also make sure I also wanted to add "Copyright / License" information to the README.md of the packages, but decided to keep my cleanup / restructure to what I currently have to not make too many changes in one PR. Let me know what you think, you can check how the new README.md look at:
|
ek9
changed the title
README.md
Outdated
| RMiller\BehatSpec\Extension\BehatSpecExtension\BehatExtension: | ||
| path: bin/phpspec #default value is bin/phpspec | ||
| config: path/to/phpspec.yml #optional | ||
| RMiller\BehatSpec\Extension\ErrorExtension\ErrorExtension: ~ |
There was a problem hiding this comment.
This shouldn't be necessary RMiller\BehatSpec\Extension\BehatSpecExtension\BehatExtension registers the other two extensions and passes that config to them.
README.md
Outdated
|
|
||
| ```yaml | ||
| # phpspec.yml | ||
| RMiller\BehatSpec\Extension\PhpSpecRunExtension\PhpSpecRunExtension: ~ |
There was a problem hiding this comment.
As before, RMiller\BehatSpec\Extension\BehatSpecExtension\PhpSpecExtension should register the other two extension automatically.
|
Thanks for catching this. I've updated it accordingly. I am not sure if |
|
I'm not sure off the top of my head about teh rerunner config. I think there were some changes to the way phpspec's config worked at some point. I'll double check and open a separate PR. |
|
In phpspec3 they changed the way you should write the configuration. The configuration should now be under extension's namespace instead, like this: extensions:
RMiller\BehatSpec\Extension\BehatSpecExtension\PhpSpecExtension:
path: vendor/bin/phpspec
commands: [describe, exemplify, your_own_fancy_command]
config: path/to/phpspec.yml #optionalI've checked in the code and I see that the extension itself still relies on checking for defined I agree this has to be sorted in a separate PR as this one should only be README / docs cleanup with no functional changes. |
…est version by default
…eanup specific version + minor word cleanup
…e enabled automatically
|
@richardmiller I've got some time and tested the current
I believe this one is safe to be merged now as it provides correct / updated information for main Otherwise, I had to rebase this against master due to conflict in |
This PR does some basic readme updates / cleanup according to updated subtreesplit structure. I believe this will be a small improvement and will clean up some minor inconsistencies in the documentation of the extensions.
Main updates:
README.mdofBehatSpecpackage so it would enable all of the extensions. If user installsBehatSpecthen all of the extensions are provided by the same package, thus the configuration now shows how to configure all bundle of extensions.0.5isn't necessary as you would always need to update the documentation. The correct version can be figured out by the composer).README.mdfor the extensions to include the updated configurations for PhpSpec3 as the format of defining extensions was changed.phpspec2-supportbranch which has old instructions to set things up.BehatSpecto the top of the page so people know about standalone extensions.README.md. All the structure and content remained the same with some minor adjustments.README.mdfor all the extensions for standalone configuration to match latestbehat/phpspecversions. Also theyamlconfing examples used different kinds of indentation, so I standardized this to 4 space indentation so examples are consistent.Mentioned "Similar Extensions" inREADME.mdof all extensions. There is also awlays a link toBehatSpecpackage. This should make it easy for users of standalone extensions to find other extensions and mainBehatSpec` package.stableversion of documentation instead of old3.0.Merging this should close #31