create-packer 1.45.19 → 1.46.0

package/template/electron-vue/configs/config.ts

@@ -0,0 +1,25 @@
+import { ConfigParams } from '@rsbuild/core'
+import { pluginEslint } from '@rsbuild/plugin-eslint'
+import StylelintWebpackPlugin from 'stylelint-webpack-plugin'
+import { pluginTypeCheck } from '@rsbuild/plugin-type-check'
+import { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin'
+
+export function createPlugins({ command }: Pick<ConfigParams, 'command'>) {
+    return {
+        plugins: [
+            command !== 'build' && pluginTypeCheck(),
+            command !== 'build' &&
+                pluginEslint({
+                    eslintPluginOptions: {
+                        configType: 'flat'
+                    }
+                })
+        ],
+        rspackPlugin: [
+            new StylelintWebpackPlugin(),
+            process.env.RSDOCTOR && new RsdoctorRspackPlugin()
+        ]
+    }
+}
+
+export const OUTPUT_ROOT = 'dist'

package/template/electron-vue/configs/createChunks.ts

@@ -0,0 +1,26 @@
+import { SplitChunks } from '@rsbuild/core'
+
+export function createChunks(
+    chunks: Array<{ name: string; libs: string[] | RegExp; priority?: number }>
+) {
+    const result: Exclude<SplitChunks, false>['cacheGroups'] = {
+        vendors: {
+            test: /[\\/]node_modules[\\/]/,
+            chunks: 'all',
+            name: 'vendors',
+            priority: -1
+        }
+    }
+    chunks.forEach(({ name, libs, priority }) => {
+        result[name] = {
+            test: Array.isArray(libs)
+                ? new RegExp(`[\\\\/]node_modules[\\\\/](${libs.join('|')})[\\\\/]`)
+                : libs,
+            chunks: 'all',
+            name,
+            priority
+        }
+        return result
+    })
+    return result
+}

package/template/electron-vue/configs/rsbuild.main.config.ts

@@ -0,0 +1,54 @@
+import { defineConfig, loadEnv } from '@rsbuild/core'
+import { createPlugins, OUTPUT_ROOT } from './config'
+
+export default defineConfig(({ envMode, command }) => {
+    const { parsed: env } = loadEnv()
+    const { rspackPlugin, plugins } = createPlugins({ command })
+    return {
+        source: {
+            entry: {
+                main: './main/main.ts'
+            }
+        },
+        resolve: {
+            alias: {
+                '@': process.cwd()
+            }
+        },
+        output: {
+            distPath: { root: `${OUTPUT_ROOT}/main`, js: '' },
+            cleanDistPath: false,
+            filenameHash: false
+        },
+        dev: {
+            progressBar: command === 'build',
+            writeToDisk: true,
+            hmr: false,
+            liveReload: false
+        },
+        tools: {
+            htmlPlugin: false,
+            rspack: {
+                target: 'electron-main',
+                plugins: rspackPlugin
+            }
+        },
+        plugins,
+        performance: {
+            removeConsole: command === 'build' ? ['log'] : false,
+            bundleAnalyze: envMode === 'analyse' ? { openAnalyzer: true } : void 0
+        },
+        server: {
+            base: env.PUBLIC_BASE_URL,
+            host: '0.0.0.0',
+            port: 3001,
+            compress: false,
+            proxy: [
+                {
+                    context: [env.PUBLIC_API_HOST],
+                    target: 'http://127.0.0.1:3000'
+                }
+            ]
+        }
+    }
+})

package/template/electron-vue/configs/rsbuild.preload.config.ts

@@ -0,0 +1,54 @@
+import { defineConfig, loadEnv } from '@rsbuild/core'
+import { createPlugins, OUTPUT_ROOT } from './config'
+
+export default defineConfig(({ envMode, command }) => {
+    const { parsed: env } = loadEnv()
+    const { rspackPlugin, plugins } = createPlugins({ command })
+    return {
+        source: {
+            entry: {
+                preload: './preload/index.ts'
+            }
+        },
+        resolve: {
+            alias: {
+                '@': process.cwd()
+            }
+        },
+        output: {
+            distPath: { root: OUTPUT_ROOT, js: '' },
+            cleanDistPath: false,
+            filenameHash: false
+        },
+        dev: {
+            progressBar: command === 'build',
+            writeToDisk: true,
+            hmr: false,
+            liveReload: false
+        },
+        tools: {
+            htmlPlugin: false,
+            rspack: {
+                target: 'electron-preload',
+                plugins: rspackPlugin
+            }
+        },
+        plugins,
+        performance: {
+            removeConsole: command === 'build' ? ['log'] : false,
+            bundleAnalyze: envMode === 'analyse' ? { openAnalyzer: true } : void 0
+        },
+        server: {
+            base: env.PUBLIC_BASE_URL,
+            host: '0.0.0.0',
+            port: 3002,
+            compress: false,
+            proxy: [
+                {
+                    context: [env.PUBLIC_API_HOST],
+                    target: 'http://127.0.0.1:3000'
+                }
+            ]
+        }
+    }
+})

package/template/electron-vue/configs/rsbuild.renderer.config.ts

@@ -0,0 +1,64 @@
+import path from 'node:path'
+import { defineConfig, loadEnv } from '@rsbuild/core'
+import { pluginVue } from '@rsbuild/plugin-vue'
+import { createChunks } from './createChunks'
+import { createPlugins, OUTPUT_ROOT } from './config'
+
+export default defineConfig(({ envMode, command }) => {
+    const { parsed: env } = loadEnv()
+    const { rspackPlugin, plugins } = createPlugins({ command })
+    const resolveRendererPath = (p: string) => path.resolve('renderer', p)
+    return {
+        html: {
+            template: resolveRendererPath('index.html'),
+            title: 'Rsbuild + Vue + TS',
+            favicon: resolveRendererPath('shared/assets/vue.svg')
+        },
+        source: {
+            entry: {
+                index: resolveRendererPath('main.ts')
+            }
+        },
+        resolve: {
+            alias: {
+                '@': process.cwd()
+            }
+        },
+        output: {
+            distPath: { root: `${OUTPUT_ROOT}/renderer` },
+            assetPrefix: './',
+            cleanDistPath: false
+        },
+        dev: {
+            progressBar: command === 'build'
+        },
+        tools: {
+            rspack: {
+                plugins: rspackPlugin
+            }
+        },
+        plugins: [...plugins, pluginVue()],
+        performance: {
+            removeConsole: command === 'build' ? ['log'] : false,
+            chunkSplit: {
+                strategy: 'custom',
+                splitChunks: {
+                    minChunks: 1,
+                    cacheGroups: createChunks([{ libs: ['vue', 'vue-router'], name: 'vue' }])
+                }
+            },
+            bundleAnalyze: envMode === 'analyse' ? { openAnalyzer: true } : void 0
+        },
+        server: {
+            base: env.PUBLIC_BASE_URL,
+            host: '0.0.0.0',
+            compress: false,
+            proxy: [
+                {
+                    context: [env.PUBLIC_API_HOST],
+                    target: 'http://127.0.0.1:3000'
+                }
+            ]
+        }
+    }
+})

package/template/electron-vue/env.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="@rsbuild/core/types" />
+
+declare module '*.vue' {
+    import { type DefineComponent } from 'vue'
+    const component: DefineComponent<Record<string, any>, Record<string, any>, any>
+    export default component
+}
+
+interface ImportMetaEnv {
+    readonly PUBLIC_BASE_URL: string
+    readonly PUBLIC_API_HOST: string
+    readonly PUBLIC_ENV_MODE: 'production' | 'development'
+    // 更多环境变量...
+}
+
+interface ImportMeta {
+    readonly env: ImportMetaEnv
+}

package/template/electron-vue/eslint.config.mjs

@@ -0,0 +1,115 @@
+import eslint from '@eslint/js'
+import globals from 'globals'
+import tseslint from 'typescript-eslint'
+import importPlugin from 'eslint-plugin-import'
+import pluginVue from 'eslint-plugin-vue'
+
+const scriptExtensions = ['js', 'jsx', 'mjs', 'cjs', 'ts', 'tsx']
+const files = [...scriptExtensions.map(ext => `**/*.${ext}`), '**/*.vue']
+
+export default tseslint.config([
+    { ignores: ['**/node_modules/', 'dist/', '.history/', '.vscode'] },
+    eslint.configs.recommended,
+    importPlugin.flatConfigs.recommended,
+    tseslint.configs.recommended,
+    pluginVue.configs['flat/recommended'],
+    {
+        files,
+        languageOptions: {
+            ecmaVersion: 2018,
+            sourceType: 'module',
+            parserOptions: {
+                ecmaFeatures: {
+                    jsx: true
+                },
+                useJSXTextNode: true,
+                parser: tseslint.parser
+            },
+            globals: {
+                ...globals.browser,
+                ...globals.node
+            }
+        },
+        settings: {
+            'import/resolver': {
+                typescript: true,
+                node: true
+            }
+        },
+        rules: {
+            'import/export': 'off',
+            'import/namespace': 'off',
+            'import/default': 'off',
+            'import/consistent-type-specifier-style': ['error', 'prefer-inline'],
+            'import/no-duplicates': ['error', { 'prefer-inline': true }],
+            'import/no-named-as-default-member': 'off',
+            'import/no-named-as-default': 'off',
+            'import/order': [
+                'error',
+                {
+                    groups: [
+                        'builtin',
+                        'external',
+                        'internal',
+                        'parent',
+                        'sibling',
+                        'index',
+                        'object',
+                        'type'
+                    ],
+                    pathGroups: [
+                        { pattern: 'vue', group: 'external', position: 'before' },
+                        { pattern: 'vue-router', group: 'external', position: 'before' }
+                    ],
+                    pathGroupsExcludedImportTypes: ['builtin']
+                }
+            ],
+            'no-case-declarations': 'off',
+            '@typescript-eslint/no-unused-expressions': 'off',
+            '@typescript-eslint/no-empty-object-type': 'off',
+            '@typescript-eslint/no-var-requires': 0,
+            '@typescript-eslint/explicit-function-return-type': 'off',
+            '@typescript-eslint/no-explicit-any': 0,
+            '@typescript-eslint/no-non-null-assertion': 'off',
+            '@typescript-eslint/no-inferrable-types': [
+                'warn',
+                {
+                    ignoreParameters: true
+                }
+            ],
+            '@typescript-eslint/no-unused-vars': [
+                'warn',
+                {
+                    argsIgnorePattern: '^_'
+                }
+            ],
+            '@typescript-eslint/member-delimiter-style': 0,
+            '@typescript-eslint/class-name-casing': 0,
+            '@typescript-eslint/explicit-module-boundary-types': 'off',
+            '@typescript-eslint/ban-ts-comment': 'off',
+            '@typescript-eslint/no-empty-interface': 'off',
+            '@typescript-eslint/triple-slash-reference': 'off',
+            "@typescript-eslint/no-require-imports": 'off',
+            'vue/multi-word-component-names': 0,
+            'vue/html-indent': ['error', 4],
+            'vue/require-default-prop': 'off',
+            'vue/one-component-per-file': 'off',
+            'vue/no-dupe-keys': 'off',
+            'vue/html-self-closing': [
+                'error',
+                {
+                    html: {
+                        void: 'always',
+                        normal: 'always',
+                        component: 'always'
+                    },
+                    svg: 'always',
+                    math: 'always'
+                }
+            ],
+            'vue/max-attributes-per-line': 'off',
+            'vue/singleline-html-element-content-newline': 'off',
+            'no-constant-condition': 'off'
+        }
+    }
+])

package/template/electron-vue/main/main.ts

@@ -0,0 +1,83 @@
+import path from 'path'
+import { app, BrowserWindow, shell, ipcMain } from 'electron'
+import { resolveHtmlPath } from './tools'
+
+let mainWindow: BrowserWindow | null = null
+
+ipcMain.on('ipc-example', async (event, arg) => {
+    const msgTemplate = (pingPong: string) => `IPC test: ${pingPong}`
+    console.log(msgTemplate(arg))
+    event.reply('ipc-example', msgTemplate('pong'))
+})
+
+const isDebug = process.env.NODE_ENV === 'development' || process.env.DEBUG_PROD === 'true'
+
+if (true) {
+    require('electron-debug').default()
+}
+
+const createWindow = async () => {
+    const RESOURCES_PATH = app.isPackaged
+        ? path.join(process.resourcesPath, 'assets')
+        : path.join(__dirname, '../../assets')
+
+    const getAssetPath = (...paths: string[]): string => {
+        return path.join(RESOURCES_PATH, ...paths)
+    }
+
+    mainWindow = new BrowserWindow({
+        show: false,
+        width: 1024,
+        height: 728,
+        icon: getAssetPath('icon.png'),
+        webPreferences: {
+            preload: path.join(__dirname, '../preload.js')
+        }
+    })
+
+    mainWindow.loadURL(resolveHtmlPath('index.html'))
+
+    mainWindow.on('ready-to-show', () => {
+        if (!mainWindow) {
+            throw new Error('"mainWindow" is not defined')
+        }
+        if (process.env.START_MINIMIZED) {
+            mainWindow.minimize()
+        } else {
+            mainWindow.show()
+        }
+    })
+
+    mainWindow.on('closed', () => {
+        mainWindow = null
+    })
+
+    // Open urls in the user's browser
+    mainWindow.webContents.setWindowOpenHandler(edata => {
+        shell.openExternal(edata.url)
+        return { action: 'deny' }
+    })
+}
+
+/**
+ * Add event listeners...
+ */
+
+app.on('window-all-closed', () => {
+    // Respect the OSX convention of having the application in memory even
+    // after all windows have been closed
+    if (process.platform !== 'darwin') {
+        app.quit()
+    }
+})
+
+app.whenReady()
+    .then(() => {
+        createWindow()
+        app.on('activate', () => {
+            // On macOS it's common to re-create a window in the app when the
+            // dock icon is clicked and there are no other windows open.
+            if (mainWindow === null) createWindow()
+        })
+    })
+    .catch(console.log)

package/template/electron-vue/main/tools/html.ts

@@ -0,0 +1,8 @@
+import path from 'path'
+
+export function resolveHtmlPath(htmlFileName: string) {
+    if (process.env.NODE_ENV === 'development') {
+        return `http://localhost:3000`
+    }
+    return `file://${path.resolve(__dirname, '../renderer/', htmlFileName)}`
+}

package/template/electron-vue/main/tools/index.ts

@@ -0,0 +1 @@
+export * from './html'

package/template/electron-vue/package.json

@@ -0,0 +1,87 @@
+{
+    "name": "renderer",
+    "private": true,
+    "version": "0.0.0",
+    "main": "dist/main/main.js",
+    "scripts": {
+        "prepare": "husky",
+        "start": "electron .",
+        "dev": "pnpm clean && concurrently \"pnpm dev:preload\"  \"pnpm dev:renderer\" \"pnpm dev:main\"",
+        "dev:renderer": "rsbuild dev -c ./configs/rsbuild.renderer.config.ts",
+        "dev:preload": "rsbuild dev -c ./configs/rsbuild.preload.config.ts",
+        "dev:main": "rsbuild dev -c ./configs/rsbuild.main.config.ts",
+        "build": "pnpm clean && pnpm build:preload && pnpm build:renderer && pnpm build:main",
+        "build:renderer": "rsbuild build -c ./configs/rsbuild.renderer.config.ts",
+        "build:preload": "rsbuild build -c ./configs/rsbuild.preload.config.ts",
+        "build:main": "rsbuild build -c ./configs/rsbuild.main.config.ts",
+        "build:analyse": "rsbuild build --env-mode analyse",
+        "build:rsdoctor": "cross-env RSDOCTOR=true rsbuild build",
+        "package": "rimraf build && electron-builder -c ./build.config.js",
+        "clean": "rimraf dist",
+        "preview": "rsbuild preview",
+        "up:rsbuild": "pnpm up @rsbuild/* -L",
+        "format": "prettier --   \"**/*.{vue,ts,js,tsx,jsx,json,css,scss,less}\"",
+        "lint": "vue-tsc --noEmit && eslint --no-error-on-unmatched-pattern && stylelint **/*.{css,scss,less}",
+        "lint:fix": "eslint --fix && stylelint **/*.{css,scss,less} --fix",
+        "cz": "cz",
+        "push": "npm run commit && git push",
+        "commit": "git add . && npm run cz",
+        "up:vite": "pnpm up vite @vitejs/* vite-plugin-* -L"
+    },
+    "dependencies": {
+        "axios": "1.7.9",
+        "electron-debug": "4.1.0",
+        "es-toolkit": "1.39.8",
+        "pinia": "3.0.3",
+        "tailwindcss": "4.1.4",
+        "type-fest": "4.33.0",
+        "vue": "3.5.20",
+        "vue-router": "4.5.1"
+    },
+    "devDependencies": {
+        "@commitlint/cli": "17.6.1",
+        "@commitlint/config-conventional": "17.6.1",
+        "@commitlint/cz-commitlint": "17.5.0",
+        "@eslint/js": "9.15.0",
+        "@faker-js/faker": "8.4.1",
+        "@rsbuild/core": "1.5.10",
+        "@rsbuild/plugin-eslint": "1.1.2",
+        "@rsbuild/plugin-type-check": "1.2.4",
+        "@rsbuild/plugin-vue": "1.1.2",
+        "@rsdoctor/rspack-plugin": "1.2.3",
+        "@tailwindcss/postcss": "4.1.4",
+        "@types/mockjs": "1.0.10",
+        "autoprefixer": "10.4.14",
+        "commitizen": "4.3.0",
+        "concurrently": "9.2.1",
+        "cross-env": "7.0.3",
+        "cssnano": "6.0.0",
+        "electron": "38.1.2",
+        "electron-builder": "26.0.12",
+        "eslint": "9.17.0",
+        "eslint-import-resolver-typescript": "3.7.0",
+        "eslint-plugin-import": "2.31.0",
+        "eslint-plugin-vue": "9.32.0",
+        "globals": "15.12.0",
+        "husky": "9.1.6",
+        "inquirer": "8.1.2",
+        "postcss": "8.4.38",
+        "postcss-html": "1.8.0",
+        "postcss-import": "16.1.0",
+        "postcss-nesting": "12.1.1",
+        "prettier": "3.2.5",
+        "rimraf": "6.0.1",
+        "rollup-plugin-visualizer": "5.12.0",
+        "stylelint": "16.10.0",
+        "stylelint-config-standard-scss": "13.1.0",
+        "stylelint-webpack-plugin": "5.0.0",
+        "typescript": "5.8.2",
+        "typescript-eslint": "8.15.0",
+        "vue-tsc": "3.0.6"
+    },
+    "config": {
+        "commitizen": {
+            "path": "@commitlint/cz-commitlint"
+        }
+    }
+}