Open ek9 opened 7 years ago
This PR would also make sure phpspec2-support
branches history would be merged to master
(so phpspec2-support
can be removed in the future, but all it's history would remain in master
branch).
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:
README.md
https://github.com/leanphp/BehatSpec/tree/readme-updateThanks for catching this. I've updated it accordingly. I am not sure if rerunner
configuration pars needs to be there or not. If it must be there, then I believe it should be moved under extension's configuration ( http://www.phpspec.net/en/stable/cookbook/extensions.html ) instead of rerunner
namespace. However, that's a separate issue (if it needs to be there) so I am leaving it out of this PR.
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 #optional
I've checked in the code and I see that the extension itself still relies on checking for defined rerunner
config, so perhaps this has to be adjusted too after update to phpspec3.
I agree this has to be sorted in a separate PR as this one should only be README / docs cleanup with no functional changes.
@richardmiller I've got some time and tested the current master
branch. I've issued 2 more commits:
rerunner
configuration. It does not have to be defined, however in case you want to customize things, you have to define it. The updated readme now has a comment regarding this (main README.md and README.md of PhpSpecRunExtension) (commit https://github.com/richardmiller/BehatSpec/pull/35/commits/b50512623c49cac97931cec2960572b1584e022b )I believe this one is safe to be merged now as it provides correct / updated information for main README.md
and the ones in the extensions.
Otherwise, I had to rebase this against master due to conflict in composer.json
. It would be nice to merge this :)
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.md
ofBehatSpec
package so it would enable all of the extensions. If user installsBehatSpec
then all of the extensions are provided by the same package, thus the configuration now shows how to configure all bundle of extensions.0.5
isn't necessary as you would always need to update the documentation. The correct version can be figured out by the composer).README.md
for the extensions to include the updated configurations for PhpSpec3 as the format of defining extensions was changed.phpspec2-support
branch which has old instructions to set things up.BehatSpec
to 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.md
for all the extensions for standalone configuration to match latestbehat
/phpspec
versions. Also theyaml
confing examples used different kinds of indentation, so I standardized this to 4 space indentation so examples are consistent.Mentioned "Similar Extensions" in
README.mdof all extensions. There is also awlays a link to
BehatSpecpackage. This should make it easy for users of standalone extensions to find other extensions and main
BehatSpec` package.stable
version of documentation instead of old3.0
.Merging this should close #31