BDD Framework to sweetly display software test results from Markdown files.
| Dependency | Version |
|---|---|
| NodeJS | ^10.15 |
| argparse | ^1.0.10 |
| cosmiconfig | ^5.1.0 |
| eslint | ^5.12.0 |
| handlebars | ^4.1.0 |
| husky | ^1.3.1 |
| mocha | ^5.2.0 |
| nyc | ^13.3.0 |
| showdown | ^1.9.0 |
| sinon | ^7.2.2 |
- Make sure you have the latest version of NodeJS and NPM
npm install git+https://github.com/Grasseh/PFE_H_2019.git --save-dev- Make a directory in your project for your Markdown files and the outputs
- Add a
.pfercfile to the root of your project similar to the following :
{
"outputPath" : "/path/to/markdown/output",
"basePath" : "/path/to/markdown"
}
- To use it with npm easily : add the framework to your
scriptsin package.json with something like this :
...
"scripts": {
...
"bdd" : "taffee -c .pfrec"
},
...
- Make your test cases in the directory specified in the config
[](i:NodeInvoker)
[](m:../testFacade.js)
# Saying hello world!
Our project rocks and needs to output Hello world!
## Example
When the project function is called then we see the output [Hello World](t:Test.testHelloWorld()).
If you wish to contribute please read the following guide:
- Clone this repository
- Run
npm installat the root of the repo. - Create a feature branch for your feature, or a fork.
- Code your feature
- Write tests for your feature
- Run tests with
npm test - Make sure your style is fine with
npm run eslint - Commit your changes
- Make a pull-request on the repo
- Ask a reviewer to validate your pull-request
- Be collaborative and respectful =)
The code is released under MIT license and its dependencies have their own licensing. For more informations, please consult their website.
Original contributors (Les Chevaliers de Coallier):