<div align="center"> <a href="https://github.com/farm-fe/farm"> </a> <p> <span>English</span> | <a href="./README-zh-CN.md">简体中文</a> </div>

Electron Plugin for Farm

Support development Electron App using Farm.

Getting Started

To begin, you'll need to @farmfe/js-plugin-electron:

bash

npm install @farmfe/js-plugin-electron --save-dev

bash

yarn add -D @farmfe/js-plugin-electron

bash

pnpm add -D @farmfe/js-plugin-electron

Configuring the plugin in farm.config.ts:

import { defineConfig } from '@farmfe/core'
import electron from '@farmfe/js-plugin-electron'

import { defineConfig } from '@farmfe/core'
import electron from './farm-plugin-electron'

export default defineConfig({
  plugins: [
    electron({
      main: {
        input: 'electron/main.ts',
      },
      preload: {
        input: 'electron/preload.ts',
      },
    }),
  ],
})

Options

Type:

import type { UserConfig } from '@farmfe/core'

export interface BuildOptions {
  /**
   * Shortcut of `compilation.input`
   */
  input: string | Record<string, string>
  farm?: UserConfig
}

export interface ElectronPluginOptions {
  main: BuildOptions
  preload?: BuildOptions
}