Builder

xuld

2020/11/9(#1, xuld)

API

查看源码
(共 813 行)`Builder 类`

表示一个构建器

构造函数

`Builder`查看源码
(共 88 行)`new Builder`

初始化新的构建器

参数

参数名	说明	类型
(可选)`options`	附加选项展开子属性 `baseDir`: `string` — 配置文件中所有路径的基路径 `ignore`: `Pattern` — 监听和生成的忽略列表 `srcDir`: `string` — 存放源码的文件夹路径 `outDir`: `string` — 构建生成的文件夹路径 `assetsDir`: `string` — 静态资源文件夹路径 `homePageName`: `string` — 设置项目主页文件名 `mainFileName`: `string` — 设置文件夹的主文件名（不含扩展名），其中 `<dir>` 表示文件夹名本身，`<locale>` 表示当前语言 `outDefaultFile`: `string` — 设置输出的默认文件名 `noExtension`: `boolean` — 设置输出 HTML 文件名时删除扩展名 `fs`: `FileSystem` — 使用的文件系统 `locale`: `string` — 使用的语言（如 `en-US`） `compilers`: `Compiler[]` — 自定义编译器列表 `logger` — 日志记录器的选项 `logLevel`: `"error" \| "warning" \| LogLevel.trace \| ... 12 more ...LogLevel.debug \| LogLevel.log \| LogLevel.info \| LogLevel.success \| LogLevel.warning \| LogLevel.error \| LogLevel.fatal \| LogLevel.silent \| "trace" \| "debug" \| "log" \| "info" \| "fatal" \| "silent"` — 允许打印的最低日志等级 `ignore`: `RegExp \| (function(log: string \| Error \| LogEntry, logLevel: LogLevel, persistent?: boolean) => boolean)` — 判断是否忽略指定日志的正则表达式或回调函数 `colors`: `boolean` — 是否打印带颜色控制符的日志 `emoji`: `boolean` — 是否打印图形表情 `timestamp`: `boolean` — 是否打印时间戳 `fullPath`: `boolean` — 是否打印完整绝对路径 `baseDir`: `string` — 打印相对路径时使用的基路径 `codeFrame`: `boolean` — 是否打印代码片段 `persistent`: `boolean` — 是否禁止清屏 `progress`: `boolean` — 是否打印进度条 `spinnerFrames`: `string[]` — 进度指示器的所有桢 `spinnerInterval`: `number` — 进度指示器自动切换桢的毫秒数 `hideCursor`: `boolean` — 是否需要隐藏控制台光标 `errorOrWarningCounter`: `number \| false` — 在错误或警告前追加的起始编号，设为 `false` 则不追加编号 `successIcon`: `string` — 在成功日志前追加的前缀 `warningIcon`: `string` — 在警告日志前追加的前缀 `errorIcon`: `string` — 在错误日志前追加的前缀 `fatalIcon`: `string` — 在致命错误日志前追加的前缀 `sourceMap`: `boolean` — 开发时是否启用源映射 `sourceMapRoot`: `string` — 源映射的根地址，默认为空表示相对目录，"file:///" 表示使用绝对路径 `optimize`: `boolean` — 发布时是否优化生成的代码 `ts`: `any` — 内置 TypeScript 编译器的附加选项 `sass`: `any` — 内置 Sass 编译器的附加选项 `less`: `any` — 内置 Less 编译器的附加选项 `webpack`: `any` — 内置 Webpack 编译器的附加选项 `md`: `any` — 内置 Markdown 编译器的附加选项 `doc` — 内置文档编译器的附加选项 `baseURL`: `string` — 生成的页面中引用资源的根地址 `logo`: `string` — 项目 LOGO，可以是一段 `<svg>` 或 `<img>` 源码 `displayName`: `string` — 项目展示名，用于网站标题栏及左上角 LOGO 文案 `version`: `string` — 项目版本 `versions`: `array` — 其它版本链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `navbar`: `array` — 顶部导航条链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `children`: `array` — 子菜单 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `footer`: `array` — 底部链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `copyright`: `string` — 底部版权声明 `injectHead`: `string` — 生成的文档头部插入的 HTML 代码，比如 SEO 标记 `injectFoot`: `string` — 生成的文档末尾插入的 HTML 代码，比如放入一些统计代码 `maxTOCLevel`: `number` — 自动生成索引的最大标题等级（1-6）（默认 4） `counter`: `false \| true \| (function(counts: number[], item: TOCItem) => string)` — 定制为每个标题生成序号 `backToTop`: `boolean` — 是否插入返回顶部链接 `introDescription`: `string` — 项目描述 `introButtons`: `array` — 项目描述后的按钮 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `features`: `array` — 项目优势说明链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `icon`: `string` — 图标 `description`: `string` — 描述文案 `links`: `array` — 友情链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `icon`: `string` — 图标 `support` — 支持/赞助链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `packageName`: `string` — 发布的包名 `repository`: `string` — 项目仓库地址(HTTPS 协议) `repositoryPath`: `string` — 项目根目录在仓库中的路径 `branch`: `string` — 项目仓库分支 `readCommits`: `function(files: string[]) => CommitInfo[] \| Promise<CommitInfo[]>` — 读取指定文件的修改记录 `modules`: `{[name: string]: string}` — 配置供代码加载的内置模块 `build`: `(Circular)BuilderOptions` — 一次性构建时额外设置的选项 `plugins`: `(string \| BuilderPlugin)[]` — 所有附加插件	`BuilderOptions`
(可选)`devServer`	关联的开发服务器	`DevServer`

属性

属性名	说明	类型
`options`只读	获取构建器的选项展开子属性 `baseDir`: `string` — 配置文件中所有路径的基路径 `ignore`: `Pattern` — 监听和生成的忽略列表 `srcDir`: `string` — 存放源码的文件夹路径 `outDir`: `string` — 构建生成的文件夹路径 `assetsDir`: `string` — 静态资源文件夹路径 `homePageName`: `string` — 设置项目主页文件名 `mainFileName`: `string` — 设置文件夹的主文件名（不含扩展名），其中 `<dir>` 表示文件夹名本身，`<locale>` 表示当前语言 `outDefaultFile`: `string` — 设置输出的默认文件名 `noExtension`: `boolean` — 设置输出 HTML 文件名时删除扩展名 `fs`: `FileSystem` — 使用的文件系统 `locale`: `string` — 使用的语言（如 `en-US`） `compilers`: `Compiler[]` — 自定义编译器列表 `logger` — 日志记录器的选项 `logLevel`: `"error" \| "warning" \| LogLevel.trace \| ... 12 more ...LogLevel.debug \| LogLevel.log \| LogLevel.info \| LogLevel.success \| LogLevel.warning \| LogLevel.error \| LogLevel.fatal \| LogLevel.silent \| "trace" \| "debug" \| "log" \| "info" \| "fatal" \| "silent"` — 允许打印的最低日志等级 `ignore`: `RegExp \| (function(log: string \| Error \| LogEntry, logLevel: LogLevel, persistent?: boolean) => boolean)` — 判断是否忽略指定日志的正则表达式或回调函数 `colors`: `boolean` — 是否打印带颜色控制符的日志 `emoji`: `boolean` — 是否打印图形表情 `timestamp`: `boolean` — 是否打印时间戳 `fullPath`: `boolean` — 是否打印完整绝对路径 `baseDir`: `string` — 打印相对路径时使用的基路径 `codeFrame`: `boolean` — 是否打印代码片段 `persistent`: `boolean` — 是否禁止清屏 `progress`: `boolean` — 是否打印进度条 `spinnerFrames`: `string[]` — 进度指示器的所有桢 `spinnerInterval`: `number` — 进度指示器自动切换桢的毫秒数 `hideCursor`: `boolean` — 是否需要隐藏控制台光标 `errorOrWarningCounter`: `number \| false` — 在错误或警告前追加的起始编号，设为 `false` 则不追加编号 `successIcon`: `string` — 在成功日志前追加的前缀 `warningIcon`: `string` — 在警告日志前追加的前缀 `errorIcon`: `string` — 在错误日志前追加的前缀 `fatalIcon`: `string` — 在致命错误日志前追加的前缀 `sourceMap`: `boolean` — 开发时是否启用源映射 `sourceMapRoot`: `string` — 源映射的根地址，默认为空表示相对目录，"file:///" 表示使用绝对路径 `optimize`: `boolean` — 发布时是否优化生成的代码 `ts`: `any` — 内置 TypeScript 编译器的附加选项 `sass`: `any` — 内置 Sass 编译器的附加选项 `less`: `any` — 内置 Less 编译器的附加选项 `webpack`: `any` — 内置 Webpack 编译器的附加选项 `md`: `any` — 内置 Markdown 编译器的附加选项 `doc` — 内置文档编译器的附加选项 `baseURL`: `string` — 生成的页面中引用资源的根地址 `logo`: `string` — 项目 LOGO，可以是一段 `<svg>` 或 `<img>` 源码 `displayName`: `string` — 项目展示名，用于网站标题栏及左上角 LOGO 文案 `version`: `string` — 项目版本 `versions`: `array` — 其它版本链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `navbar`: `array` — 顶部导航条链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `children`: `array` — 子菜单 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `footer`: `array` — 底部链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `copyright`: `string` — 底部版权声明 `injectHead`: `string` — 生成的文档头部插入的 HTML 代码，比如 SEO 标记 `injectFoot`: `string` — 生成的文档末尾插入的 HTML 代码，比如放入一些统计代码 `maxTOCLevel`: `number` — 自动生成索引的最大标题等级（1-6）（默认 4） `counter`: `false \| true \| (function(counts: number[], item: TOCItem) => string)` — 定制为每个标题生成序号 `backToTop`: `boolean` — 是否插入返回顶部链接 `introDescription`: `string` — 项目描述 `introButtons`: `array` — 项目描述后的按钮 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `features`: `array` — 项目优势说明链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `icon`: `string` — 图标 `description`: `string` — 描述文案 `links`: `array` — 友情链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `icon`: `string` — 图标 `support` — 支持/赞助链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `packageName`: `string` — 发布的包名 `repository`: `string` — 项目仓库地址(HTTPS 协议) `repositoryPath`: `string` — 项目根目录在仓库中的路径 `branch`: `string` — 项目仓库分支 `readCommits`: `function(files: string[]) => CommitInfo[] \| Promise<CommitInfo[]>` — 读取指定文件的修改记录 `modules`: `{[name: string]: string}` — 配置供代码加载的内置模块 `build`: `(Circular)BuilderOptions` — 一次性构建时额外设置的选项 `plugins`: `(string \| BuilderPlugin)[]` — 所有附加插件	`BuilderOptions`
`compilers`只读	获取所有编译器	`Compiler[]`
`typeScriptCompiler`只读	获取使用的 TypeScript 编译器	`TypeScriptCompiler`
`externalPackageCompiler`只读	获取外部包编译器	`Compiler`
`docCompiler`只读	获取使用的文档编译器	`DocCompiler`
`fs`只读	获取使用的文件系统	`FileSystem`
`logger`只读	获取使用的日志记录器	`Logger`
`building`	判断是否正在执行最终构建	`boolean`
`devServer`(可选)只读	关联的开发服务器	`DevServer`
`vendors`保护	依赖的三方包	`string[]`

方法

`Builder`查看源码
(共 28 行)`compileTypeScript`

编译一段 TypeScript

参数

参数名	说明	类型
`content`	要编译的源码，如果为 `undefined` 则自动从路径读取	`string`
`fileName`	源码的绝对路径，用于查找和该路径相关的配置以及解析源码中导入的相对路径	`string`
(可选)`checkErrors`	是否检查错误，如果为 `transpileOnly` 则只检查语法错误，忽略类型错误默认值：`"transpileOnly";`	`false \| true \| "transpileOnly"`
(可选)`moduleName`	如果要生成 AMD 模块，则指定当前模块名	`string`
(可选)`renameModuleName`	重命名导入模块名的回调函数	`(moduleName: string, sourceFile: SourceFile, program: Program) => string`
(可选)`options`	针对当前文件的编译器选项展开子属性 `allowJs`: `boolean` `allowSyntheticDefaultImports`: `boolean` `allowUmdGlobalAccess`: `boolean` `allowUnreachableCode`: `boolean` `allowUnusedLabels`: `boolean` `alwaysStrict`: `boolean` `baseUrl`: `string` `bundledPackageName`: `string` `charset`: `string` `checkJs`: `boolean` `declaration`: `boolean` `declarationMap`: `boolean` `emitDeclarationOnly`: `boolean` `declarationDir`: `string` `disableSizeLimit`: `boolean` `disableSourceOfProjectReferenceRedirect`: `boolean` `disableSolutionSearching`: `boolean` `disableReferencedProjectLoad`: `boolean` `downlevelIteration`: `boolean` `emitBOM`: `boolean` `emitDecoratorMetadata`: `boolean` `experimentalDecorators`: `boolean` `forceConsistentCasingInFileNames`: `boolean` `importHelpers`: `boolean` `importsNotUsedAsValues`: `ImportsNotUsedAsValues` `inlineSourceMap`: `boolean` `inlineSources`: `boolean` `isolatedModules`: `boolean` `jsx`: `JsxEmit.None \| JsxEmit.Preserve \| JsxEmit.React \| ... 5 more ...JsxEmit.ReactNative \| JsxEmit.ReactJSX \| JsxEmit.ReactJSXDev \| "none" \| "preserve" \| "react" \| "react-jsx"` `keyofStringsOnly`: `boolean` `lib`: `string[]` `locale`: `string` `mapRoot`: `string` `maxNodeModuleJsDepth`: `number` `module`: `ModuleKind.None \| ModuleKind.CommonJS \| ModuleKind.AMD \| ... 10 more ...ModuleKind.UMD \| ModuleKind.System \| ModuleKind.ES2015 \| ModuleKind.ES2020 \| ModuleKind.ESNext \| "es6" \| "es2015" \| "esnext" \| "none" \| "commonjs" \| "system" \| "umd"` `moduleResolution`: `ModuleResolutionKind.Classic \| ModuleResolutionKind.NodeJs \| "node" \| "classic"` `newLine`: `NewLineKind.CarriageReturnLineFeed \| NewLineKind.LineFeed \| "CRLF" \| "LF"` `noEmit`: `boolean` `noEmitHelpers`: `boolean` `noEmitOnError`: `boolean` `noErrorTruncation`: `boolean` `noFallthroughCasesInSwitch`: `boolean` `noImplicitAny`: `boolean` `noImplicitReturns`: `boolean` `noImplicitThis`: `boolean` `noStrictGenericChecks`: `boolean` `noUnusedLocals`: `boolean` `noUnusedParameters`: `boolean` `noImplicitUseStrict`: `boolean` `noPropertyAccessFromIndexSignature`: `boolean` `assumeChangesOnlyAffectDirectDependencies`: `boolean` `noLib`: `boolean` `noResolve`: `boolean` `noUncheckedIndexedAccess`: `boolean` `out`: `string` `outDir`: `string` `outFile`: `string` `paths`: `MapLike<string[]>` `preserveConstEnums`: `boolean` `preserveSymlinks`: `boolean` `project`: `string` `reactNamespace`: `string` `jsxFactory`: `string` `jsxFragmentFactory`: `string` `jsxImportSource`: `string` `composite`: `boolean` `incremental`: `boolean` `tsBuildInfoFile`: `string` `removeComments`: `boolean` `rootDir`: `string` `rootDirs`: `string[]` `skipLibCheck`: `boolean` `skipDefaultLibCheck`: `boolean` `sourceMap`: `boolean` `sourceRoot`: `string` `strict`: `boolean` `strictFunctionTypes`: `boolean` `strictBindCallApply`: `boolean` `strictNullChecks`: `boolean` `strictPropertyInitialization`: `boolean` `stripInternal`: `boolean` `suppressExcessPropertyErrors`: `boolean` `suppressImplicitAnyIndexErrors`: `boolean` `target`: `string \| ScriptTarget.ES3 \| ScriptTarget.ES5 \| ... 5 more ...ScriptTarget.ES2015 \| ScriptTarget.ES2016 \| ScriptTarget.ES2017 \| ScriptTarget.ES2018 \| ScriptTarget.ES2019 \| ScriptTarget.ESNext \| ScriptTarget.JSON` `traceResolution`: `boolean` `resolveJsonModule`: `boolean` `types`: `string[]` `typeRoots`: `string[]` — Paths used to compute primary types search locations `esModuleInterop`: `boolean` `useDefineForClassFields`: `boolean`	`Merge<CompilerOptions, {target?: stringmodule?: "es6" \| "es2015" \| "esnext" \| "none" \| "commonjs" \| "amd" \| "system" \| "umd"jsx?: "none" \| "preserve" \| "react-native" \| "react" \| "react-jsx"moduleResolution?: "node" \| "classic"newLine?: "CRLF" \| "LF"}>`

返回值

类型：Pick<TypeScriptCompileResult, "program" | "content" | "sourceMap" | "declaration" | "sourceFile"> & CompileResult

`Builder`查看源码
(共 46 行)`getAsset`异步

获取指定地址对应的资源

参数

参数名	说明	类型
`url`	要获取的地址	`string`

返回值

类型：Promise<Asset>

`Builder`查看源码
(共 7 行)`getMainFileName`

获取指定文件夹的首页名（不含扩展名）

参数

参数名	说明	类型
`dir`	文件夹名	`string`

返回值

类型：string

`Builder`查看源码
(共 35 行)`runCompiler`异步

使用指定的编译器编译指定的文件

参数

参数名	说明	类型
`compiler`	要使用的编译器	`Compiler`
`content`	要编译的内容	`string`
`path`	要编译的路径	`string`
`outPath`	输出的路径	`string`

返回值

类型：Promise<Asset>

`Builder`查看源码
(共 20 行)`watch`

添加指定的路径更新后的回调函数

参数

参数名	说明	类型
`path`	要监听的绝对路径	`string \| (function(path: string, type: AssetUpdateType) => boolean)`
`callback`	要添加的回调函数或资源地址	`string \| (function() => void)`

返回值

类型：void

`Builder`查看源码
(共 24 行)`unwatch`

删除指定的路径更新后的回调函数

参数

参数名	说明	类型
`path`	监听的绝对路径	`string \| (function(path: string, type: AssetUpdateType) => boolean)`
`callback`	要删除的回调函数或资源地址	`string \| (function() => void)`

返回值

类型：void

`Builder`查看源码
(共 32 行)`emitUpdate`

通知指定的路径已更新

参数

参数名	说明	类型
`path`	更新的文件绝对路径	`string`
`type`	更新的类型	`AssetUpdateType`

返回值

类型：void

`Builder`查看源码
(共 66 行)`build`异步

立即构建资源

参数

参数名说明类型

参数名	说明	类型
(可选)`clean`	是否在构建前清理目标文件夹默认值：`true;`	`boolean`
(可选)`url`	要构建的资源地址，如果为空则构建所有资源	`string`

(可选)clean

是否在构建前清理目标文件夹

默认值：true;

boolean

(可选)url

要构建的资源地址，如果为空则构建所有资源

string

返回值

类型：Promise<void>

`Builder`查看源码
(共 6 行)`getRootDirNames`异步

获取项目的根文件夹

返回值

类型：Promise<string[]>

`Builder`查看源码
(共 7 行)`toURL`

返回指定路径的访问地址

参数

参数名	说明	类型
`path`	要获取的绝对路径	`string`

返回值

类型：string

`Builder`查看源码
(共 14 行)`toShortURL`

获取访问指定资源的最短地址

参数

参数名	说明	类型
`path`	要访问的资源路径	`string`

返回值

类型：string

`Builder`查看源码
(共 7 行)`toPath`

返回指定地址对应的绝对路径

参数

参数名	说明	类型
`url`		`string`

返回值

类型：string

`Builder`查看源码
(共 13 行)`getOutputName`

获取指定模块生成的模块名

参数

参数名	说明	类型
`name`	源模块名	`string`

返回值

类型：string

`Builder`查看源码
(共 17 行)`getOutputNames`

获取指定模块生成的所有模块名

参数

参数名	说明	类型
`name`	源模块名	`string`

返回值

类型：string[]

`Builder`查看源码
(共 13 行)`getHTMLOutputName`

获取指定模块生成的 HTML 模块名，如果模块无法生成 HTML，则返回原地址

参数

参数名	说明	类型
`name`	源模块名	`string`

返回值

类型：string

`Builder`查看源码
(共 18 行)`getInputName`

计算生成指定文件的源文件名，如果找不到则返回 undefined

参数

参数名	说明	类型
`name`	生成的文件名	`string`
`entries`	文件夹下的所有文件名	`string[]`

返回值

类型：string

`Builder`查看源码
(共 14 行)`isIgnored`

判断指定的路径是否被忽略

参数

参数名	说明	类型
`path`	要判断的绝对路径	`string`

返回值

类型：boolean

`Builder`查看源码
(共 7 行)`loadPlugin`保护

载入一个插件

参数

参数名	说明	类型
`name`	要载入的插件名	`string`

返回值

类型：any

`Builder`查看源码
(共 126 行)`loadAsset`异步保护

生成指定的资源

参数

参数名	说明	类型
`url`	资源的内部路径，如 `components/ui/button`	`string`

返回值

类型：Promise<Asset>

`Builder`查看源码
(共 24 行)`buildAsset`异步保护

构建指定地址对应的文件

参数

参数名	说明	类型
`url`	要构建的地址	`string`

返回值

类型：Promise<Asset>

`Builder`查看源码
(共 57 行)`buildModule`异步保护

构建指定地址对应的模块

参数

参数名	说明	类型
`url`	要构建的地址	`string`

返回值

类型：Promise<Asset>

`Builder`查看源码
(共 17 行)`getGeneratedURLs`异步生成器保护

获取动态生成的所有文件的地址

返回值

类型：AsyncGenerator<string, void, undefined>

查看源码
(共 87 行)`BuilderOptions 接口`

表示构建器的选项

属性

属性名	说明	类型
`baseDir`	配置文件中所有路径的基路径	`string`
`ignore`	监听和生成的忽略列表	`Pattern`
`srcDir`	存放源码的文件夹路径	`string`
`outDir`	构建生成的文件夹路径	`string`
`assetsDir`	静态资源文件夹路径	`string`
`homePageName`	设置项目主页文件名示例 `"README"`	`string`
`mainFileName`	设置文件夹的主文件名（不含扩展名），其中 `<dir>` 表示文件夹名本身，`<locale>` 表示当前语言	`string`
`outDefaultFile`	设置输出的默认文件名	`string`
`noExtension`	设置输出 HTML 文件名时删除扩展名	`boolean`
`fs`	使用的文件系统	`FileSystem`
`locale`	使用的语言（如 `en-US`）	`string`
`compilers`	自定义编译器列表	`Compiler[]`
`logger`	日志记录器的选项展开子属性 `logLevel`: `"error" \| "warning" \| LogLevel.trace \| ... 12 more ...LogLevel.debug \| LogLevel.log \| LogLevel.info \| LogLevel.success \| LogLevel.warning \| LogLevel.error \| LogLevel.fatal \| LogLevel.silent \| "trace" \| "debug" \| "log" \| "info" \| "fatal" \| "silent"` — 允许打印的最低日志等级 `ignore`: `RegExp \| (function(log: string \| Error \| LogEntry, logLevel: LogLevel, persistent?: boolean) => boolean)` — 判断是否忽略指定日志的正则表达式或回调函数 `colors`: `boolean` — 是否打印带颜色控制符的日志 `emoji`: `boolean` — 是否打印图形表情 `timestamp`: `boolean` — 是否打印时间戳 `fullPath`: `boolean` — 是否打印完整绝对路径 `baseDir`: `string` — 打印相对路径时使用的基路径 `codeFrame`: `boolean` — 是否打印代码片段 `persistent`: `boolean` — 是否禁止清屏 `progress`: `boolean` — 是否打印进度条 `spinnerFrames`: `string[]` — 进度指示器的所有桢 `spinnerInterval`: `number` — 进度指示器自动切换桢的毫秒数 `hideCursor`: `boolean` — 是否需要隐藏控制台光标 `errorOrWarningCounter`: `number \| false` — 在错误或警告前追加的起始编号，设为 `false` 则不追加编号 `successIcon`: `string` — 在成功日志前追加的前缀 `warningIcon`: `string` — 在警告日志前追加的前缀 `errorIcon`: `string` — 在错误日志前追加的前缀 `fatalIcon`: `string` — 在致命错误日志前追加的前缀	`LoggerOptions`
`sourceMap`	开发时是否启用源映射	`boolean`
`sourceMapRoot`	源映射的根地址，默认为空表示相对目录，"file:///" 表示使用绝对路径	`string`
`optimize`	发布时是否优化生成的代码	`boolean`
`ts`	内置 TypeScript 编译器的附加选项	`any`
`sass`	内置 Sass 编译器的附加选项	`any`
`less`	内置 Less 编译器的附加选项	`any`
`webpack`	内置 Webpack 编译器的附加选项	`any`
`md`	内置 Markdown 编译器的附加选项	`any`
`doc`	内置文档编译器的附加选项展开子属性 `baseURL`: `string` — 生成的页面中引用资源的根地址 `logo`: `string` — 项目 LOGO，可以是一段 `<svg>` 或 `<img>` 源码 `displayName`: `string` — 项目展示名，用于网站标题栏及左上角 LOGO 文案 `version`: `string` — 项目版本 `versions`: `array` — 其它版本链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `navbar`: `array` — 顶部导航条链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `children`: `array` — 子菜单 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `footer`: `array` — 底部链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `copyright`: `string` — 底部版权声明 `injectHead`: `string` — 生成的文档头部插入的 HTML 代码，比如 SEO 标记 `injectFoot`: `string` — 生成的文档末尾插入的 HTML 代码，比如放入一些统计代码 `maxTOCLevel`: `number` — 自动生成索引的最大标题等级（1-6）（默认 4） `counter`: `false \| true \| (function(counts: number[], item: TOCItem) => string)` — 定制为每个标题生成序号 `backToTop`: `boolean` — 是否插入返回顶部链接 `introDescription`: `string` — 项目描述 `introButtons`: `array` — 项目描述后的按钮 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `features`: `array` — 项目优势说明链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `icon`: `string` — 图标 `description`: `string` — 描述文案 `links`: `array` — 友情链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `icon`: `string` — 图标 `support` — 支持/赞助链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `packageName`: `string` — 发布的包名 `repository`: `string` — 项目仓库地址(HTTPS 协议) `repositoryPath`: `string` — 项目根目录在仓库中的路径 `branch`: `string` — 项目仓库分支 `readCommits`: `(files: string[]) => CommitInfo[] \| Promise<CommitInfo[]>` — 读取指定文件的修改记录	`DocCompilerOptions`
`modules`	配置供代码加载的内置模块	`{[name: string]: string}`
`build`	一次性构建时额外设置的选项展开子属性 `baseDir`: `string` — 配置文件中所有路径的基路径 `ignore`: `Pattern` — 监听和生成的忽略列表 `srcDir`: `string` — 存放源码的文件夹路径 `outDir`: `string` — 构建生成的文件夹路径 `assetsDir`: `string` — 静态资源文件夹路径 `homePageName`: `string` — 设置项目主页文件名 `mainFileName`: `string` — 设置文件夹的主文件名（不含扩展名），其中 `<dir>` 表示文件夹名本身，`<locale>` 表示当前语言 `outDefaultFile`: `string` — 设置输出的默认文件名 `noExtension`: `boolean` — 设置输出 HTML 文件名时删除扩展名 `fs`: `FileSystem` — 使用的文件系统 `locale`: `string` — 使用的语言（如 `en-US`） `compilers`: `Compiler[]` — 自定义编译器列表 `logger` — 日志记录器的选项 `logLevel`: `"error" \| "warning" \| LogLevel.trace \| ... 12 more ...LogLevel.debug \| LogLevel.log \| LogLevel.info \| LogLevel.success \| LogLevel.warning \| LogLevel.error \| LogLevel.fatal \| LogLevel.silent \| "trace" \| "debug" \| "log" \| "info" \| "fatal" \| "silent"` — 允许打印的最低日志等级 `ignore`: `RegExp \| (function(log: string \| Error \| LogEntry, logLevel: LogLevel, persistent?: boolean) => boolean)` — 判断是否忽略指定日志的正则表达式或回调函数 `colors`: `boolean` — 是否打印带颜色控制符的日志 `emoji`: `boolean` — 是否打印图形表情 `timestamp`: `boolean` — 是否打印时间戳 `fullPath`: `boolean` — 是否打印完整绝对路径 `baseDir`: `string` — 打印相对路径时使用的基路径 `codeFrame`: `boolean` — 是否打印代码片段 `persistent`: `boolean` — 是否禁止清屏 `progress`: `boolean` — 是否打印进度条 `spinnerFrames`: `string[]` — 进度指示器的所有桢 `spinnerInterval`: `number` — 进度指示器自动切换桢的毫秒数 `hideCursor`: `boolean` — 是否需要隐藏控制台光标 `errorOrWarningCounter`: `number \| false` — 在错误或警告前追加的起始编号，设为 `false` 则不追加编号 `successIcon`: `string` — 在成功日志前追加的前缀 `warningIcon`: `string` — 在警告日志前追加的前缀 `errorIcon`: `string` — 在错误日志前追加的前缀 `fatalIcon`: `string` — 在致命错误日志前追加的前缀 `sourceMap`: `boolean` — 开发时是否启用源映射 `sourceMapRoot`: `string` — 源映射的根地址，默认为空表示相对目录，"file:///" 表示使用绝对路径 `optimize`: `boolean` — 发布时是否优化生成的代码 `ts`: `any` — 内置 TypeScript 编译器的附加选项 `sass`: `any` — 内置 Sass 编译器的附加选项 `less`: `any` — 内置 Less 编译器的附加选项 `webpack`: `any` — 内置 Webpack 编译器的附加选项 `md`: `any` — 内置 Markdown 编译器的附加选项 `doc` — 内置文档编译器的附加选项 `baseURL`: `string` — 生成的页面中引用资源的根地址 `logo`: `string` — 项目 LOGO，可以是一段 `<svg>` 或 `<img>` 源码 `displayName`: `string` — 项目展示名，用于网站标题栏及左上角 LOGO 文案 `version`: `string` — 项目版本 `versions`: `array` — 其它版本链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `navbar`: `array` — 顶部导航条链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `children`: `array` — 子菜单 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `footer`: `array` — 底部链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `copyright`: `string` — 底部版权声明 `injectHead`: `string` — 生成的文档头部插入的 HTML 代码，比如 SEO 标记 `injectFoot`: `string` — 生成的文档末尾插入的 HTML 代码，比如放入一些统计代码 `maxTOCLevel`: `number` — 自动生成索引的最大标题等级（1-6）（默认 4） `counter`: `false \| true \| (function(counts: number[], item: TOCItem) => string)` — 定制为每个标题生成序号 `backToTop`: `boolean` — 是否插入返回顶部链接 `introDescription`: `string` — 项目描述 `introButtons`: `array` — 项目描述后的按钮 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `features`: `array` — 项目优势说明链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `icon`: `string` — 图标 `description`: `string` — 描述文案 `links`: `array` — 友情链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `icon`: `string` — 图标 `support` — 支持/赞助链接 `label`: `string` — 链接文案 `href`: `string` — 链接地址 `title`: `string` — 鼠标悬停时的工具提示 `packageName`: `string` — 发布的包名 `repository`: `string` — 项目仓库地址(HTTPS 协议) `repositoryPath`: `string` — 项目根目录在仓库中的路径 `branch`: `string` — 项目仓库分支 `readCommits`: `function(files: string[]) => CommitInfo[] \| Promise<CommitInfo[]>` — 读取指定文件的修改记录 `modules`: `{[name: string]: string}` — 配置供代码加载的内置模块 `build`: `(Circular)BuilderOptions` — 一次性构建时额外设置的选项 `plugins`: `(string \| BuilderPlugin)[]` — 所有附加插件	`BuilderOptions`
`plugins`	所有附加插件	`(string \| BuilderPlugin)[]`

查看源码
(共 18 行)`Compiler 接口`

表示一个编译器

属性

属性名	说明	类型
`inExts`	输入的文件扩展名(含点)	`string[]`
`outExt`	输出的文件扩展名(含点)	`string`
`use`(可选)	编译器的源路径	`string`

方法

`Compiler`查看源码
(共 9 行)`compile`(可选)

编译指定的模块

参数

参数名	说明	类型
`content`	模块的源内容	`string`
`path`	模块的源绝对路径	`string`
`outPath`	生成的目标绝对路径	`string`
`builder`	当前的构建器对象	`Builder`

返回值

类型：CompileResult | Promise<CompileResult>

返回编译的结果对象

查看源码
(共 11 行)`CompileResult 接口`

表示编译结果

属性

属性名	说明	类型
`content`	生成的内容	`string \| Buffer`
`sourceMap`	生成的源映射	`string \| Buffer`
`errors`	生成时产生的错误展开子属性 `source`: `string` — 日志的来源 `message`: `string` — 日志的信息 `fileName`: `string` — 日志相关的文件名 `line`: `number` — 日志相关的行号（从 0 开始） `column`: `number` — 日志相关的列号（从 0 开始） `endLine`: `number` — 日志相关的结束行号（从 0 开始） `endColumn`: `number` — 日志相关的结束列号（从 0 开始） `detail`: `string` — 日志的详情 `codeFrame`: `string` — 日志相关的源代码片段 `stack`: `string` — 错误堆栈信息	`LogEntry[]`
`dependencies`	生成所依赖的文件路径，当任一依赖变化后需要重新生成	`(string \| DependencyCallback)[]`

查看源码
(共 6 行)`DependencyCallback 类型`

表示检测依赖的回调函数

同：(path: string, updateType: AssetUpdateType) => boolean

查看源码
(共 2 行)`BuilderPlugin 类型`

表示一个构建器插件

同：(builder: Builder) => void

查看源码
(共 13 行)`Asset 接口`

表示一个资源

属性

属性名	说明	类型
`type`	资源的类型	`AssetType`
`content`(可选)	资源的内容，可以是文件的内容或重定向的地址	`string \| Buffer`
`sourceMap`(可选)	如果当前资源存在源映射，则为关联的源映射资源展开子属性 `type`: `AssetType` — 资源的类型 `content`: `string \| Buffer` — 资源的内容，可以是文件的内容或重定向的地址 `sourceMap`: `(Circular)Asset` — 如果当前资源存在源映射，则为关联的源映射资源 `errors`: `array` — 构建时产生的所有错误 `source`: `string` — 日志的来源 `message`: `string` — 日志的信息 `fileName`: `string` — 日志相关的文件名 `line`: `number` — 日志相关的行号（从 0 开始） `column`: `number` — 日志相关的列号（从 0 开始） `endLine`: `number` — 日志相关的结束行号（从 0 开始） `endColumn`: `number` — 日志相关的结束列号（从 0 开始） `detail`: `string` — 日志的详情 `codeFrame`: `string` — 日志相关的源代码片段 `stack`: `string` — 错误堆栈信息 `dependencies`: `(string \| DependencyCallback)[]` — 构建当前资源所依赖的文件路径，当任一依赖文件变化后需要重新构建	`Asset`
`errors`(可选)	构建时产生的所有错误展开子属性 `source`: `string` — 日志的来源 `message`: `string` — 日志的信息 `fileName`: `string` — 日志相关的文件名 `line`: `number` — 日志相关的行号（从 0 开始） `column`: `number` — 日志相关的列号（从 0 开始） `endLine`: `number` — 日志相关的结束行号（从 0 开始） `endColumn`: `number` — 日志相关的结束列号（从 0 开始） `detail`: `string` — 日志的详情 `codeFrame`: `string` — 日志相关的源代码片段 `stack`: `string` — 错误堆栈信息	`LogEntry[]`
`dependencies`(可选)	构建当前资源所依赖的文件路径，当任一依赖文件变化后需要重新构建	`(string \| DependencyCallback)[]`

查看源码
(共 9 行)`AssetType 枚举`只读

表示资源的类型

成员

枚举名	说明	值
`notFound`	资源不存在	`0`
`file`	当前资源是一个文件	`1`
`redirect`	当前资源需要外部重定向到另一个资源	`2`

查看源码
(共 9 行)`AssetUpdateType 枚举`只读

表示资源更新的类型

成员

枚举名	说明	值
`created`	资源被创建	`0`
`changed`	资源被修改	`1`
`deleted`	资源被删除	`2`

Builder

筛选 API全部展开或折叠API

查看源码(共 813 行)Builder 类

构造函数

Builder查看源码(共 88 行)new Builder

参数

属性

方法

Builder查看源码(共 28 行)compileTypeScript

参数

返回值

Builder查看源码(共 46 行)getAsset异步

参数

返回值

Builder查看源码(共 7 行)getMainFileName

参数

返回值

Builder查看源码(共 35 行)runCompiler异步

参数

返回值

Builder查看源码(共 20 行)watch

参数

返回值

Builder查看源码(共 24 行)unwatch

参数

返回值

Builder查看源码(共 32 行)emitUpdate

参数

返回值

Builder查看源码(共 66 行)build异步

参数

返回值

Builder查看源码(共 6 行)getRootDirNames异步

返回值

Builder查看源码(共 7 行)toURL

参数

返回值

Builder查看源码(共 14 行)toShortURL

参数

返回值

Builder查看源码(共 7 行)toPath

参数

返回值

Builder查看源码(共 13 行)getOutputName

参数

返回值

Builder查看源码(共 17 行)getOutputNames

参数

返回值

Builder查看源码(共 13 行)getHTMLOutputName

参数

返回值

Builder查看源码(共 18 行)getInputName

参数

返回值

Builder查看源码(共 14 行)isIgnored

参数

返回值

Builder查看源码(共 7 行)loadPlugin保护

参数

返回值

Builder查看源码(共 126 行)loadAsset异步保护

参数

返回值

Builder查看源码(共 24 行)buildAsset异步保护

参数

返回值

Builder查看源码(共 57 行)buildModule异步保护

参数

返回值

Builder查看源码(共 17 行)getGeneratedURLs异步生成器保护

返回值

查看源码(共 87 行)BuilderOptions 接口

属性

示例

查看源码(共 18 行)Compiler 接口

属性

方法

Compiler查看源码(共 9 行)compile(可选)

参数

API

查看源码
(共 813 行)`Builder 类`

`Builder`查看源码
(共 88 行)`new Builder`

`Builder`查看源码
(共 28 行)`compileTypeScript`

`Builder`查看源码
(共 46 行)`getAsset`异步

`Builder`查看源码
(共 7 行)`getMainFileName`

`Builder`查看源码
(共 35 行)`runCompiler`异步

`Builder`查看源码
(共 20 行)`watch`

`Builder`查看源码
(共 24 行)`unwatch`

`Builder`查看源码
(共 32 行)`emitUpdate`

`Builder`查看源码
(共 66 行)`build`异步

`Builder`查看源码
(共 6 行)`getRootDirNames`异步

`Builder`查看源码
(共 7 行)`toURL`

`Builder`查看源码
(共 14 行)`toShortURL`

`Builder`查看源码
(共 7 行)`toPath`

`Builder`查看源码
(共 13 行)`getOutputName`

`Builder`查看源码
(共 17 行)`getOutputNames`

`Builder`查看源码
(共 13 行)`getHTMLOutputName`

`Builder`查看源码
(共 18 行)`getInputName`

`Builder`查看源码
(共 14 行)`isIgnored`

`Builder`查看源码
(共 7 行)`loadPlugin`保护

`Builder`查看源码
(共 126 行)`loadAsset`异步保护

`Builder`查看源码
(共 24 行)`buildAsset`异步保护

`Builder`查看源码
(共 57 行)`buildModule`异步保护

`Builder`查看源码
(共 17 行)`getGeneratedURLs`异步生成器保护

查看源码
(共 87 行)`BuilderOptions 接口`

查看源码
(共 18 行)`Compiler 接口`

`Compiler`查看源码
(共 9 行)`compile`(可选)

查看源码
(共 11 行)`CompileResult 接口`

查看源码
(共 6 行)`DependencyCallback 类型`

查看源码
(共 2 行)`BuilderPlugin 类型`

查看源码
(共 13 行)`Asset 接口`

查看源码
(共 9 行)`AssetType 枚举`只读

查看源码
(共 9 行)`AssetUpdateType 枚举`只读