组件库打包:怎样才能支持按需加载

支持按需加载需要满足:

  • 组件库以 es6 模块化方式导出
  • package.json 中 sideEffects:false
  • 宿主项目中引用方式写法到位或引入 babel-plugin-import
  • 宿主项目通过 webpack 打包支持 tree-shacking

好了,对于组件库项目,关键就是 以 es6 模块导出


webpack umd 形式导出,打包出来的东西才能供别人使用

// webapack.config
output: {
  library: 'xmh',
  libraryTarget: 'umd'
}

但是是整体定义成一个模块,不能支持按需加载


webpack 不行,直接用 babel 来编译吧,用 gulp 来组织工作流。

babel 配置要注意的,两处:

  • @babel/preset-env 中 modules:false,也就是不要让 babel 对 es module 模块化语法进行编译,不然就编译成 es5 的了
  • @babel/plugin-transform-runtime 中,useESModule:true,也就是使用 es module 形式的 helper
  • 以上两处配置要单独配到一个 env 里,比如 BABEL_ENV = esm,因为项目中使用了 jest , jest 也要用到 babel 但它不支持 es 模块。

另外:
.d.ts 的生成
css 的生成


附上代码:

// .babelrc

{
    "presets": [
        [
            "@babel/preset-env",
            {
                "useBuiltIns": "usage", // usage 会根据配置的浏览器兼容,以及代码中用到的 API 来进行 polyfill,实现了按需添加
                "corejs": 2 // 2 或 3 表示引入不污染全局的 polyfill,搭配 @babel/runtime-corejs2 或 @babel/runtime-corejs3;false 或者不设置,则表示全局引入,会覆盖原有全局变量
            }
        ],
        "@babel/preset-react",
        "@babel/preset-typescript"
    ],
    "plugins": ["@babel/plugin-transform-runtime"],
    "env": {
        "esm": {
            "presets": [
                [
                    "@babel/preset-env",
                    {
                        "modules": false // 不进行 es6 模块编译,保持 es6 模块方式以支持 tree-shacking
                    }
                ]
            ],
            "plugins": [
                [
                    "@babel/plugin-transform-runtime",
                    {
                        "useESModules": true // 使用 esm 形式的 helper
                    }
                ]
            ]
        }
    }
}
// gulpfile.js

const gulp = require('gulp');
const replace = require('gulp-replace');
const babel = require('gulp-babel');
const sass = require('gulp-sass');
const autoprefixer = require('gulp-autoprefixer');
const cssnano = require('gulp-cssnano');

const paths = {
    dest: {
        es: 'es',
        style: 'style'
    },
    styles: 'components/index.scss',
    scripts: [
        'components/**/*.{ts,tsx}',
        '!components/**/__test__/**/*',
        '!components/**/demo/**/*'
    ]
};

function compileESM() {
    const { dest, scripts } = paths;
    return gulp
        .src(scripts)
        .pipe(replace('$prefix', 'xmh'))
        .pipe(babel())
        .pipe(gulp.dest(dest.es));
}

function compileSCSS() {
    const { dest, styles } = paths;
    return gulp
        .src(styles)
        .pipe(sass())
        .pipe(autoprefixer())
        .pipe(
            cssnano({
                zindex: false,
                reduceIdents: false
            })
        )
        .pipe(gulp.dest(dest.style));
}

const build = gulp.parallel(compileESM, compileSCSS);

exports.build = build;
exports.default = build;
// package.json 部分

{
    "main": "dist/xmh-ui.js",
    "module": "es/index",
    "typings": "dist/types/index.d.ts",
    "scripts": {
        "build": "rimraf dist es style && run-s build:*",
        "build:umd": "webpack --config ./build/webpack.prod.config.js",
        "build:esm": "cross-env BABEL_ENV=esm gulp",
        "build:types": "rimraf dist/types && tsc -p tsconfig.build.json && cpr dist/types es"
    },
    "sideEffects": false
}
// tsconfig.json

{
    "compilerOptions": {
        "target": "es5",
        "lib": ["dom", "dom.iterable", "esnext"],
        "module": "esnext",
        "jsx": "react",
        "noImplicitAny": true,
        "noImplicitReturns": true,
        "moduleResolution": "node",
        "baseUrl": "./",
        "paths": {
            "@components/*": ["./components/*"]
        },
        "removeComments": true,
        "declaration": true,
        "declarationDir": "dist/types",
        "emitDeclarationOnly": false,
        "watch": true
    },
    "include": ["./components/**/*", "./example/**/*"]
}
// tsconfig.build.json

{
    "extends": "./tsconfig.json",
    "include": ["./components/**/*"],
    "exclude": ["**/__test__/**/*", "**/demo/**/*"],
    "compilerOptions": {
        "emitDeclarationOnly": true,
        "watch": false
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,841评论 5 472
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,415评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,904评论 0 333
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,051评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,055评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,255评论 1 278
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,729评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,377评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,517评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,420评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,467评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,144评论 3 317
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,735评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,812评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,029评论 1 256
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,528评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,126评论 2 341