https://github.com/cmstead/webpack-mochadoc
Mochadoc plugin for the Webpack build system
https://github.com/cmstead/webpack-mochadoc
Last synced: 2 months ago
JSON representation
Mochadoc plugin for the Webpack build system
- Host: GitHub
- URL: https://github.com/cmstead/webpack-mochadoc
- Owner: cmstead
- License: mpl-2.0
- Created: 2017-11-17T16:49:04.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-17T21:56:17.000Z (over 8 years ago)
- Last Synced: 2025-12-27T01:59:05.547Z (6 months ago)
- Language: JavaScript
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Webpack-Mochadoc #
A Webpack plugin for running Mochadoc against your existing test codebase.
Find me online:
- [@cm_stead](https://twitter.com/cm_stead)
- [ChrisStead.com](http://www.chrisstead.com)
## Setup ##
First install Webpack-Mochadoc globally from NPM:
`npm install webpack-mochadoc --save-dev`
Then add your runner configuration to your webpack config:
```
var webpack = require('webpack');
const Mochadoc = require('./index.js');
module.exports = {
plugins: [
new Mochadoc({
test: {
config: './.mochadocrc'
}
})
],
};
```
That's it!
## Configuring Mochadoc ##
The best way to configure Mochadoc is to follow the instructions on the [Mochadoc NPM Page](https://www.npmjs.com/package/mochadoc).
A typical `.mochadocrc` file will look like the following:
```
{
"projectName": "My Groovy Project",
"files": "./test/**/*.test.js",
"dest": "./docs/api"
}
```
## Running Webpack-Mochadoc ##
Webpack-Mochadoc runs much like any other Webpack plugin. Running `webpack` will run all configured mochadoc tasks. This will generate all documents as each configuration defines.
## Commit History ##
### v1.0.0 ###
- First Stable Release