基于rollup的EasyGameFramework的扩展库构建打包工具,也可以用于构建其他库,编译项目
The Extension library build package based on Rollup's EasyGameFramework can also be used to build other libraries
- 支持typescript开发
- 可以导出iife,commonjs,systemjs等格式
- 将声明打包成单个dts声明文件
- 开箱即用
- 支持自动和手动创建index.ts之类的入口文件(一般用于fairygui这些库将所有脚本通过index.ts导出)
npm install -D @ailhc/egf-cli-
对于不需要全局变量名的
egf build -f cjs
-
需要全局变量名的,冒号: 后跟变量名(如果不写,自动从package.json中解析)
egf build -f iife:xxx
-
更多使用可以参考 模板项目 package-template
-
支持CocosCreator2.x的插件ts编译,插件模板在CocosStore搜索:"plugin_template2_x" 购买下载
- '-p, --proj [proj]', '项目根路径,默认为执行命令处 process.cwd()')
- '-c, --config [config]', '配置文件路径,做更多的自定义处理,默认egf.compile.js')
- '-w, --watch [watch]', '是否监听自动编译')
- '-acti, --auto-cti [autoCti]', '是否自动生成入口文件,默认否'
- '-ctim, -cti-mode [cti-mode]', '自动生成入口文件模式,默认create,可选:create,entrypoint,两种模式差异可见文档'
- '-e, --entry [entry...]', '入口文件 默认src/index.ts,可以是数组,多个入口')
- '-o, --output [output]', '输出文件 默认dist/index.js')
- '-od, --output-dir [outputDir]', '多入口编译输出文件夹 默认dist/${format}')
- '-f, --format [format]', '输出格式 默认cjs,可选iife,umd,es
如果是iife和umd 需要加: 冒号+全局变量名') - '-d, --types-dir [typesDir]', '声明文件输出目录 默认 dist/${format}/types')
- '-nrc, --no-remove-comments [removeComments]', '是否移除注释,默认移除')
- '-t, --target [target]', '编译目标,默认使用tsconfig中的编译目标')
- '-m, --minify [minify]', '是否压缩,默认不压缩')
- '-ngd, --no-gen-dts [genDts]', "是否生成声明文件,默认生成")
- '-bn, --banner [banner]', "自定义输出文件顶部文本")
- '-ft, --footer [footer]', "自定义输出文件尾部文本,在iife规范和umd规范输出中,会有默认全局变量脚本插入")
基于create-ts-index库创建入口文件,一般用于生成库的index.ts比如fairygui
- '-m, --mode [mode]', '创建模式,默认create,可选create、entrypoint'
- '-d, --dir [dir]', '文件夹路径,可以相对也可以绝对,相对路径相对于process.cwd()执行命令处'
declare interface IEgfCompileOption {
/**项目根路径,默认为执行命令处 process.cwd() */
proj: string,
/**配置文件路径,做更多的自定义处理,默认egf.compile.js */
config: string,
/**是否监听自动编译 ,默认为false*/
watch: boolean,
/**入口文件 默认src/index.ts,可以是数组,多个入口 */
entry: string[],
/**单入口输出文件名 默认dist/${format}/lib/index.js*/
output: string,
/**多入口编译输出文件夹 默认dist/${format}/lib*/
outputDir: string,
/**输出文件规范,默认cjs,如果是iife和umd 需要加:<globalName> 冒号+全局变量名 */
format: "cjs" | "es" | "esm" | "iife" | "system" | "umd",
/**声明文件输出目录 默认dist/${format}/types*/
typesDir: string,
/**是否移除注释,默认移除 */
removeComments: boolean,
/**编译目标,默认使用tsconfig中的编译目标*/
target: "es5" | "es6",
/**是否压缩,默认不压缩 */
minify: boolean,
/**是否生成声明文件,默认生成 */
genDts: boolean,
/**自定义输出文件顶部文本 */
banner: string | (() => string | Promise<string>),
/**自定义输出文件尾部文本,在iife规范和umd规范输出中,会有默认全局变量脚本插入 */
footer: string | (() => string | Promise<string>),
/**
* 多入口处理共用js库输出的文件名,如果是字符串可以按照这个规则处理"[name]-[hash]-[format].js"
* 默认使用:"[name]-[hash].js"
*/
chunkFileNames: string | ((chunkInfo: import("rollup").PreRenderedChunk) => string)
/**
* 多入口处理每个入口输出的js文件名
* 默认使用
* (chunkInfo) => {
if (format === "es" || format === "esm") {
return `[name].mjs`
} else {
return `[name].js`
}
},
* 用于从入口点创建的块的模式,或者每个入口块调用的函数以返回这样的模式。模式支持以下占位符:
[format]:在输出选项中定义的呈现格式,例如es或cjs。
[hash]:基于入口点的内容及其所有依赖项的内容的哈希。
[name]:入口点的文件名(没有扩展名),除非输入的对象形式被用来定义一个不同的名称。
正斜杠/可以用来将文件放在子目录中。当使用一个函数时,chunkInfo是generateBundle中不依赖于文件名的属性的简化版本。看到也输出。assetFileNames output.chunkFileNames。
设置输出时也会使用此模式。preserveModules选项。这里有一组不同的占位符:
[format]:输出选项中定义的呈现格式。
[name]:文件的文件名(不带扩展名)。
[ext]:文件的扩展名。
[extname]:文件的扩展名,以。如果它不是空的。
output.extend
*/
entryFileNames: string | ((chunkInfo: import("rollup").PreRenderedChunk) => string),
/**
* 自定义插件
*/
plugins?: import("rollup").Plugin[]
/**
* 1. dtsGenExclude 生成.d.ts文件时所要忽略的 忽略测试目录下的文件,不生成声明文件
*/
dtsGenExclude: string[],
/**externalTag 用来判断引用的模块是否做为外部引用(不编译进来)
因为packages内的A包,引用了B包,会把A和B的代码编译成一个js */
externalTag: string | string[]
/**是否自动创建入口文件,默认false */
autoCti: boolean
/**自动创建入口文件模式 */
ctiMode: "create" | "entrypoint"
/**
* 自动创建入口文件配置
* 具体的配置可见:https://hub.fastgit.org/imjuni/create-ts-index
*/
ctiOption?: import("create-ts-index/dist/options/ICreateTsIndexOption").ICreateTsIndexOption
}- 多入口编译暂不支持声明文件输出