Skip to content

Latest commit

 

History

History
405 lines (310 loc) · 7.95 KB

config.zh-CN.md

File metadata and controls

405 lines (310 loc) · 7.95 KB
Raw

配置指南

rsbuild.config.mjs

Vant CLI 使用 Rsbuild 来构建文档站点，你可以在 vant.config.mjs 的同级目录下创建 Rsbuild 的配置文件，文件内容会被 Vant CLI 自动读取。

// rsbuild.config.mjs 或 rsbuild.config.ts
export default {
  plugins: [
    // 配置 Rsbuild 插件
  ],
  dev: {
    // 与本地开发有关的选项
  },
  html: {
    // 与 HTML 生成有关的选项
  },
  // 其他选项
};

请参考 配置 Rsbuild 了解更多。

vite.config.mjs

Vant Cli 使用 Vite 来构建组件库代码，你可以在 vant.config.mjs 的同级目录下创建 Vite 的配置文件，在该文件中你可以添加任意的 Vite 配置。

请参考 Vite 配置 了解更多。

vant.config.mjs

vant.config.mjs 中包含了 vant-cli 的打包配置和文档站点配置，请创建此文件并置于项目根目录下。下面是一份基本配置的示例：

export default {
  // 组件库名称
  name: 'demo-ui',
  // 构建配置
  build: {
    site: {
      publicPath: '/demo-ui/',
    },
  },
  // 文档站点配置
  site: {
    // 标题
    title: 'Demo UI',
    // 图标
    logo: 'https://fastly.jsdelivr.net/npm/@vant/assets/logo.png',
    // 描述
    description: '示例组件库',
    // 左侧导航
    nav: [
      {
        title: '开发指南',
        items: [
          {
            path: 'home',
            title: '介绍',
          },
        ],
      },
      {
        title: '基础组件',
        items: [
          {
            path: 'my-button',
            title: 'MyButton 按钮',
          },
        ],
      },
    ],
  },
};

name

  • Type: string
  • Default: ''

组件库名称，建议使用中划线分割，如 demo-ui。

build.css.base

  • Type: string
  • Default: 'style/base.less'

全局样式文件的路径，可以为相对路径或绝对路径。

相对路径基于 src 目录计算。

module.exports = {
  build: {
    css: {
      base: 'style/global.scss',
    },
  },
};

build.css.preprocessor

  • Type: string
  • Default: 'less'

CSS 预处理器配置，目前支持 less 和 sass 两种预处理器，默认使用 less。

module.exports = {
  build: {
    css: {
      preprocessor: 'sass',
    },
  },
};

build.css.removeSourceFile

  • Type: boolean
  • Default: 'false'

是否在构建后移除样式文件的源代码。

module.exports = {
  build: {
    css: {
      removeSourceFile: true,
    },
  },
};

build.site.publicPath

  • Type: string
  • Default: /

等价于 vite 的 build.outDir 配置。

一般来说，我们的文档网站会部署在一个域名的子路径上，如 https://my.github.io/demo-ui/，这时候 publicPath 需要跟子路径保持一致，即 /demo-ui/。

module.exports = {
  build: {
    site: {
      publicPath: '/demo-ui/',
    },
  },
};

build.srcDir

  • Type: string
  • Default: src
module.exports = {
  build: {
    srcDir: 'myDir',
  },
};

build.namedExport

  • Type: boolean
  • Default: false

是否通过 Named Export 对组件进行导出。

未开启此选项时，会通过 export default from 'xxx' 导出组件内部的默认模块。

开启此选项后，会通过 export * from 'xxx' 导出组件内部的所有模块、类型定义。

build.packageManager

  • Type: 'npm' | 'yarn' | 'pnpm' | 'bun'
  • Default: yarn

指定使用的包管理器。

build.bundleOptions

  • Type: BundleOptions[]

指定打包后产物的格式。

产物格式由三个配置项控制：

type BundleOption = {
  // 是否压缩代码（注意 es 产物无法被 vite 压缩）
  minify?: boolean;
  // 产物类型，可选值为 'es' | 'cjs' | 'umd' | 'iife'
  formats: LibraryFormats[];
  // 需要 external 的依赖（Vue 默认会被 external）
  external?: string[];
};

该选项的默认值为：

const DEFAULT_OPTIONS: BundleOption[] = [
  {
    minify: false,
    formats: ['umd'],
  },
  {
    minify: true,
    formats: ['umd'],
  },
  {
    minify: false,
    formats: ['es', 'cjs'],
    external: allDependencies,
  },
];

site.title

  • Type: string
  • Default: ''

文档站点的标题。

site.logo

  • Type: string
  • Default: ''

文档站点的 Logo。

site.description

  • Type: string
  • Default: ''

标题下方的描述文案。

site.nav

  • Type: object[]
  • Default: undefined

文档站点的左侧导航，数组中的每个对象表示一个导航分组。

module.exports = {
  site: {
    nav: [
      {
        // 分组标题
        title: '开发指南',
        // 导航项
        items: [
          {
            // 导航项路由
            path: 'home',
            // 导航项文案
            title: '介绍',
            // 是否隐藏当前页右侧的手机模拟器（默认不隐藏）
            hideSimulator: true,
          },
        ],
      },
    ],
  },
};

site.versions

  • Type: object[]
  • Default: undefined

文档站点多版本配置，当组件库存在多个版本的文档时，可以通过site.versions在顶部导航配置一个版本切换按钮。

module.exports = {
  site: {
    versions: [
      {
        label: 'v1',
        link: 'https://vant-ui.github.io/vant/v1/',
      },
    ],
  },
};

site.baiduAnalytics

  • Type: object
  • Default: undefined

文档网站的百度统计配置，添加这项配置后，会自动在构建文档网站时加载百度统计的脚本。

module.exports = {
  site: {
    baiduAnalytics: {
      // 打开百度统计 ->『管理』->『代码获取』
      // 找到下面这串 URL: "https://hm.baidu.com/hm.js?xxxxx"
      // 将 `xxxxx` 填写在 seed 中即可
      seed: 'xxxxx',
    },
  },
};

site.hideSimulator

  • Type: boolean
  • Default: false

是否隐藏所有页面右侧的手机模拟器，默认不隐藏

site.simulator.url

  • Type: string
  • Default: -

自定义手机模拟器的 iframe URL 地址。

site.htmlMeta

  • Type: Record<string, string>
  • Default: undefined

配置 HTML 中的 meta 标签，对象的 key 为 name，value 为 content。

site.headHtml

  • Type: string
  • Default: undefined

在 <head> 标签中插入一段自定义的 HTML 内容。

site.enableVConsole

  • Type: boolean
  • Default: false

是否在 dev 时开启 vConsole 调试，用于移动端 debug。

PostCSS

通过根目录下的postcss.config.js文件可以对 PostCSS 进行配置。

默认配置

vant-cli 中默认的 PostCSS 配置如下：

module.exports = {
  plugins: {
    autoprefixer: {},
  },
};

browserslist

推荐在 package.json 文件里添加 browserslist 字段，这个值会被 autoprefixer 用来确定目标浏览器的版本，保证编译后代码的兼容性。

在移动端浏览器中使用，可以添加如下配置：

{
  "browserslist": ["Chrome >= 51", "iOS >= 10"]
}