npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

plugload

v1.0.3

Published

A simple plugin loader module to add extensibility to your software.

Downloads

3

Readme

banner Have you ever wanted to add the possibility of plugins to your existing app (or new project)? It's never been simpler!

Usage

Install the library

npm i plugload
mkdir plugins # or name it to what you want, but remember to put that change in code

Create a file called .plugload.yaml and put the following contents

plugins:
  - plugin1
  - plugin2

Now create plugin1.ts and plugin2.ts and put your plugins. You can just create 1 plugin if you don't need two. Remember to change the .plugloadrc.yaml to mirror that. You can name the plugin files how ever you want. Again remember to edit .plugloadrc.yaml to mirror that too.

Import it to your code

import { PlugLoad } from "plugload"

Declare your the interfaces of your plugins

interface EmailPlugin {
	pluginName: string
	sendEmail(email: string, subject: string, message: string): void
}

interface MeaniePlugin {
	pluginName: string
	hurlInsults(): void
}

pluginName is necessary, but everything else is just what methods and vars you want to export from your plugin.

Example of usage:

;(async () => {
	// Your config file must be called .plugloadrc.yaml
	// or other cosmiconfig compatible file name and type: https://github.com/davidtheclark/cosmiconfig
	const provider = new PlugLoad("plugload", "plugins")
	await provider.getPlugins()
	for (let plugin of provider.loadedPlugins) {
		const initPlugin = new plugin()
		if (initPlugin.pluginName == "EmailPlugin") {
			const castPlugin = initPlugin as EmailPlugin
			castPlugin.sendEmail(
				"[email protected]",
				"Title of message",
				"Hello Mr. How are you this fine evening?"
			)
		}
		if (initPlugin.pluginName == "MeaniePlugin") {
			const castPlugin = initPlugin as MeaniePlugin
			castPlugin.hurlInsults()
		}
	}
})()

If you need more info look at the example.ts and the plugins folder.