hmr-electron

hmr-electron is a package to ease the development of an app with Electron + Vite by enabling transparent module reloading.

This project is based on elecrun. I was bored and liked it.

Installation

Use your preferred package manager to install:

yarn add --dev hmr-electron

Usage

You need to have a file on the root of your package named hmr-electron.config.ts Type in your terminal yarn hmr-electron init and this file will be created:

import type { UserProvidedConfigProps } from "hmr-electron";

const config: UserProvidedConfigProps = {
 electronEntryFilePath: "./src/main/index.cts",
 preloadFilePath: "./src/main/preload.cts",
};

export default config;

There are several other config options that you can set. Check the type UserProvidedConfigProps to see them.

Set scripts on your package.json

{
 "scripts": {
  "build": "hmr-electron build",
  "clean": "hmr-electron clean",
  "dev": "hmr-electron dev"
 },
 "devDependencies": {
  "hmr-electron": "latest",
  "@types/node": "latest",
  "typescript": "latest",
  "electron": "latest",
  "vite": "latest"
 }
}

Contributing

Once you've cloned the repo, make use of the demo package inside '/tests/full/demo' by linking to main package:

# On this repo:
yarn link # `unlink` to unlink.

# On /tests/full/demo
yarn link "hmr-electron"`

This will create a symlink named demo/node_modules/hmr-electron that links to your local copy of the hmr-electron project.

This way, you'll only need to do a yarn build on every change that you make and run the demo project, as it will use the newest build.

You can also contribute by creating tests 😃. This project uses vitest, so it's a fast developer experience 💙💙! Just run yarn test.

License

MIT