README.md

docpad-plugintester

DocPad's PluginTester class

Usage

Complete API Documentation.

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"
    }
}

Install

npm

Install Globally

• Install: npm install --global docpad-plugintester
• Executable: docpad-plugintester

Install Locally

• Install: npm install --save docpad-plugintester
• Executable: npx docpad-plugintester
• Import: import * as pkg from ('docpad-plugintester')
• Require: const pkg = require('docpad-plugintester')

Editions

This package is published with the following editions:

• docpad-plugintester aliases docpad-plugintester/source/index.js
• docpad-plugintester/source/index.js is ESNext source code for Node.js 10 || 12 || 13 || 14 with Require for modules

TypeScript

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
  }
}

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton — view contributions

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — view contributions

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

• Copyright © 2018+ Benjamin Lupton

and licensed under:

• MIT License