@quiteer/electronup

@quiteer/electronup

融合构建 electron 应用需要的构建工具,保留原有配置习惯的命令行工具 开发中 ...

安装

npm i @quiteer/electronup

yarn add @quiteer/electronup

pnpm add @quiteer/electronup

使用

• 查看命令行指令
  • electornup -h
• 查看命令行版本
  • electornup -v
• 开发环境
  • electornup
  • electornup dev
  • electornup -c [file]
  • electornup --config [file]
• 构建打包
  • electornup build

内置的依赖

部分依赖已内置 无需重复安装 （开发此脚手架的目的也是给项目 package 瘦瘦身）

{
  "dependencies": {
    "@swc-node/core": "^1.9.1",
    "@swc/core": "^1.3.19",
    "@vitejs/plugin-vue": "^3.2.0",
    "cac": "^6.7.14",
    "dotenv": "^16.0.3",
    "electron": "^21.2.2",
    "electron-builder": "^23.6.0",
    "fs-extra": "^10.1.0",
    "inquirer": "^9.1.4",
    "neofetch": "^7.1.0",
    "pirates": "^4.0.5",
    "portfinder": "^1.0.32",
    "rimraf": "^3.0.2",
    "tsconfig-paths": "^4.1.0",
    "tsup": "^6.4.0",
    "typescript": "^4.9.3",
    "vite": "^3.2.3",
    "vue-tsc": "^1.0.9"
  }
}

暴露的api

import type { Configuration } from 'electron-builder'
import type { AliasOptions, PluginOption, ResolveOptions, UserConfig } from 'vite'
import type { Options } from 'tsup'

interface ViteConfig {
  base?: string
  root?: string
  outDir?: string
  publicDir?: string
  resolve?: ResolveOptions & {
    alias?: AliasOptions
  }
  plugins?: PluginOption[]
  viteOptions?: Omit<UserConfig, 'plugins' | 'resolve' | 'publicDir' | 'outDir' | 'build' | 'server'>
}

interface TsupConfig {
  entry?: string[] | Record<string, string>
  name?: string
  outDir?: string
  target?: string | string[]
  minify?: boolean
  external?: (string | RegExp)[]
  noExternal?: (string | RegExp)[]
}

interface BuilderConfig extends Configuration { }

type Platform = 'x64' | 'ia32' | 'armv7l' | 'arm64' | 'universal' | 'dir'

interface ElectronupConfig {
  viteConfig?: ViteConfig
  tsupConfig?: TsupConfig
  preloadTsup?: Options | Options[]
  builderConfig: BuilderConfig
  /**
   * 输出平台
   */
  outPlatform?: Platform | Platform[]
  /**
   * 渲染进程 主进程 输出目录
   * @default 'dist'
   */
  buildDir?: string
  /**
   * electron-builder 输出目录
   * @default 'out'
   */
  outDir?: string
}

interface ConfigEnv {
  command: 'build' | 'serve'
}

type ElectronupConfigFn = (env: ConfigEnv) => ElectronupConfig
type UserElectronupConfig = ElectronupConfig | ElectronupConfigFn

declare const defineConfig: (config: UserElectronupConfig) => UserElectronupConfig

export { BuilderConfig, ConfigEnv, ElectronupConfig, TsupConfig, ViteConfig, defineConfig }

获取类型提示

引入导出的 api 即可获取类型提示