@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 * as pkg from ('@bevry/pluginloader')
• Require: const pkg = require('@bevry/pluginloader')

Deno

import * as pkg from 'https://unpkg.com/@bevry/pluginloader@^5.3.0/edition-deno/index.ts'

Editions

This package is published with the following editions:

• @bevry/pluginloader aliases @bevry/pluginloader/index.cjs which uses the Editions Autoloader to automatically select the correct edition for the consumer's environment
• @bevry/pluginloader/source/index.ts is TypeScript source code with Import for modules
• @bevry/pluginloader/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
• @bevry/pluginloader/edition-es2016/index.js is TypeScript compiled against ES2016 for Node.js 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
• @bevry/pluginloader/edition-types/index.d.ts is TypeScript compiled Types with Import for modules

History

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

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

• Benjamin Lupton — Accelerating collaborative wisdom.

Maintainers

• Benjamin Lupton — Accelerating collaborative wisdom.

Contributors

• Benjamin Lupton — view contributions

Finances

Sponsors

• Andrew Nesbitt — Software engineer and researcher
• Balsa — We're Balsa, and we're building tools for builders.
• Codecov — Empower developers with tools to improve code quality and testing.
• Poonacha Medappa
• Rob Morris
• Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
• Syntax — Syntax Podcast

Donors

• Andrew Nesbitt
• Armen Mkrtchian
• Balsa
• Chad
• Codecov
• dr.dimitru
• Elliott Ditman
• entroniq
• GitHub
• Hunter Beast
• Jean-Luc Geering
• Michael Duane Mooring
• Michael Harry Scepaniak
• Mohammed Shah
• Mr. Henry
• Nermal
• Pleo
• Poonacha Medappa
• Rob Morris
• Robert de Forest
• Sentry
• ServieJS
• Skunk Team
• Syntax
• WriterJohnBuck

License

Unless stated otherwise all works are:

• Copyright © Benjamin Lupton

and licensed under:

• Artistic License 2.0

History

v5.3.0 2023 December 30

• Updated dependencies, base files, and editions using boundation
• Thank you to the sponsors: Andrew Nesbitt, Balsa, Codecov, Poonacha Medappa, Rob Morris, Sentry, Syntax

v5.2.0 2023 December 28

• Updated dependencies, base files, and editions using boundation
• Thank you to the sponsors: Andrew Nesbitt, Balsa, Codecov, Poonacha Medappa, Rob Morris, Sentry, Syntax

v5.1.0 2023 December 6

• Updated dependencies, base files, and editions using boundation

v5.0.0 2023 November 25

• Updated dependencies, base files, and editions using boundation
• Minimum required Node.js version changed from node: >=10 to node: >=6 adapting to ecosystem changes

v4.13.0 2023 November 21

• Updated dependencies, base files, and editions using boundation

v4.12.0 2023 November 20

• Updated dependencies, base files, and editions using boundation
• Updated license from MIT to Artistic-2.0
• Drop semver dependency for version-range which is a lightweight alternative, with better ecosystem support. This might change some version resolution behaviour, especially with 0.x and -prerelease versions.

v4.11.0 2020 August 18

• Updated dependencies, base files, and editions using boundation

v4.10.0 2020 July 23

• Updated dependencies, base files, and editions using boundation

v4.9.0 2020 June 25

• Updated dependencies, base files, and editions using boundation

v4.8.0 2020 June 22

• Updated dependencies, base files, and editions using boundation

v4.7.0 2020 June 21

• Updated dependencies, base files, and editions using boundation

v4.6.0 2020 June 20

• Updated dependencies, base files, and editions using boundation

v4.5.0 2020 June 11

• Updated dependencies, base files, and editions using boundation

v4.4.0 2020 June 10

• Updated dependencies, base files, and editions using boundation

v4.3.0 2020 May 22

• Updated dependencies, base files, and editions using boundation

v4.2.0 2020 May 21

• Updated dependencies, base files, and editions using boundation

v4.1.0 2020 May 21

• Updated dependencies, base files, and editions using boundation

v4.0.0 2020 May 11

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

v3.0.0 2019 December 18

• If you are using CommonJS, you must now do require('@bevry/pluginloader').default
• Updated dependencies, base files, and editions using boundation

v2.1.0 2019 December 10

• Updated dependencies, base files, and editions using boundation

v2.0.0 2019 December 7

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

v1.1.2 2018 October 1

• Fixed PluginClass as option not supporting plugin resolvers

v1.1.1 2018 September 8

• Added support for logging to help debug resolution errors
• Added a fallback in case type checker provided a false negative on class testing
• Updated typechecker dependency from v4.5.0 to v4.6.0

v1.1.0 2018 September 8

• Removed isPluginClass for require('typechecker').isClass as strict checking on this resulted in too many false negatives due to different baseplugin versions or locations being used between plugins and apps

v1.0.0 2018 September 4

• Initial working release