Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
@sapphire/plugin-hmr
Advanced tools
Plugin for @sapphire/framework for hot module reloading for pieces
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.
@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
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();
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
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 |
Please make sure to read the Contributing Guide before making a pull request.
Thank you to all the people who already contributed to Sapphire!
FAQs
Plugin for @sapphire/framework for hot module reloading for pieces
The npm package @sapphire/plugin-hmr receives a total of 965 weekly downloads. As such, @sapphire/plugin-hmr popularity was classified as not popular.
We found that @sapphire/plugin-hmr demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.