# docpad-baseplugin

> BasePlugin class for DocPad

Latest version **1.4.0** (published 2020-08-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install docpad-baseplugin
pnpm add docpad-baseplugin
yarn add docpad-baseplugin
bun add docpad-baseplugin
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2020-08-04 |
| First published | 2018-08-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 4 |
| Unpacked size | 23.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | 2018+ Benjamin Lupton |
| Maintainers | bevryme |
| Keywords | docpad, esnext, node, plugin, typed, types |

## Links

- npm: https://www.npmjs.com/package/docpad-baseplugin
- Repository: https://github.com/docpad/docpad-baseplugin
- Issues: https://github.com/docpad/docpad-baseplugin/issues
- Funding: https://bevry.me/fund
- npm.io page: https://npm.io/package/docpad-baseplugin

## Dependencies (4)

- [eachr](https://npm.io/package/eachr.md) ^4.5.0
- [errlop](https://npm.io/package/errlop.md) ^3.15.0
- [extendr](https://npm.io/package/extendr.md) ^5.13.0
- [typechecker](https://npm.io/package/typechecker.md) ^7.13.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.4.0 (latest) — 2020-08-04
- 1.4.0-next.1605505890.1c01e0e25bd70c404ea7604cdf4914d2dfef3475 (next) — 2020-11-16
- 1.4.0-next.1605505830.542fd3383d5d1e9d25435e3a495fc7575426f658 — 2020-11-16
- 1.4.0-next.1604902624.1205fe60a7893a8eec32abd57944f44a46f940fe — 2020-11-09
- 1.4.0-next.1604303482.2923c2d02f4cf644aa91927b30c83361a9333ca7 — 2020-11-02
- 1.4.0-next.1604302756.e36fb8a5b503577861af26d6cbceb0efd72a0478 — 2020-11-02
- 1.4.0-next.1603691780.5d33fbd9f77701d6c9e0aeccbeb845b4166ead0a — 2020-10-26
- 1.4.0-next.1603086277.9c84257a72277e179fb9820199aad2a505e1b849 — 2020-10-19
- 1.4.0-next.1602482052.22f24a9ff2a389a502c1bb11da2f2acdf456cbb5 — 2020-10-12
- 1.4.0-next.1601272903.bd70ff76ce208cc295c5912ca6bbf316f831c23c — 2020-09-28
- 1.4.0-next.1600667417.f0c1d360fce09844f2735bc97f6ce5fa5876f68a — 2020-09-21
- 1.4.0-next.1600667399.4d190f494d0264dac6763f5b7e911414913334e3 — 2020-09-21
- 1.4.0-next.1600066750.2231f1162ec9b75f667642e3674a61331dd2503c — 2020-09-14
- 1.4.0-next.1599478257.3894c65777433d60e55027537e7dc95f00a7e2cb — 2020-09-07
- 1.4.0-next.1598865896.eb7e449afb6c74cbfcf2fee89bbc60acf92815a5 — 2020-08-31
- … 12 more at https://npm.io/package/docpad-baseplugin/versions

## README

<!-- TITLE/ -->

<h1>docpad-baseplugin</h1>

<!-- /TITLE -->


<!-- BADGES/ -->

<span class="badge-travisci"><a href="http://travis-ci.com/docpad/docpad-baseplugin" title="Check this project's build status on TravisCI"><img src="https://img.shields.io/travis/com/docpad/docpad-baseplugin/master.svg" alt="Travis CI Build Status" /></a></span>
<span class="badge-npmversion"><a href="https://npmjs.org/package/docpad-baseplugin" title="View this project on NPM"><img src="https://img.shields.io/npm/v/docpad-baseplugin.svg" alt="NPM version" /></a></span>
<span class="badge-npmdownloads"><a href="https://npmjs.org/package/docpad-baseplugin" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/docpad-baseplugin.svg" alt="NPM downloads" /></a></span>
<span class="badge-daviddm"><a href="https://david-dm.org/docpad/docpad-baseplugin" title="View the status of this project's dependencies on DavidDM"><img src="https://img.shields.io/david/docpad/docpad-baseplugin.svg" alt="Dependency Status" /></a></span>
<span class="badge-daviddmdev"><a href="https://david-dm.org/docpad/docpad-baseplugin#info=devDependencies" title="View the status of this project's development dependencies on DavidDM"><img src="https://img.shields.io/david/dev/docpad/docpad-baseplugin.svg" alt="Dev Dependency Status" /></a></span>
<br class="badge-separator" />
<span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span>
<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
<span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
<span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span>
<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
<span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span>
<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
<span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>

<!-- /BADGES -->


<!-- DESCRIPTION/ -->

BasePlugin class for DocPad

<!-- /DESCRIPTION -->


## Usage

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

Install the dependency like so:

```bash
npm install --save docpad-baseplugin
```

Create your plugins using CoffeeScript like so:

```coffee
module.exports = class MyPlugin extends require('docpad-baseplugin') {
    name: 'myplugin'
    initialConfig: {}
    # ...
}
```

Create your plugins using JavaScript like so:

```javascript
module.exports = class MyPlugin extends require('docpad-baseplugin') {
    get name() {
        return 'myplugin'
    }
    get initialConfig() {
        return {}
    }
    // ...
}
```

You can use [boundation](https://github.com/bevry/boundation) to scaffold the above.

To setup tests, see [docpad-plugintester](https://github.com/docpad/docpad-plugintester).

<!-- INSTALL/ -->

<h2>Install</h2>

<a href="https://npmjs.com" title="npm is a package manager for javascript"><h3>npm</h3></a>
<ul>
<li>Install: <code>npm install --save docpad-baseplugin</code></li>
<li>Import: <code>import * as pkg from ('docpad-baseplugin')</code></li>
<li>Require: <code>const pkg = require('docpad-baseplugin')</code></li>
</ul>

<h3><a href="https://editions.bevry.me" title="Editions are the best way to produce and consume packages you care about.">Editions</a></h3>

<p>This package is published with the following editions:</p>

<ul><li><code>docpad-baseplugin</code> aliases <code>docpad-baseplugin/source/index.js</code></li>
<li><code>docpad-baseplugin/source/index.js</code> is <a href="https://en.wikipedia.org/wiki/ECMAScript#ES.Next" title="ECMAScript Next">ESNext</a> source code for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> 10 || 12 || 13 || 14 with <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a> for modules</li></ul>

<h3><a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a></h3>

This project provides its type information via inline <a href="http://usejsdoc.org" title="JSDoc is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor">JSDoc Comments</a>. To make use of this in <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a>, set your <code>maxNodeModuleJsDepth</code> compiler option to `5` or thereabouts. You can accomlish this via your `tsconfig.json` file like so:

``` json
{
  "compilerOptions": {
    "maxNodeModuleJsDepth": 5
  }
}
```

<!-- /INSTALL -->


<!-- HISTORY/ -->

<h2>History</h2>

<a href="https://github.com/docpad/docpad-baseplugin/blob/master/HISTORY.md#files">Discover the release history by heading on over to the <code>HISTORY.md</code> file.</a>

<!-- /HISTORY -->


<!-- CONTRIBUTE/ -->

<h2>Contribute</h2>

<a href="https://github.com/docpad/docpad-baseplugin/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>

<!-- /CONTRIBUTE -->


<!-- BACKERS/ -->

<h2>Backers</h2>

<h3>Maintainers</h3>

These amazing people are maintaining this project:

<ul><li><a href="https://balupton.com">Benjamin Lupton</a> — <a href="https://github.com/docpad/docpad-baseplugin/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository docpad/docpad-baseplugin">view contributions</a></li></ul>

<h3>Sponsors</h3>

No sponsors yet! Will you be the first?

<span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span>
<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
<span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
<span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span>
<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
<span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span>
<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
<span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>

<h3>Contributors</h3>

These amazing people have contributed code to this project:

<ul><li><a href="https://balupton.com">Benjamin Lupton</a> — <a href="https://github.com/docpad/docpad-baseplugin/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository docpad/docpad-baseplugin">view contributions</a></li></ul>

<a href="https://github.com/docpad/docpad-baseplugin/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>

<!-- /BACKERS -->


<!-- LICENSE/ -->

<h2>License</h2>

Unless stated otherwise all works are:

<ul><li>Copyright &copy; 2018+ <a href="https://balupton.com">Benjamin Lupton</a></li></ul>

and licensed under:

<ul><li><a href="http://spdx.org/licenses/MIT.html">MIT License</a></li></ul>

<!-- /LICENSE -->

---
_Source: https://npm.io/package/docpad-baseplugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
