3.0.2 β€’ Published 10 months ago

@sapphire/plugin-hmr v3.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

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:

const { start } = require('@sapphire/hmr');

const client = new SapphireClient({
	/* your bot options */
});

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

	// this has to be called after you have logged into your bot
	if (process.env.NODE_ENV === 'development') {
		start();
	}
}

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 { start } from '@sapphire/plugin-hmr';

const client = new SapphireClient({
	/* your bot options */
});

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

	// this has to be called after you have logged into your bot
	if (process.env.NODE_ENV === 'development') {
		start();
	}
}

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 WithAddress
Open CollectiveClick Here
Ko-fiClick Here
PatreonClick Here
PayPalClick Here

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

3.0.3-next.b4f1701

10 months ago

3.0.3-next.0782cfd

10 months ago

3.0.2

10 months ago

3.0.3-next.a0edebf

10 months ago

3.0.2-next.b2086e1

10 months ago

3.0.2-next.80d26ac

10 months ago

3.0.3-next.5395ccc

10 months ago

3.0.2-next.d9dd30c

10 months ago

3.0.3-next.21d90cf

10 months ago

3.0.3-next.c75b7c2

10 months ago

3.0.2-next.6b9d139

10 months ago

3.0.3-next.dd4b95f

10 months ago

3.0.3-next.e0e4d74

10 months ago

3.0.2-next.d512e6d

10 months ago

3.0.2-next.12ccd3c

10 months ago

3.0.2-next.d2c9aaa

10 months ago

3.0.2-next.ccf3dc1

10 months ago

3.0.2-next.6a148bb

10 months ago

3.0.2-next.5aa5898

10 months ago

3.0.2-next.518ac87

10 months ago

3.0.2-next.9e3ae6f

10 months ago

3.0.2-next.8128717

10 months ago

3.0.2-next.a1d7d5e

10 months ago

3.0.2-next.96ac961

11 months ago

3.0.2-next.5ea63b2

11 months ago

3.0.2-next.352f2cd

11 months ago

3.0.2-next.fa73a83

11 months ago

3.0.2-next.22ae85d

11 months ago

3.0.2-next.f177359

11 months ago

3.0.2-next.51af5e9

11 months ago

3.0.2-next.1c40781

11 months ago

3.0.2-next.8de2057

11 months ago

3.0.2-next.f8b2f60

11 months ago

3.0.2-next.f730be1

11 months ago

3.0.2-next.f61b06f

11 months ago

3.0.2-next.e6fdc84

11 months ago

3.0.2-next.9b36bae

11 months ago

3.0.2-next.30e71f4

12 months ago

3.0.2-next.821ff70

12 months ago

3.0.2-next.56b0ad1

12 months ago

3.0.2-next.fb8af18

12 months ago

3.0.2-next.8b575e9

12 months ago

3.0.2-next.7ba75bc

12 months ago

3.0.2-next.18d56e9

12 months ago

3.0.2-next.e37f2d0

12 months ago

3.0.2-next.e30dbc1

12 months ago

3.0.2-next.c2464a5

12 months ago

3.0.2-next.73cea33

12 months ago

3.0.1

2 years ago

3.0.0

2 years ago

2.0.3

2 years ago

2.0.2

2 years ago

2.0.1

2 years ago

1.2.2

3 years ago

1.2.1

3 years ago

2.0.0

3 years ago

1.2.0

3 years ago

1.1.1

4 years ago

1.1.0

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago