docpad-plugintester v1.7.3
DocPad's PluginTester class
Usage
To upgrade from code that looks like this:
require('docpad')
.require('testers')
.test({
pluginPath: __dirname + '/..',
testerClass: 'RendererTester',
})
You would run:
npm install --save-dev docpad-plugintester
And then replace that code with:
require('docpad-plugintester').test({
DocPad: require('docpad'),
pluginPath: require('path').join(__dirname, '..'),
})
In fact, if that file doesn't have anything custom inside it (testerClass
is now also unnecessary), then you can delete that file altogether and change your package.json:scripts.test
to docpad-plugintest
like so:
{
"scripts": {
"test": "docpad-plugintester"
}
}
npm
This project provides its type information via inline JSDoc Comments. To make use of this in TypeScript, set your maxNodeModuleJsDepth compiler option to 5
or thereabouts. You can accomlish this via your tsconfig.json
file like so:
{
"compilerOptions": {
"maxNodeModuleJsDepth": 5
}
}
Discover the release history by heading on over to the HISTORY.md file.
Discover how you can contribute by heading on over to the CONTRIBUTING.md file.
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:
Discover how you can contribute by heading on over to the CONTRIBUTING.md file.
Unless stated otherwise all works are:
and licensed under: