https://github.com/docpad/docpad-plugintester

DocPad's PluginTester class
https://github.com/docpad/docpad-plugintester

docpad docpad-core

Last synced: about 1 month ago
JSON representation

DocPad's PluginTester class

• Host: GitHub
• URL: https://github.com/docpad/docpad-plugintester
• Owner: docpad
• License: other
• Created: 2018-08-20T10:58:57.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-01-01T23:53:08.000Z (over 1 year ago)
• Last Synced: 2024-04-23T16:21:31.734Z (about 1 year ago)
• Topics: docpad, docpad-core
• Language: JavaScript
• Homepage:
• Size: 297 KB
• Stars: 1
• Watchers: 4
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        


docpad-plugintester

































DocPad's PluginTester class

## Usage

[Complete API Documentation.](http://master.docpad-plugintester.docpad.surge.sh/docs/index.html)

To upgrade from code that looks like this:

```javascript

require('docpad')

    .require('testers')

    .test({

        pluginPath: __dirname + '/..',

        testerClass: 'RendererTester',

    })

```

You would run:

```bash

npm install --save-dev docpad-plugintester

```

And then replace that code with:

```javascript

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:

```json

{

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

``` json

{

  "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