• English
  • Concepts

    Short definitions used across the docs.

    Product

    Rselectron coordinates development and source builds for Electron apps on Rsbuild / Rspack.

    Application model

    TermMeaning
    Application rootDirectory used to resolve sources, outputs, and the default package manifest
    Application manifestPackage manifest for the Electron app (default: package.json at the application root)
    Electron entryFile Electron launches; package.json#main unless overridden by config
    Project-local ElectronElectron install resolved from the application root — authority for launch and target derivation
    RoleOne of three independently configured source-build responsibilities: Main, Preload, or Renderer
    Role configurationFull Rsbuild config for one Role, plus Rselectron-owned electron options for that Role
    Application Electron optionsTop-level electron fields for launch and discovery (not per-Role build behavior)
    Source buildCompiling configured Roles into Electron-consumable files — not an installer

    Multiple pages belong to a single Renderer Role. Windows and pages are not separate Rselectron config objects.

    Development lifecycle

    TermMeaning
    Development sessionCoordinated lifetime of Role builders, the renderer dev server, and the Electron child process
    Configuration generationOne evaluation of the Rselectron config and the Role instances created from it; a config change replaces the whole generation
    Role updateSuccessful rebuild of a watched Main or Preload Role (Main restarts Electron; Preload asks renderers to fully reload)
    Renderer-only sessionServes Renderer while reusing previously built Main / Preload outputs

    Configuration vocabulary

    TermMeaning
    CommandExplicit operation: Dev, Build, Preview, or Inspect
    Build modeRsbuild compilation mode (development / production / none)
    Environment modeIndependent environment-file namespace — does not choose build mode

    Examples vs fixtures

    KindLocationUse
    Learning examplesexamples/vanilla, examples/reactCopy and learn from

    Where to go next