For Developers Working on Kalabox Only
If you’re looking for documentation on how to use Kalabox, see the “For Users” section.
You should be able to use this guide to…
- Install “Kalabox on PHP” from source
- Learn where all the things are
- Learn about testing
- Learn about shipping
Please use the plugin installation guide to learn how to install the source version of this plugin.
Here is a general breakdown of where things live inside the plugin.
./ |-- app Contains a skeleton of an app we can copy to get started |-- docs Source markdown files for the documentation you are reading |-- lib Modules needed to implement `kbox create` |-- scripts Scripts to help with CI |-- test BATS functional tets
Code linting and standards
This plugin implements some basic linting and code standards to make sure things remain consistent between developers and to prevent syntax errors. You can easily check whether your code matches these standards using grunt.
The installer tests use the BATS framework.
Tests reside in the “test” folder. For examples of functional tests look for “.bats” files in the “test” folder.
Looking at existing tests will give you a good idea of how to write your own, but if you’re looking for more tips, we recommend:
# Package the the plugin into a distributable archive grunt pkg cd dist
Rolling a release
If you are an administrator of the plugin repo you can push various releases using the following…
# Do a minor ie 0.x.0 bump and push a release grunt release --dry-run grunt release # Do a patch ie 0.0.x bump and push a release grunt patch --dry-run grunt patch # Do a prerelease ie 0.0.0-alpha.x bump and push a release grunt prerelease --dry-run grunt prerelease