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

History

v1.7.3 2020 August 13

• Output docpad and tester configuration for easier debugging
• Compatibility with situations where the custom tester forgot to chain

v1.7.2 2020 August 13

• Better manual edition/directory loading (compounded by v1.7.0)

v1.7.1 2020 August 13

• Fix manual edition/directory loading (compounded by v1.7.0)

v1.7.0 2020 August 13

• Correctly load and test editioned plugins
• Output what we actually load, so awareness and debugging is much easier
• Updated dependencies, base files, and editions using boundation

v1.6.2 2020 August 5

• required docpad v6.83.1 to make use of the following bugfix
  • ensures test plugin is loaded prior to docpadReady event and whatnot
• support --debug along with -d
• testCreate and testLoad are now merged into a new testInit

v1.6.1 2020 August 5

• fixed Error: Cannot find module 'assert-helpers' (regression since v1.4.0)

v1.6.0 2020 August 5

• new whitespace param, which now defaults to trim, which will trim all whitespace from the start and end of each line, and will remove whitespace only lines
• the old removeWhitespace param is now ported to whitespace="remove"

v1.5.0 2020 August 5

• Updated dependencies, base files, and editions using boundation
• Minimum required node version changed from node: >=0.10 to node: >=10 to keep up with mandatory ecosystem changes

v1.3.3 2018 October 1

• The create test is now a suite of tests, so that its workings are illuminated

v1.3.2 2018 October 1

• Fix ReferenceError: Symbol is not defined on legacy node versions

v1.3.1 2018 September 28

• More reliable test detection

v1.3.0 2018 September 28

• Properly enable support for custom plugin testers
  • PluginTester.test now works for inherited classes
  • PluginTester::test now defaults the joe-reporter, rather than having it done in the docpad-plugintester executable
• Support testing specific editions via docpad-plugintester edition=name

v1.2.1 2018 September 8

• Updated base files and editions using boundation

v1.2.0 2018 September 8

• Removed DocPad v6.82 deprecations
• testCreate no longer runs the init action, now it only does clean and install

v1.1.1 2018 August 20

• Add notice of removal of the testerClass property (lowecase t) and do not treat it as the new TesterClass property (uppercase T)

v1.1.0 2018 August 20

• Eliminated testerPath for TesterClass
• Eliminated the need for the pluginname.test.js file if only defaults were used
  • Instead, you can now replace it with the docpad-plugintester executable
• Eliminated the need for the earlier premade custom tester classes (server tester, and render tester)
  • testGenerate now runs render tests if outExpectedPath exists`
  • Server tester has been removed, following its deprecation

v1.0.0 2018 August 20

• Abstracted out from DocPad v6.80.9 and converted to esnext