@bevry/pluginloader

A class for loading, verifying, and creating plugins. Used by DocPad for years.

Usage

Complete API Documentation.

Basics

Create your project:

1. mkdir my-project
2. cd my-project

Create your plugin:

1. mkdir myplugin

2. cd myplugin

3. npm init

4. index.js to:

   module.exports = function (BasePlugin) {
       return class MyPlugin extends BasePlugin {
           constructor(...args) {
               super(...args)
               console.log('hello from my plugin')
           }
       }
   }
   

5. cd ..

Create your plugin loader:

1. mkdir myapp

2. cd myapp

3. npm init

4. index.js to:

   import PluginLoader from '@bevry/pluginloader'
   
   class BasePlugin {
       constructor() {
           console.log('hello from base plugin')
       }
   }
   
   const pluginLoader = new PluginLoader({
       BasePlugin,
       pluginPath: require('path').resolve(__dirname, '..', 'myplugin'),
   })
   

5. cd ..

Run the project:

1. node myapp/index.js

Ecosystem

• pluginclerk a project for fetching compatible plugins from the npm registry
• docpad-baseplugin the BasePlugin class that DocPad uses
• docpad-plugintester testing helpers for DocPad plugins

Install

npm

• Install: npm install --save @bevry/pluginloader
• Import: import pkg from ('@bevry/pluginloader')
• Require: const pkg = require('@bevry/pluginloader').default

Editions

This package is published with the following editions:

• @bevry/pluginloader/source/index.ts is TypeScript source code with Import for modules
• @bevry/pluginloader aliases @bevry/pluginloader/edition-esnext/index.js
• @bevry/pluginloader/edition-esnext/index.js is TypeScript compiled against ESNext for Node.js 10 || 12 || 13 || 14 with Require for modules
• @bevry/pluginloader/edition-node-esm/index.js is TypeScript compiled against ESNext for Node.js with Import for modules

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