CKEditor 5 构建工具
此软件包可用于构建兼容 CKEditor 5 插件 新的安装方法,而源代码仍然为旧方法所写. 它在构建过程中超过导入,以使插件与新的安装方法相容.
API 密码
这个软件包可以用作CLI工具,也可以通过JavaScript API.
国 际
CLI工具可以使用如下:
npx @ckeditor/ckeditor5-dev-build-tools \
--input=src/index.js \
--output=dist/index.js \
--source-map # Other options
Java 脚本 API
JavaScript API可以使用如下方式:
import { build } from '@ckeditor/ckeditor5-dev-build-tools';
await build( {
input: 'src/index.js',
output: 'dist/index.js',
sourceMap: true,
// Other options
} );
选项
input 编号 : --input=[path]
类型 : string
默认值 : src/index.ts
输入文件的路径 .
output 编号 : --output=[path]
类型 : string
默认值 : dist/index.js
输出文件的路径 。 CSS文件,翻译,源地图等所有其他资产将保存在同一目录中. 当使用时 clean 选项,此路径将用于确定要删除的目录.
tsconfig 编号 : --tsconfig=[path]
类型 : string
默认值 : tsconfig.json
TypeScript 配置文件的路径. 如果工程不使用TypeScript,此选项可以被忽略.
banner 编号 : --banner=[path]
类型 : string
默认值 : ''
横幅文件的路径 。 此文件必须导出一个名为 banner,这是添加到开头的字符串 .js, (中文(简体) ), .css,以及 .d.ts 文档。 横幅内容不得违反JavaScript或CSS语法.
横幅文件示例 :
export const banner =
`/**
* This is a custom banner that uses comment syntax valid in both JavaScript and CSS.
*/
`;
translations 编号 : --translations=[path]
类型 : string
默认值 : ''
符合 Glob 的翻译文件路径 。 如果插件不提供翻译,则可以忽略此选项.
示例值 : **/lang/translations/*.ts
declarations 编号 : --declarations
类型 : boolean
默认值 : false
是否生成 TypeScript 声明文件 .
sourceMap 编号 : --source-map
类型 : boolean
默认值 : false
是否生成源地图 .
minify 编号 : --minify
类型 : boolean
默认值 : false
是否将输出最小化 .
clean 编号 : --clean
类型 : boolean
默认值 : false
是否在构建前清理输出目录 。 清洁目录基于 output 选项.
browser 编号 : --browser
类型 : boolean
默认值 : false
是否为浏览器构建 CKEditor5 插件 。 此选项将使工具输出一个可在浏览器中使用的无害环境管理和UMD捆绑. 此外,输出文件中的一些导入与Node.js构建相比,会略有不同.
如果启用此选项,则 name 选项必须指定.
name 编号 : --name=[name]
类型 : string
默认值 : ''
UMD捆绑的名称. 当捆绑被装入浏览器时,此名称将作为全局变量名称.
如果启用了“ 浏览器” 选项, 则需要此选项 .
globals 编号 : --globals=[moduleID:Global]
类型 : { [ name: string ]: string } | ( ( name: string ) => string ) | string[]
默认值 : {}
外部软件包名称和相关全局变量的对称 umd 建设.
列表中已经包含 ckeditor5 财务报告和审定财务报表 ckeditor5-premium-features 绘图到 CKEDITOR 财务报告和审定财务报表 CKEDITOR_PREMIUM_FEATURES。 。 。 .
在使用CLI时,此选项可以被多次使用.
示例值 : --globals=external-id:variableName --globals=another-external-id:anotherVariableName
当使用JavaScript API时,选项必须是对象.
示例值 :
globals: {
'external-id': 'variableName',
'another-external-id': 'anotherVariableName'
}
external 编号 : --external=[path]
类型 : string[] | string
默认值 : []
不应捆绑的外部依赖性列表 .
外部依赖性列表将自动扩展至包含所有依赖性 ckeditor5 财务报告和审定财务报表 ckeditor5-premium-features 如果它们作为外部依赖提供。 例如,如果您的插件使用 @ckeditor/ckeditor5-core 财务报告和审定财务报表 @ckeditor/ckeditor5-engine,您可以指定 ckeditor5 输入 external 选项将它们排除在捆绑之外.
在使用CLI时,此选项可以被多次使用.
示例值 : --external=lodash --external=moment
在使用JavaScript API时,选项必须是数组.
示例值 : external: [ 'lodash', 'moment' ]
更改日志
见 CHANGELOG.md 文档.
许可证
根据下列规定获得许可证: GNU 通用公共许可证版本 2 或稍后版本请检查date=中的日期值 (帮助) LICENSE.md 文档.