From bb23e1b7005ab98ff5c96dc337c47e76be45ccdd Mon Sep 17 00:00:00 2001 From: neverland Date: Sun, 26 Jun 2022 17:15:11 +0800 Subject: [PATCH 1/2] feat(cli): add css.removeSourceFile config (#10750) --- packages/vant-cli/docs/config.md | 19 ++++++++++++++++++- packages/vant-cli/docs/config.zh-CN.md | 17 +++++++++++++++++ .../vant-cli/src/compiler/compile-style.ts | 11 +++++++++-- .../src/compiler/gen-component-style.ts | 5 ++++- 4 files changed, 48 insertions(+), 4 deletions(-) diff --git a/packages/vant-cli/docs/config.md b/packages/vant-cli/docs/config.md index 84604f7dc..fe67cb5be 100644 --- a/packages/vant-cli/docs/config.md +++ b/packages/vant-cli/docs/config.md @@ -103,7 +103,7 @@ module.exports = { - Type: `string` - Default: `'less'` -CSS preprocess Config, support `less` and `sass`. Use `less` by default. +CSS preprocessor config, support `less` and `sass`. Use `less` by default. ```js module.exports = { @@ -115,6 +115,23 @@ module.exports = { }; ``` +### build.css.removeSourceFile + +- Type: `boolean` +- Default: `'false'` + +Whether to remove the source style files after build. + +```js +module.exports = { + build: { + css: { + removeSourceFile: true, + }, + }, +}; +``` + ### build.site.publicPath - Type: `string` diff --git a/packages/vant-cli/docs/config.zh-CN.md b/packages/vant-cli/docs/config.zh-CN.md index 24ece4b09..0c222dc7d 100644 --- a/packages/vant-cli/docs/config.zh-CN.md +++ b/packages/vant-cli/docs/config.zh-CN.md @@ -115,6 +115,23 @@ module.exports = { }; ``` +### build.css.removeSourceFile + +- Type: `boolean` +- Default: `'false'` + +是否在构建后移除样式文件的源代码。 + +```js +module.exports = { + build: { + css: { + removeSourceFile: true, + }, + }, +}; +``` + ### build.site.publicPath - Type: `string` diff --git a/packages/vant-cli/src/compiler/compile-style.ts b/packages/vant-cli/src/compiler/compile-style.ts index 7e21570bb..bf5a64e24 100644 --- a/packages/vant-cli/src/compiler/compile-style.ts +++ b/packages/vant-cli/src/compiler/compile-style.ts @@ -1,11 +1,13 @@ import { parse } from 'path'; -import { readFileSync, writeFileSync } from 'fs'; -import { replaceExt } from '../common/index.js'; +import fse from 'fs-extra'; +import { getVantConfig, replaceExt } from '../common/index.js'; import { compileCss } from './compile-css.js'; import { compileLess } from './compile-less.js'; import { compileSass } from './compile-sass.js'; import { consola } from '../common/logger.js'; +const { readFileSync, writeFileSync, removeSync } = fse; + async function compileFile(filePath: string) { const parsedPath = parse(filePath); @@ -30,6 +32,11 @@ async function compileFile(filePath: string) { export async function compileStyle(filePath: string) { const css = await compileFile(filePath); + const vantConfig = getVantConfig(); + + if (vantConfig.build?.css?.removeSourceFile) { + removeSync(filePath); + } writeFileSync(replaceExt(filePath, '.css'), css); } diff --git a/packages/vant-cli/src/compiler/gen-component-style.ts b/packages/vant-cli/src/compiler/gen-component-style.ts index 60516f150..b098b0630 100644 --- a/packages/vant-cli/src/compiler/gen-component-style.ts +++ b/packages/vant-cli/src/compiler/gen-component-style.ts @@ -12,6 +12,7 @@ import { ES_DIR, SRC_DIR, LIB_DIR, + getVantConfig, STYLE_DEPS_JSON_FILE, } from '../common/constant.js'; @@ -87,8 +88,10 @@ export function genComponentStyle( delete require.cache[STYLE_DEPS_JSON_FILE]; } + const vantConfig = getVantConfig(); const components = getComponents(); const baseFile = getCssBaseFile(); + const hasSourceFile = vantConfig.build?.css?.removeSourceFile !== true; components.forEach((component) => { genEntry({ @@ -98,7 +101,7 @@ export function genComponentStyle( ext: '.css', }); - if (CSS_LANG !== 'css') { + if (CSS_LANG !== 'css' && hasSourceFile) { genEntry({ baseFile, component, From 293dab6a51f1eb16498e8308516ba9d850fb4ca7 Mon Sep 17 00:00:00 2001 From: neverland Date: Sun, 26 Jun 2022 21:42:28 +0800 Subject: [PATCH 2/2] feat(cli): add build.bundleOptions config (#10751) --- packages/vant-cli/docs/config.md | 39 +++++++++++++++ packages/vant-cli/docs/config.zh-CN.md | 39 +++++++++++++++ .../vant-cli/src/compiler/compile-bundles.ts | 47 +++++++++---------- packages/vant-cli/src/config/vite.package.ts | 13 ++--- 4 files changed, 106 insertions(+), 32 deletions(-) diff --git a/packages/vant-cli/docs/config.md b/packages/vant-cli/docs/config.md index fe67cb5be..f364651f8 100644 --- a/packages/vant-cli/docs/config.md +++ b/packages/vant-cli/docs/config.md @@ -221,6 +221,45 @@ module.exports = { `npm` package manager. +### build.bundleOptions + +- Type: `BundleOptions[]` + +Specify the format of the bundled output. + +The type of `BundleOptions`: + +```ts +type BundleOption = { + // Whether to minify code (Tips: es format output can't be minified by vite) + minify?: boolean; + // Formats, can be set to 'es' | 'cjs' | 'umd' | 'iife' + formats: LibraryFormats[]; + // Dependencies to external (Vue is externaled by default) + external?: string[]; +}; +``` + +Default value： + +```ts +const DEFAULT_OPTIONS: BundleOption[] = [ + { + minify: false, + formats: ['umd'], + }, + { + minify: true, + formats: ['umd'], + }, + { + minify: false, + formats: ['es', 'cjs'], + external: allDependencies, + }, +]; +``` + ### site.title - Type: `string` diff --git a/packages/vant-cli/docs/config.zh-CN.md b/packages/vant-cli/docs/config.zh-CN.md index 0c222dc7d..e8e22a532 100644 --- a/packages/vant-cli/docs/config.zh-CN.md +++ b/packages/vant-cli/docs/config.zh-CN.md @@ -223,6 +223,45 @@ module.exports = { 指定使用的包管理器。 +### build.bundleOptions + +- Type: `BundleOptions[]` + +指定打包后产物的格式。 + +产物格式由三个配置项控制： + +```ts +type BundleOption = { + // 是否压缩代码（注意 es 产物无法被 vite 压缩） + minify?: boolean; + // 产物类型，可选值为 'es' | 'cjs' | 'umd' | 'iife' + formats: LibraryFormats[]; + // 需要 external 的依赖（Vue 默认会被 external） + external?: string[]; +}; +``` + +该选项的默认值为： + +```ts +const DEFAULT_OPTIONS: BundleOption[] = [ + { + minify: false, + formats: ['umd'], + }, + { + minify: true, + formats: ['umd'], + }, + { + minify: false, + formats: ['es', 'cjs'], + external: allDependencies, + }, +]; +``` + ### site.title - Type: `string` diff --git a/packages/vant-cli/src/compiler/compile-bundles.ts b/packages/vant-cli/src/compiler/compile-bundles.ts index a8bc96b65..ef0894175 100644 --- a/packages/vant-cli/src/compiler/compile-bundles.ts +++ b/packages/vant-cli/src/compiler/compile-bundles.ts @@ -1,42 +1,41 @@ import { build } from 'vite'; -import { getPackageJson } from '../common/constant.js'; +import { getPackageJson, getVantConfig } from '../common/constant.js'; import { mergeCustomViteConfig } from '../common/index.js'; import { getViteConfigForPackage } from '../config/vite.package.js'; +import type { LibraryFormats } from 'vite'; + +export type BundleOption = { + minify?: boolean; + formats: LibraryFormats[]; + external?: string[]; +}; export async function compileBundles() { const dependencies = getPackageJson().dependencies || {}; - const externals = Object.keys(dependencies); + const external = Object.keys(dependencies); - const configs = [ - // umd bundle - getViteConfigForPackage({ + const DEFAULT_OPTIONS: BundleOption[] = [ + { minify: false, formats: ['umd'], - external: ['vue'], - }), - // umd bundle (minified) - getViteConfigForPackage({ + }, + { minify: true, formats: ['umd'], - external: ['vue'], - }), - // esm/cjs bundle - getViteConfigForPackage({ + }, + { minify: false, formats: ['es', 'cjs'], - external: ['vue', ...externals], - }), - // esm/cjs bundle (minified) - // vite will not minify es bundle - // see: https://github.com/vuejs/vue-next/issues/2860 - getViteConfigForPackage({ - minify: true, - formats: ['es', 'cjs'], - external: ['vue', ...externals], - }), + external, + }, ]; + const bundleOptions: BundleOption[] = + getVantConfig().build?.bundleOptions || DEFAULT_OPTIONS; + await Promise.all( - configs.map((config) => build(mergeCustomViteConfig(config))) + bundleOptions.map((config) => + build(mergeCustomViteConfig(getViteConfigForPackage(config))) + ) ); } diff --git a/packages/vant-cli/src/config/vite.package.ts b/packages/vant-cli/src/config/vite.package.ts index 4d6f35469..467416e84 100644 --- a/packages/vant-cli/src/config/vite.package.ts +++ b/packages/vant-cli/src/config/vite.package.ts @@ -1,17 +1,14 @@ import { join } from 'path'; import { setBuildTarget } from '../common/index.js'; import { CWD, ES_DIR, getVantConfig, LIB_DIR } from '../common/constant.js'; -import type { InlineConfig, LibraryFormats } from 'vite'; +import type { InlineConfig } from 'vite'; +import type { BundleOption } from '../compiler/compile-bundles.js'; export function getViteConfigForPackage({ minify, formats, - external, -}: { - minify: boolean; - formats: LibraryFormats[]; - external: string[]; -}): InlineConfig { + external = [], +}: BundleOption): InlineConfig { setBuildTarget('package'); const { name, build } = getVantConfig(); @@ -36,7 +33,7 @@ export function getViteConfigForPackage({ // terser has better compression than esbuild minify: minify ? 'terser' : false, rollupOptions: { - external, + external: [...external, 'vue'], output: { dir: LIB_DIR, exports: 'named',