Skip to content

Latest commit

Β 

History

History
453 lines (323 loc) Β· 12.7 KB

CHANGELOG.md

File metadata and controls

453 lines (323 loc) Β· 12.7 KB
Raw

0.11.2 (2022-04-15)

  • b033bc5 v0.11.2
  • 8190208 docs: typo
  • 111d495 refactor(πŸ”¨): better build logic
  • 76611a9 fix: disable browserField by default #136
  • 241534f feat: add .npmrc for pnpm
  • 65d4ab1 chore: bump deps
  • b4308e3 chore: rename
  • 036e52c docs: update
  • a222c48 examples: update quick-start
  • d04155c examples: add javascript-api
  • 9213ba0 docs: update
  • 9b8da83 fix: cannot find type definition #126
  • e864b81 examples: update multiple-window, add multiple-renderer
  • 0a226b5 docs: update
  • ff5e9dc feat: add logo.svg
  • 7cec6ad examples: add multiple-windows
  • f8528ed Merge pull request #123 from xhayper/patch-1
  • 1e9f9b0 feat: remove extra dependencies
  • 8fa6ce4 feat: update package and example
  • 1d7eca5 feat: add test 🌱
  • 9ef3e8e chore: bump deps
  • 56446e2 chore: cleanup

0.11.1 (2022-12-19)

  • 2bf7d0b docs: startup()
  • 401a44e refactor: cleanup

0.11.0 (2022-12-17)

Break!

// 0.10.0
function build(config: Configuration | Configuration[]): Promise<void>

// 0.11.0 - Same as Vite's build
function build(config: Configuration): Promise<RollupOutput | RollupOutput[] | RollupWatcher>

Features

JavaScript API

vite-plugin-electron's JavaScript APIs are fully typed, and it's recommended to use TypeScript or enable JS type checking in VS Code to leverage the intellisense and validation.

  • Configuration - type
  • defineConfig - function
  • resolveViteConfig - function, Resolve the default Vite's InlineConfig for build Electron-Main
  • withExternalBuiltins - function
  • build - function
  • startup - function

Example:

build(
  withExternalBuiltins( // external Node.js builtin modules
    resolveViteConfig( // with default config
      {
        entry: 'foo.ts',
        vite: {
          mode: 'foo-mode', // for .env file
          plugins: [{
            name: 'plugin-build-done',
            closeBundle() {
              // Startup Electron App
              startup()
            },
          }],
        },
      }
    )
  )
)

V8 Bytecode support πŸ‘‰ bytecode

Inspired by:

Commit/PR

  • Support Vite4.x | #118, 28d38b6
  • Bytecode example | df170c2
  • JavaScript API docs | 3049169
  • Fix load .env | 758695d
  • Refactor build() | d9c3343

0.10.4 (2022-11-13)

  • e4f943f refactor: move build.resolve to resolve
  • 91fb525 docs(zh-CN): update | @ggdream
  • 41db615 Use mode from source config. | #105, #106

0.10.3 (2022-11-10)

  • 0b24909 refactor: cleanup, provides some programmable APIs 🌱
  • 58517d8 refactor(proj-struct): remove vite-plugin-electron-renderer
  • d2b3c29 Merge pull request #98 from skyrpex/patch-1
  • 1645be2 fix: ignore the browser field when bundling

0.10.2 (2022-10-24)

By default, the dist folder will be automatically removed by Vite. We build Electron related files into dist-electron to prevent it from being removed by mistake

  1. Remove Vite 3.2.0 | #90
  2. ad9bb3c refactor(electron-renderer)!: remove options.resolve(), use 'lib-esm' for resolve Node.js modules and electron | vite-plugin-electron-renderer
  3. b500039 feat(electron-renderer): support optimizeDeps for Electron-Renderer πŸš€
  4. f28e66b faet(outDir)!: dist/electron -> dist-electron | vite-plugin-electron

0.10.1 (2022-10-12)

  • 59a24df fix(electron-renderer): use createRequire() instead of import() 🐞
  • 11cd4c3 feat(electron): onstart provides reload()

0.10.0 (2022-10-09)

Break!

This is a redesigned version of the API(Only 3 APIs). Not compatible with previous versions!

export type Configuration = {
  /**
   * Shortcut of `build.lib.entry`
   */
  entry?: import('vite').LibraryOptions['entry']
  /**
   * Triggered when Vite is built.  
   * If passed this parameter will not automatically start Electron App.  
   * You can start Electron App through the `startup` function passed through the callback function.  
   */
  onstart?: (this: import('rollup').PluginContext, startup: (args?: string[]) => Promise<void>) => void
  vite?: import('vite').InlineConfig
}

In the past few weeks, some issues have been mentioned in many issues that cannot be solved amicably. So I refactored the API to avoid design flaws. But despite this, the new version will only be easier rather than harder.

For example, some common problems in the following issues.

Multiple entry files is not support #86

Thanks to [email protected]'s lib.entry supports multiple entries, which makes the configuration of the new version very simple. So the [email protected] requires Vite at least v3.2.0.

e.g.

import electron from 'vite-plugin-electron'

// In plugins option
electron({
  entry: [
    'electron/entry-1.ts',
    'electron/entry-2.ts',
  ],
})

// Or use configuration array
electron([
  {
    entry: [
      'electron/entry-1.ts',
      'electron/entry-2.ts',
    ],
  },
  {
    entry: 'foo/bar.ts',
  },
])

require is not defined #48, #87

vite-plugin-electron-renderer will change output.format to cjs format by default(This is because currently Electron@21 only supports CommonJs), which will cause the built code to use require to import modules, if the user nodeIntegration is not enabled in the Electron-Main process which causes the error require is not defined to be thrown.

[email protected] provides the nodeIntegration option. It is up to the user to decide whether to use Node.js(CommonJs).

e.g.

import renderer from 'vite-plugin-electron-renderer'

// In plugins option
renderer({
  nodeIntegration: true,
})

Use Worker in Electron-Main or Electron-Renderer #77, #81

You can see πŸ‘‰ examples/worker

  • Use Worker in Electron-Main

    e.g. This looks the same as multiple entry

    import electron from 'vite-plugin-electron'

// In plugins option
electron({
  entry: [
    'electron/main.ts',
    'electron/worker.ts',
  ],
})

// In electron/main.ts
new Worker(path.join(__dirname, './worker.js'))

  • Use Worker in Electron-Renderer

    e.g.

    import renderer, { worker } from 'vite-plugin-electron-renderer'

export default {
  plugins: [
    renderer({
      // If you need use Node.js in Electron-Renderer process
      nodeIntegration: true,
    }),
  ],
  worker: {
    plugins: [
      worker({
        // If you need use Node.js in Worker
        nodeIntegrationInWorker: true,
      }),
    ],
  },
}

TODO

  • There is no way to differentiate between Preload-Scripts, which will cause the entire Electron App to restart after the preload update, not the Electron-Renderer reload.

PR

electron-vite#89

0.9.3 (2022-09-10)

vite-plugin-electron

vite-plugin-electron-renderer

  • 191afb8 feat: proxy ipcRenderer in Worker | #69

0.9.2 (2022-08-29)

vite-plugin-electron

  • 715a1cd fix(electron): VITE_DEV_SERVER_HOSTNAME instead VITE_DEV_SERVER_HOST

vite-plugin-electron-renderer

0.9.1 (2022-08-24)

vite-plugin-electron

  • db61e49 feat(electron): support custom start 🌱 | #57, #58

vite-plugin-electron-renderer

0.9.0 (2022-08-12)

πŸŽ‰ v0.9.0 is a stable version based on [email protected]

vite-plugin-electron

vite-plugin-electron-renderer

[2022-08-11] v0.8.8

sync vite-plugin-electron-renderer version

[2022-08-10] v0.8.7

70a8c6e fix: electron-vite/electron-vite-vue#229

[2022-08-08] v0.8.6

ESM -> CJS

[2022-08-08] v0.8.5

PR: #51

  1. feat: add VITE_DEV_SERVER_URL to electron process env, so that it is easier to use

  2. fix(🐞): VITE_DEV_SERVER_HOSTNAME cannot be used directly when VITE_DEV_SERVER_HOSTNAME is a ipv6 address or vite config server.host is true

  3. fix(🐞): use vite config mode as default build mode to avoid build mode not equal to vite config mode when vite config mode !== 'development' which would lead to render env not equal to electron main or preload

  4. fix(🐞): build electron output after render to avoid the electron output being deleted when the vite config emptyOutDir is true and the vite command is build

  5. fix(🐞): use closeBundle to replace writeBundle, because in extreme cases, an error will be reported. For example, can't find preload module will occur as an error when preload update frequently

[2022-07-31] v0.8.4

  • 🌱 c8b59ba Support envFile options electron-vite-vue/issues/209
  • 🌱 2d7f033 Add ImportMeta['env'] declaration
  • 🌱 20d0a22 Must use pnpm publish instead of npm publish #43

[2022-07-25] v0.8.2

  • 9ee720f chore(electron): remove envFile: false
  • 0016d52 fix(🐞): normalizePath()

[2022-07-21] v0.8.1

  • 33b121a chore(deps): hoist typescript
  • d3bd37a chore(electron): change import path

[2022-07-19] v0.8.0

  • 45f34d9 [email protected]
  • daa1c52 docs: [email protected]
  • e4e7ee0 chore: fix link
  • d1d4c82 chroe: bump deps
  • 581ef71 chore(deps): bump vite to 3.0.2
  • 481368a chore: remove unused def
  • 71d54c1 chore(🐞): update import path
  • 3bae8e5 refactor: checkPkgMain.buildElectronMainPlugin()
  • dba119d chore: format code
  • 739e659 feat: use checkPkgMain()
  • 192a8ca refactor: standlone checkPkgMain function
  • aaa9030 chore: explicitly specify external modules
  • 3eac722 chore: remove TODO
  • c03abe9 feat: add checkPkgMain() plugin
  • d8c0f8e chore: rename param
  • 04c94dd feat: checkPkgMain()
  • 7b9631a deps: add rollup
  • cec6db6 deps(🐞): add rollup for import InputOption
  • a4de86e monorepo: move vite-plugin-electron to packages/electron

[2022-07-11] v0.7.5

  • 1ed6e19 chore: bump vite-plugin-electron-renderer to v0.5.7

[2022-07-11] v0.7.4

  • c60fb17 chore: update params
  • 13f0c70 chore: bump vite-plugin-electron-renderer to 0.5.6

[2022-07-10] v0.7.3

  • 2033256 chore: bump deps

[2022-07-07] v0.7.2

  • 8fb064e fix(🐞): bump vite-plugin-electron-renderer to 0.5.3
  • 44006b2 chore: comments

[2022-07-07] v0.7.1

  • 42acf37 docs: update
  • 6d878f7 refactor: use resolveModules()
  • acf1751 chore: bump deps

[2022-07-06] v0.7.0

  • 661a146 docs: v0.7.0
  • 8ee091d feat: support restart on vite.config.ts changed #24
  • ca15795 add electron-env.d.ts
  • 76863bb electron-env.d.ts
  • 3fbef04 refactor: optimize code
  • cc3c8c0 feat: resolveBuildConfig()
  • 50c3afe feat: resolveRuntime()
  • 1184dd3 node.js.ts -> config.ts

[2022-07-01] v0.6.2

  • 5779397 chore: bump vite-plugin-electron-renderer to 0.5.1
  • 2a2f77d docs: Put Node.js packages in dependencies

[2022-06-26] v0.6.1

  • 5b736fa bump vite-plugin-electron-renderer to 0.5.0
  • f70e030 fix(🐞): ensure always load into buildConfig()
  • 73ae8f2 docs: update

[2022-06-26] v0.6.0

  • 5204eca docs: v0.6.0
  • e885e54 feat: withExternal()
  • dee6d6a feat: CommonConfiguration
  • 55f9e11 node.js.ts
  • 83d0b8d remove README.zh-CN.md
  • 5f488b8 remove polyfille-exports
  • e118fbd remove renderer
  • 6e5761f refactor: integrate vite-plugin-electron-renderer
  • 0e696ec add vite-plugin-electron-renderer
  • 87bc5bb remove vite-plugin-optimizer

[2022-06-25] v0.5.1

[2022-06-24] v0.5.0

  • 0c5155c chore: TODO
  • 892940e fix app,getName() return error name

[2022-06-14] v0.4.9

  • abf460f chore: variable rename
  • ceb559f chore: build.cssCodeSplit=false

[2022-06-08] v0.4.8

  • ab40088 fix(🐞): set emptyOutDir=false for prevent accidental deletion of files
  • 7baafa0 break: set electron build.outDir value is dist/electron by default
  • c13eb49 fix(🐞): assign default value dist/electron/[process] of build.outDir electron-vite#10

[2022-06-06] v0.4.7

  • 1346707 refactor: better assign default build.outDir
  • f489da1 chore: commnets
  • 6db3bf3 fix: check output is Array

[2022-06-04] v0.4.6

  • 394cf6f feat: config.build.emptyOutDir = false by default
  • 4a67688 feat(🐞): enabled polyfill-exports by default