electronup 0.0.9 → 0.1.0

package/README.md

@@ -1,346 +1,48 @@
 # electronup
+[![license](https://img.shields.io/badge/license-MIT-green.svg)](./LICENSE) ![](https://img.shields.io/github/stars/QuiteerJs/electronup) ![](https://img.shields.io/github/forks/QuiteerJs/electronup)
 
+> electronup 是一个集成 Vite4.x、tsup6.x、electron-builder24.x 的桌面端构建工具，一个配置文件完成多环境多目标的构建包。
 
-> 融合构建 electron 应用需要的构建工具,保留原有配置习惯的命令行工具
-
-
-
-## 插件前置
-
-```json
-{
-  "peerDependencies": {
-    "@types/node": ">= 16",
-    "electron": ">= 20",
-    "vue": ">= 3"
-  }
-}
-```
+## 文档地址
 
+文档地址 ：https://quiteerjs.github.io/electronup
 
 ## 安装
 
 ```bash
-npm i @quiteer/electronup -D
+npm install electronup -D
 ```
 
 ```bash
-yarn add @quiteer/electronup -D
+yarn add electronup -D
 ```
 
 ```bash
-pnpm add @quiteer/electronup -D
-```
-
-
-## 使用
-
-- 查看命令行指令
-
-  - `electornup -h`
-
-  - `electornup build -h`
-
-
-- 查看命令行版本
-
-  - `electornup -v`
-
-
-- 开发环境
-
-  - `electornup`
-
-  - `electornup dev`
-
-  - 指定配置文件 `electornup [config file]`
-
-  - 指定配置文件 `electornup dev [config file]`
-
-
-- 构建打包
-
-  - `electornup build`
-
-  - 指定配置文件 `electornup build [config file]`
-
-  - 开启选项式构建 `electornup build -o` 或 `electornup build --option`
-
-  - 输出选项默认当前平台架构
-
-  - 指定平台 `--win` ,`--mac` ,`--linux`
-
-  - 指定架构 `--ia32` ,`--x64` ,`--arm64`
-
-  - 可不指定平台架构版本， 默认为本机当前平台架构版本
-
-## 内置的依赖
-
-> 部分依赖已内置 无需重复安装 （开发此脚手架的目的也是给项目 package 瘦瘦身）
-
-```json
-{
-  "dependencies": {
-    "@quiteer/parser-config": "^1.0.3",
-    "cac": "^6.7.14",
-    "dotenv": "^16.0.3",
-    "electron-builder": "^23.6.0",
-    "fs-extra": "^10.1.0",
-    "inquirer": "8.2.5",
-    "portfinder": "^1.0.32",
-    "rimraf": "^3.0.2",
-    "tsup": "^6.7.0",
-    "typescript": "^5.0.4",
-    "vite": "^4.4.9",
-    "yaml": "^2.2.1"
-  }
-}
+pnpm add electronup -D
 ```
 
-### cli配置项
-
-```ts
-import type { Configuration } from 'electron-builder'
-import type { AliasOptions, PluginOption, ResolveOptions, UserConfig } from 'vite'
-import type { Options } from 'tsup'
-
-interface ViteConfig {
-  resolve?: ResolveOptions & {
-    alias?: AliasOptions
-  }
-  plugins?: PluginOption[]
-  viteOptions?: Omit<UserConfig, 'plugins' | 'resolve' | 'publicDir'>
-}
-
-interface TsupConfig {
-  entry?: string[] | Record<string, string>
-  target?: string | string[]
-  minify?: boolean
-  external?: (string | RegExp)[]
-  noExternal?: (string | RegExp)[]
-}
-
-interface BuilderConfig extends Configuration { }
-
-interface ElectronupConfig {
-  viteConfig?: ViteConfig
-  tsupConfig?: TsupConfig
-  preloadTsup?: Options | Options[]
-  builderConfig: BuilderConfig
-
-  /**
-   * 渲染进程入口目录
-   * @default 'render'
-   */
-  renderDir?: string
-
-  /**
-   * 主进程入口目录
-   * @default 'main'
-   */
-  mainDir?: string
-
-  /**
-  * 静态资源目录
-  * @default 'public'
-  */
-  publicDir?: string
-
-  /**
-  * 动态库目录
-  * @default 'lib'
-  */
-  libDir?: string
-
-  /**
-  * 资源构建输出目录
-  * @default 'dist/resource'
-  */
-  resourceDir?: string
-
-  /**
-   * electron-builder 输出目录
-   * @default 'dist/out'
-   */
-  outDir?: string
-}
-
-interface ConfigEnv {
-  command: 'build' | 'serve'
-  root: string
-}
-
-type ElectronupConfigFn = (env: ConfigEnv) => ElectronupConfig
-type UserElectronupConfig = ElectronupConfig | ElectronupConfigFn
-
-declare const defineConfig: (config: UserElectronupConfig) => UserElectronupConfig
-
-export { BuilderConfig, ConfigEnv, ElectronupConfig, TsupConfig, ViteConfig, defineConfig }
-```
-
-#### 获取类型提示
-
-引入导出的 api 即可获取类型提示
-
-## 环境变量配置
-
-根目录下的 `.env` 文件在任何环境下都会注入到业务代码中
-
-### command
-
-目前 `command` 命令仅支持 `dev` 及 `build`
+## 特性
 
-`dev` 指令下向 `process.env` 中注入 `NODE_ENV` 字段 为 `develpoment`
+- **多框架支持** : 使用 `create-electronup` 询问式创建项目模板 , 内置 `vue3` ， `react` ，`solid` 等项目模板。
+- **Vite + tsup** : 双进程热更新 , 快速开发(主进程代码修改会触发软件重启)。
+- **统一的环境变量** : `dotenv` 加载 , 构建时注入 , 双进程拥有相同的环境变量。
+- **模式构建** : 默认识别当前代码运行的平台输出打包程序 。
+- **可选构建功能提示** : 你将获得可选范围内支持的功能提示 , 选项式自定义构建输出。
+- **TypeScript** : 应用程序级 `JavaScript` 的语言。
+- **集中管理路径** : 解决双进程资源路径的问题。
+- **预置配置** : 内置了很多可以覆盖的构建工具配置。
+- **单文件配置** : 只需一个 **electronup.config.ts** 即可管理项目的运行构建。
+- **多插件** : 作者会继续开发更多无副作用的独立插件，如：创建窗口，预加载，ipc通信，更新等等。
 
-`build` 指令下向 `process.env` 中注入 `NODE_ENV` 字段 为 `production`
+## 声明
 
-双进程下区分环境略有不同 ， 主进程代码中直接访问  `process.env` 上的  `NODE_ENV` 即可，渲染进程中访问 `vite` 提供的 `import.meta.env` 获取
+前提条件
+> 熟悉命令行
+> 已安装 16.0 或更高版本的 Node.js
 
-```typescript
-// main.ts
-// dev
-console.log('NODE_ENV', process.env.NODE_ENV)  // NODE_ENV development
 
-// build
-console.log('NODE_ENV', process.env.NODE_ENV)  // NODE_ENV production
-```
-
-```typescript
-// render.ts
-// dev
-console.log('isDev', import.meta.env.DEV)  // isDev true
-
-// build
-console.log('isDev', import.meta.env.DEV)  // isDev fasle
-```
-
-
-
-### mode
-
-通过添加命令行指令 `-m xxx | -mode xxx` 指定加载环境变量文件以满足不同环境下的不同环境变量。
-
-`mode` 指令传入的 `mode` 字符串需与根目录下的 `env` 文件一致。 规则如下
-
-```shell
-electronup -m test
-```
-
-命令行运行后根据 `mode` 参数加载根目录下的 `.env.test` 环境变量文件
-
-即 `electronup -m test`
-
-`.env`
-
-`.env.test`
-
- 不传 mode 参数，默认根据环境区分加载环境变量。
-
-`electronup dev`
-
-`.env`
-
-`.env.devlepoment`
-
-`electronup build`
-
-`.env`
-
-`.env.production`
-
-当然也可通过传入 mode 参数使 dev 环境加载 production 的环境变量。
-
-`electronup dev -m production`
-
-
-
-#### 文件命名
-
-`.env`
-
-`.env.development`
-
-`.env.production`
-
-`.env.test`
-
-`.env.staging`
-
-
-
-### 预置配置
-
-可自定义配置覆盖默认配置。
-
-#### vite
-
-- `base` :  `./`
-
-- `mode` :  `development` | `production`
-
-- `root` :  `render`
-
-- `publicDir` :  `public`
-
-- `server` :  `{ host: '0.0.0.0' }`
-
-- `build` :
-
-```ts
-{
-  outDir: 'dist',
-  target: 'esnext',
-  minify: true,
-  reportCompressedSize: false,
-  emptyOutDir: true
-}
- ```
-
-所有选项皆可通过 `viteOptions` 覆盖
-
-#### tsup配置选项
-
-- `external` :  `['electorn']`
-- `target` :  `node14`
-- `noExternal` :  `[]`
-
-##### 路径别名
-
-直接在项目中配置 `tsconfig.json` 的 `paths` 选项即可在主进程代码中使用路径别名。
-
-#### electron-builder
-
-可全部覆盖，默认配置如下：
-
-```typescript
-{
-  asar: true,
-  appId: 'org.quiteer.electronup',
-  productName: packages.name,
-  protocols: {
-    name: packages.name,
-    schemes: ['deeplink']
-  },
-  nsis: {
-    oneClick: false,
-    language: '2052',
-    perMachine: true,
-    allowElevation: true,
-    allowToChangeInstallationDirectory: true,
-    runAfterFinish: true,
-    createDesktopShortcut: true,
-    createStartMenuShortcut: true,
-    artifactName: `${packages.name} \${arch} Setup ${packages.version}.\${ext}`
-  },
-  files: [`${allConfig.resourceDir || DefaultDirs.resourceDir}/**/*`],
-  extraFiles: [allConfig.libDir || DefaultDirs.libDir],
-  directories: {
-    output: allConfig.outDir || config.directories?.output || DefaultDirs.outDir
-  },
-  // ...传入同名参数即可完成覆盖
-}
-```
+因为使用了 tsup 构建主进程代码，所以该命令行及脚手架只支持 TypeScript ，不支持 JavaScript。
 
 ## 示例
 
-> https://github.com/TaiAiAc/electron-quiet-monorepo/tree/main/experiment/electronup-test
+> https://github.com/QuiteerJs/electronup/tree/main/playground/electronup-test