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

@electron-buddy/vite-plugin

v1.3.1

Published

vite plugin for electron quick start

Downloads

111

Readme

This plugin simplifies the process of building an Electron application by focusing on the renderer while also seamlessly managing the builds for the main and preload processes. It allows for an easy setup and coordinated build process, making it more convenient to work with all parts of an Electron app in a unified workflow.

Full-example

Installation

npm i -D @electron-buddy/vite-plugin electron terser
yarn add -D @electron-buddy/vite-plugin electron terser
pnpm add -D @electron-buddy/vite-plugin electron terser

Electron doesn't protect your source code. Minimum protection is provided by terser and do not use sensitive information in the client-side code.

Getting Started

package.json

{
  "main": "dist/main.js",
  "scripts": {
    "dev": "vite",
    "build": "vite build",
    "preview": "vite preview",
    "start": "electron-buddy --preview"
  }
}

vite.config.ts

It’s recommended to set root to the renderer directory, not the root of the project.

import { defineConfig } from 'vite';
import { electron } from '@electron-buddy/vite-plugin';

export default defineConfig({
  root: './renderer', // index.html directory
  plugins: [electron()]
});

main entry file (main/index.ts)

import { BrowserWindow } from 'electron';

const win = new BrowserWindow({
  width:1280,
  height:720,
  webPreferences: {
    preload: join(__dirname, './preload.js'), // relative path (both)
    sandbox: false
  }
});

if (process.env.NODE_ENV === 'development' && process.env['RENDERER_URL']) {
  await win.loadURL(process.env['RENDERER_URL']); // vite dev server url (dev server)
} else {
  await win.loadFile(join(__dirname, './renderer/index.html')); // relative path (build)
}

Default Folder Structure

If you configure as above, ensure that you follow this folder structure.


src
├── main
│   ├── index.ts
├── renderer
│   ├── index.html
├── preload
│   ├── index.ts
├── vite.config.ts
├── dist
    ├── main.js
    ├── preload.js
    ├── renderer
        ├── index.html
        ├── ...
├── tsconfig.json

Custom OutDir & Entries

❗️Remember to update the main field in package.json if you change the output directory (e.g., to ./out/main.js).

export default defineConfig({
    root: './renderer',
    plugins: [
        electron({
            outDir: './out', // custom output directory
            preload: {
                entry: './preload2/index.ts' // custom preload entry
            },
            main: {
                entry: './main2/index.ts' // custom main entry
            }
        })
    ]
});

CLI

 Usage: electron-buddy [options]

Options:
    --help      Show help message
    --preview   Run electron app with 'main' entry file (same as 'electron .')

Multiple Entries

Sometimes, you may need multiple renderers, such as for a splash screen, a loading screen, and more. To achieve this, simply add additional .html files to the renderer directory(root of vite.config.*).

src
├── renderer
│   ├── index.html
│   ├── splash.html
│   ├── loading.html

# after build..

dist
├── renderer
    ├── index.html
    ├── splash.html
    ├── loading.html

main entry file (main/index.ts)

if (process.env.NODE_ENV === 'development' && process.env['RENDERER_URL']) {
  await win.loadURL(process.env['RENDERER_URL'] + '/splash.html'); // vite dev server url (dev server)
} else {
  await win.loadFile(join(__dirname, './renderer/splash.html')); // relative path (build)
}

Notice

  • Only Dependencies are packed in the final build. DevDependencies are not included.