0.22.0 • Published 2 years ago

stan-builder v0.22.0

Weekly downloads
177
License
MIT
Repository
github
Last release
2 years ago

npm size test NPM downloads

stan-builder

集成 rollup babel 常用打包配置.

Install

Using npm:

npm install stan-builder --save-dev

Features

  • ✔︎ 支持 typeScript
  • ✔︎ 支持 cjs、esm、umd、systemjs 四种格式的打包
  • ✔︎ esm 支持生成 mjs，直接为浏览器使用
  • ✔︎ 支持 postcss
  • ✔︎ 支持打包成 node browser 用的代码

Usage

# Bundle library
stan-builder --esm --cjs --minify 

# Bundle dev
stan-builder -w

Config

新建配置文件 .stanrc.ts .stanrc.js .stanrc.tsx

// BundleOptions
export default {
  esm: true,
  umd: true,
  target: 'browser',
}

Bundle Options

entry

指定入口文件。

  • Type: string
  • Default：src/index.js

默认会查找 src/index.tsx, src/index.ts, src/index.jsx, src/index.js, src/index.vue，如果存在，则会作为默认的 entry。如果库文件为 typescript，则需要在根目录配置tsconfig.json，否则会编译错误。 babel 模式下是编译 entry 所在文件夹的所有文件。

如果是 vue 默认使用的是 vue3 rollup-plugin-vue@6.x, 如果是 vue2 请项目内安装 rollup-plugin-vue@5.x

file

指定输出文件名。

  • Type: string
  • Default：与 entry 相同的文件名，entry.[umd|cjs|esm].[min].js 默认自动增加后缀。
  • [esm|cjs|umd].file 优先级比这个高，没有配置则默认这个。

bundler

打包工具。

  • Type: rollup | babel
    • umd systemjs 规范只支持使用 rollup。

runtimeHelpers

是否把 helper 方法不打包引入 @babel/runtime 。

  • 推荐开启，减少打包体积，公用项目内的 runtime。
  • 开启 runtimeHelpers，一定要在 dependencies 里有 @babel/runtime 依赖
  • runtimeHelpers 只对 esm 有效，cjs 下无效，因为 cjs 已经不给浏览器用了。

minify

是否压缩代码。

  • Type: boolean
  • Default: false
  • 开启会自动生成.min后缀的文件。
  • css 使用 postcss，js 使用 terser。
  • [esm|cjs|umd].minify 优先级比这个高，没有配置则默认这个。

extractCSS

配置是否提取 css 为单独文件。

  • Type: boolean

  • Default: false

injectCSS

是否在 <head> 里注入css。

  • Type: boolean
  • Default: true

sourcemap

是否同步输出sourcemap。

  • Type: boolean
  • Default: false

esm

输出esm规范的代码。

  • Type："rollup" | "babel" | { type, file, mjs, bundler, minify, sourcemap, target, runtimeHelpers } |boolean

cjs

输出cjs规范的代码。

  • Type："rollup" | "babel" | { type, file, lazy, bundler, minify, sourcemap, target, runtimeHelpers } |boolean

cjs.lazy

是否开启 lazy require。

  • Type: boolean
  • Default: false

可加速命令行执行速度，同时减少依赖和耦合。

umd

输出umd规范的代码。

  • Type： "rollup" | "babel" | { type, file, name, global, bundler, minify, sourcemap, target, runtimeHelpers } |boolean

umd.name

指定 rollup 的 name 配置。

  • Type: string
  • Default：默认 camelCase packages.json 中的 name

umd.global

指定 rollup 的 global 配置。

  • Type: react=React,react-dom=ReactDom | { pkg: global name }
  • external 中的包默认会 camelCase 作为默认值。

system

输出systemjs规范的代码，默认使用rollup。

  • Type：boolean

target

配置是 node 库还是 browser 库，只作用于语法层。

  • Type: "node" | "browser"
  • Default: "browser"
  • 如果 entry 后缀为 .jsx|.tsx 默认为 browser。

extraBabelPlugins

配置额外的 babel plugins。

  • Type: array
  • Default: []

extraBabelPresets

配置额外的 babel preset。

  • Type: array
  • Default: []

extraExternals

配置一些依赖走 externals。

  • Type: array<string | RegExp>
  • Default: []
  • rollup 的 external 保留内部默认处理，新增 external
  • 打包esm, cjs时 dependencies 和 peerDependencies 里的内容会被 external
  • 打包umd时 peerDependencies 会被 external

externalsExclude

配置一些依赖不走 externals。

  • Type: array<string | RegExp>
  • Default: []

externalPeerDependenciesOnly

只 externals peerDependencies 中的依赖。

  • Type: string[]
  • Default: []

extraPostCSSPlugins

配置额外 postcss plugin

  • Type: string[]
  • Default: []

extraRollupPlugins

配置额外 rollup plugin

  • Type: array
  • Default: []

analyze

是否可视化展示打包的模块大小，使用 rollup-plugin-visualizer 。

  • Type: boolean
  • Default: false

copy.targets

是否打包同时复制文件。

  • Type: { src, dest, rename, transform } | array
  • Default: undefined
  • 这里使用 globby 匹配文件。
  • 如果 watch 模式，匹配到的文件也会 watch 并且copy。

copy.flatten

是否复制的时候删除目录结构。

  • Type: boolean
  • Default: true

rollup plugin options

如果是 ts 可以参考 stan-builder/typings/types.d.ts 中的 BundleOptions

Usage in node

const builder = require('stan-builder');

builder({ 
  verbose: true
}).then(() => {
    console.log("Build complete.")
})
stan@planjsbuilderreactreact-compomentsvuevue-compomentsnodenode-libraryliblibrarybabelrollupstan-builder
@babel/core@babel/plugin-proposal-decorators@babel/plugin-proposal-do-expressions@babel/plugin-proposal-export-default-from@babel/plugin-proposal-export-namespace-from@babel/plugin-proposal-nullish-coalescing-operator@babel/plugin-proposal-object-rest-spread@babel/plugin-proposal-optional-chaining@babel/plugin-syntax-dynamic-import@babel/plugin-transform-modules-commonjs@babel/plugin-transform-runtime@babel/plugin-transform-spread@babel/preset-env@babel/preset-react@babel/preset-typescript@babel/register@babel/runtime@rollup/plugin-alias@rollup/plugin-babel@rollup/plugin-commonjs@rollup/plugin-inject@rollup/plugin-json@rollup/plugin-node-resolve@rollup/plugin-replace@rollup/plugin-url@rollup/pluginutils@svgr/rollup@types/rollup-plugin-visualizerautoprefixerbuiltin-modulescssnanoescaladegulp-filtergulp-ifgulp-plumbergulp-postcssgulp-sourcemapsgulp-tersergulp-typescriptless-plugin-npm-importmerge2postcsspostcss-load-configrolluprollup-plugin-postcssrollup-plugin-terserrollup-plugin-typescript2rollup-plugin-visualizerstan-utilsthrough2vinyl-fsvue-template-compilerfsevents
@infinitebrahmanuniverse/nolb-stan@everything-registry/sub-chunk-2818stan-env-clistan-env-core
0.21.0

2 years ago

0.22.0

2 years ago

0.20.0

3 years ago

0.19.3

3 years ago

0.19.2

3 years ago

0.17.0

3 years ago

0.17.1

3 years ago

0.18.1

3 years ago

0.18.2

3 years ago

0.18.0

3 years ago

0.19.0

3 years ago

0.19.1

3 years ago

0.16.6

3 years ago

0.16.7

3 years ago

0.16.3

3 years ago

0.16.4

3 years ago

0.16.5

3 years ago

0.14.13

4 years ago

0.14.12

4 years ago

0.14.11

4 years ago

0.14.10

4 years ago

0.14.17

4 years ago

0.14.16

4 years ago

0.14.15

4 years ago

0.14.14

4 years ago

0.14.19

4 years ago

0.14.18

4 years ago

0.14.20

4 years ago

0.14.24

4 years ago

0.14.23

4 years ago

0.14.22

4 years ago

0.14.21

4 years ago

0.14.26

4 years ago

0.14.25

4 years ago

0.14.5

4 years ago

0.14.6

4 years ago

0.14.8

4 years ago

0.14.9

4 years ago

0.14.2

4 years ago

0.14.3

4 years ago

0.14.4

4 years ago

0.15.0

4 years ago

0.16.0

4 years ago

0.16.1

4 years ago

0.16.2

4 years ago

0.14.0

4 years ago

0.14.1

4 years ago

0.13.0

4 years ago

0.13.1

4 years ago

0.13.3

4 years ago

0.12.1

4 years ago

0.12.2

4 years ago

0.12.3

4 years ago

0.12.4

4 years ago

0.12.5

4 years ago

0.11.1

4 years ago

0.11.2

4 years ago

0.11.3

4 years ago

0.11.0

4 years ago

0.10.1

4 years ago

0.10.0

4 years ago

0.9.21

4 years ago

0.9.20

4 years ago

0.9.15

4 years ago

0.9.16

4 years ago

0.9.17

4 years ago

0.9.18

4 years ago

0.9.19

4 years ago

0.9.14

4 years ago

0.9.13

4 years ago

0.9.12

4 years ago

0.9.8

4 years ago

0.9.7

4 years ago

0.9.9

4 years ago

0.9.4

4 years ago

0.9.6

4 years ago

0.9.11

4 years ago

0.9.5

4 years ago

0.9.3

5 years ago

0.9.2

5 years ago

0.9.1

5 years ago

0.9.0

5 years ago

0.8.0

5 years ago

0.7.3

5 years ago

0.7.2

5 years ago

0.7.1

5 years ago

0.7.0

5 years ago

0.5.0

5 years ago

0.6.0

5 years ago

0.5.1

5 years ago

0.4.9

5 years ago

0.4.8

5 years ago

0.4.7

5 years ago

0.4.6

5 years ago

0.4.5

5 years ago

0.4.4

5 years ago

0.4.3

5 years ago

0.4.1

5 years ago

0.4.2

5 years ago

0.4.0

5 years ago

0.2.1

5 years ago

0.2.2

5 years ago

0.2.0

5 years ago

0.1.1

5 years ago

0.0.16

5 years ago

0.0.15

5 years ago

0.0.13

5 years ago

0.0.14

5 years ago

0.0.12

5 years ago

0.0.11

5 years ago

0.0.10

5 years ago

0.0.9

5 years ago

0.0.8

5 years ago

0.0.5

5 years ago

0.0.6

5 years ago

0.0.4

5 years ago

0.0.3

5 years ago