@sapphire/plugin-hmr
TypeScript icon, indicating that this package has built-in type declarations

3.0.1 • Public • Published

Sapphire Logo

@sapphire/plugin-hmr

Plugin for @sapphire/framework for super-speed HMR.

GitHub codecov npm bundle size npm

Description

This plugin provides a HMR (Hot Module Replacement) feature for @sapphire/framework. This allows you to add, delete, and update commands, listeners, and other pieces without having to restart your bot. This allows for rapid iteration and prototyping without your bot slowing you down.

Features

  • Fully ready for TypeScript!
  • Includes ESM ready entrypoint
  • Easy to use

Installation

@sapphire/plugin-hmr depends on the following packages. Be sure to install these along with this package!

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm install @sapphire/plugin-hmr @sapphire/framework

Usage

JavaScript

In your main or setup file, register the plugin:

require('@sapphire/plugin-hmr/register');

Or if you want to make sure the plugin is only loaded in development, you can register it dynamically like so:

require('@sapphire/plugin-hmr/register');

const client = new SapphireClient({
	/* your bot options */
	hmr: {
		enabled: process.env.NODE_ENV === 'development'
	}
});

async function main() {
	await client.login();
}

void main();

TypeScript

In your main or setup file, register the plugin:

import '@sapphire/plugin-hmr/register';

Or if you want to make sure the plugin is only loaded in development, you can register it dynamically like so:

import '@sapphire/plugin-hmr/register';

const client = new SapphireClient({
	/* your bot options */
	hmr: {
		enabled: process.env.NODE_ENV === 'development'
	}
});

async function main() {
	await client.login();
}

void main();

In order for HMR to pick up your compiled JavaScript files, you will need to recompile your code. To that end, we will configure a dev script in package.json scripts that runs build in parallel with start:

"scripts": {
	"dev": "run-p watch start",
	"build": "tsc",
	"watch": "tsc --watch",
	"start": "node dist/index.js"
}

Note: This uses the run-p script which is part of npm-run-all

Note 2: Please do note that because the processes are started simultaneously you should run build at least once before running dev, otherwise the start process will fail because there are no files to run just yet.

then run your bot using the dev script. You can replace npm with your package manager of choice.

npm run start

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Donate With Address
Open Collective Click Here
Ko-fi Click Here
Patreon Click Here
PayPal Click Here

Contributors

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Sapphire!

Package Sidebar

Install

npm i @sapphire/plugin-hmr

Weekly Downloads

562

Version

3.0.1

License

MIT

Unpacked Size

38 kB

Total Files

21

Last publish

Collaborators

  • favna
  • vladfrangu
  • kyranet