project-config-vue

Vue 项目基础配置

webpack 配置，适用于基于 Vue 的 web 项目。

如何使用

安装

pnpm add @plugin-light/project-config-vue -D

在 vue.config.js 中添加如下设置：

const { WEBPACK_BASE_CONFIG } = require('@plugin-light/project-config-vue');
const { merge } = require('webpack-merge');

module.exports = merge(WEBPACK_BASE_CONFIG, {
  transpileDependencies: ['press-ui'],
});

或者使用 getWebpackBaseConfig 方法：

const { getWebpackBaseConfig } = require('@plugin-light/project-config-vue');
const { merge } = require('webpack-merge');

module.exports = merge(getWebpackBaseConfig({
  isUseVueLoader: true,
  isVue3: false,
  useXSS: true,
}), {
  transpileDependencies: ['press-ui'],
});

getWebpackBaseConfig 参数

getWebpackBaseConfig 接收一个对象作为参数，其属性及说明如下：

export type IBaseConfigOptions = {
  port?: number;
  https?: boolean;

  // 是否使用 vue-loader，默认 true
  isUseVueLoader?: boolean;

  // 是否是 Vue3 项目, 默认 false
  isVue3?: boolean;
  // 是否使用 XSS 过滤，需要提前在 Vue 原型上挂载 xss 方法，默认 true
  useXSS?: boolean;

  // 是否使用 ifdef-loader，默认 true
  useIfDefLoader?: boolean;
  // ifdef-loader 要处理的文件
  handleIfDefFiles?: Array<string>;

  // 打包去除 console 日志的方法，默认为 ['console.log', 'console.table']
  terserPureFuncs?: Array<string>;

  // 需要编译的第三方依赖
  transpileDependencies?: Array<string>;

  // 映射的项目
  shadowProjectMap?: Record<string, string>

  // 自定义的 cdn 链接，用于 externals
  customCdnUrls?: Array<string>;

  // 是否使用 pmd-business alias
  usePMDBusinessAlias?: boolean;

  // 是否使用 work-box
  useWorkBoxPlugin?: {}

  // 不加额外的 alias
  lessAlias?: boolean;

  // 是否要将 uni-simple-router 设置外链 cdn
  useUniSimpleRouterCDN?: boolean;

  // 打包产物目录，默认 dist/${VUE_APP_DIR}/static
  outputDirMode?: string;
};

handleIfDefFiles

handleIfDefFiles 默认值如下：

/(press-ui|component|press-plus).*(\.vue|\.ts|\.js|\.css|\.scss)$/;

transpileDependencies

transpileDependencies 默认值如下：

[
  'pmd-merchant-ui',
  'press-ui',
  'press-plus',

  'pmd-aegis',
  'pmd-app-info',
  'pmd-config',
  'pmd-location',
  'pmd-login',
  'pmd-network',
  'pmd-report',
  'pmd-tools',
  'pmd-types',
  'pmd-widget',
  'pmd-vue',
  'pmd-jsapi',
];

console 日志

生产环境下，即process.env.NODE_ENV为production时，默认去掉console日志，可以通过terserPureFuncs传递空数组来恢复显示。

注意同时去掉babel插件transform-remove-console。

打包产物分析

当 process.env.npm_config_report 不为 falsy 时，本工具会使用 webpack-bundle-analyzer 插件，开发者可用来进行打包分析。

否则，在 production 模式下，保存打包分析产物到 my-bundle-analyze.html 文件中，可以在流水线中进行归档。

调试模式

当 process.env.DEBUG_MODE 不为 falsy 时，本工具会设置 configureWebpack.optimization.minimize 为 false，开发者可以用来进行产物分析。

更新日志

点此查看