esc-plugin
TypeScript icon, indicating that this package has built-in type declarations

0.1.6 • Public • Published

ESC 系统优化插件

介绍

esc-plugin 插件是一个基于 vite 环境在处理打包时的一些操作的插件. 插件包含:

  1. 打包进度条

Logo

  1. 打包之后生成项目压缩包

Logo

3. cdn加载,当项目包过大时可将一些公共的js,cdn加载

用法

  1. 安装
 # npm
 npm i esc-plugin -D

 # yarn
 yarn add esc-plugin -D

 # pnpm
 pnpm i esc-plugin -D
  1. 使用:在 vite.config.js / vite.config.ts 中配置
import { zip, progress, cdn } from 'esc-plugin';

export default {
  plugins: [
    progress(),
    zip({
      type: 'zip',
      archiverName: 'newboard.zip',
      sourceName: 'newboard',
    }),
    cdn({
      prodUrl: 'http://xxx.com/js/{path}',
      modules: [
        {
          name: 'echarts',
          var: 'echarts',
          path: 'echarts.js'
        },
      ]
    })
  ],
};

progress 插件

  1. 参数
  • format :自定义进度条的格式;
  • width :进度条在终端中的宽度;
  • complete :完成后的默认字符 \u2588
  • incomplete :未完成的默认字符 \u2591
  • renderThrottle :间隔更新时间默认 16(毫秒);
  • clear :完成后是否清除终端,默认 false;
  • callback :完成后执行的回调函数;
  • stream  终端中的输出格式流,默认 stderr
  • head :进度条的头字符;
  • srcDir:构建文件的目录,默认是 src
  1. 参数 options 中的 format 中各个标记含义:
  • :bar :代表进度条;
  • :current :当前执行到哪的刻度;
  • :total :总刻度;
  • :elapsed :所用时间(秒);
  • :percent :完成的百分比;
  • :allTime :预计完成时间(秒);
  • :rate :每一秒的速率;
  1. 使用(带参数)
// vite.config.js / vite.config.ts
import { progress } from 'esc-plugin';

export default {
  plugins: [
    progress({
      format: 'building [:bar] :percent',
      total: 200,
      width: 60,
      complete: '=',
      incomplete: '',
    }),
  ],
};

zip 插件

  1. 参数
  • type :压缩包格式;
  • archiverName :压缩包文件名;
  • sourceName :需要压缩的文件夹;
  1. 使用(带参数)
// vite.config.js / vite.config.ts
import { progress } from 'esc-plugin';

export default {
  plugins: [
    zip({
      type: 'zip',
      archiverName: 'xxx.zip',
      sourceName: 'xxx',
    }),
  ],
};

cdn 插件

  1. 参数
  • prodUrl :覆盖全局 prodUrl 属性,允许为特定的模块指定 CDN 的位置, 如:http://xxx.com/js/{path};
  • modules :需要cdn的模块;

Readme

Keywords

Package Sidebar

Install

npm i esc-plugin

Weekly Downloads

0

Version

0.1.6

License

MIT

Unpacked Size

770 kB

Total Files

7

Last publish

Collaborators

  • wzs28150