The following options can be either added as arguments. To see a list of the supported arguments type:
shouldit --h
default: shouldit.conf.json
The location of your config file.
default: false
Starts ShoultIT? in watch mode. This means it will watch the file system for changes in either the spec files or test result files. As soon as any of these files are updated ShouldIT? will run again.
required
Tells ShouldIT? where to look for feature files. E.g specs/*.md When adding this through the command instead of the config file this might need to be in quotation marks.
shouldit --specs="specs/*.md"
required
This is where the test result files are to be found. The files can be in a mixture of json files that might look something like the following:
{
"Discussion": {
"should be interesting": "FAILED"
},
"My Feature My context": {
"should have another passing test": "PASSED"
}
}
Or JUnit XML files.
Values:
javascript,rspec,php,java,phpspec
At the moment when setting the value of hint to one of the above available hint languages ShouldIT? will prompt you the next test you should write. This will make writing your test somewhat easier.
default: false
Starts ShoultIT? with visualisation mode so you can see a project map at http://localhost:3000 or wherever your default port is set to.
default: 3000
When using visualisation mode this sets the port that you want the visualisation web server available at.