类型文件插件概览

概览

这个寄存器由几个插件组成,可以扩展其容量 类型文件。 。 。 .

[尖叫声] 这个 @ckeditor/typedoc-plugins 需求 [email protected]。 。 。 .

在启用软件包的插件之前,需要先安装.

npm install @ckeditor/typedoc-plugins

下面可以找到可用插件的详细概览.

使用量

用来使用 typedoc-plugins,需要创建 Typedoc 应用程序实例.

import { Application } from 'typedoc';
import { typeDocSymbolFixer } from '@ckeditor/typedoc-plugins';

const app = await Application.bootstrapWithPlugins( { /* Typedoc options. */ } );

// It is essential to execute a plugin before converting the project.
typeDocSymbolFixer( app );

const conversionResult = await typeDoc.convert();

可用的插件

• 模块修正器 —— 说 typeDocModuleFixer()

  插件读取 : @module 注释.

  import type { TypeDefinition } from '...';
  
  /**
   * @module package/file
   */
  

  就上述例子而言,解析模块的名称应等于 package/file。 。 。 .

  这个 import 语句可以在"@module"区块代码上方指定. 在这种情况下,默认模块解析从 typedoc 返回基于相对于工程根的路径的模块名称.

• 符号修正器 —— 说 typeDocSymbolFixer()

  插件重命名 Symbol.* 定义采用JSDoc风格.

  • 类型doc : [iterator]() → Iterator
  • 联合来文: Symbol.iterator() → Iterator

• 接口增强修复器 —— 说 typeDocInterfaceAugmentationFixer()

  插件试图修复一个接口, 该接口已经从外部( 从另一个模块) 延伸出来 index.ts 文档。 当扩展"declare module..."声明包含完整包名时,它指向 index.ts 文件而非实际源文件。 目标是从界面中将缺失的属性添加到其源位置.

• 事件参数修正器 —— 说 typeDocEventParamFixer()

  该插件注入 eventInfo 参数(一个实例) EventInfo class)作为每次事件反射的第一个参数.

• 事件遗产确定者 —— 说 typeDocEventInheritanceFixer()

  插件会照顾到继承事件, 事件是手工创建的 @eventName 注释.

• 等级修正器 —— 说 typeDocHierarchyFixer()

  该插件通过扩展中间混音常数来恢复被打破的类分级,例如. const ClassicEditorBase = ElementApiMixin( Editor ),它用实际的基类取代了不可解的基础类参考,恢复了基类上"子类"关系,并列出了由扩展类执行的混音接口. 它还删除了指向从私人包中清除出反射的引用.

  插件必须在之后执行 typeDocEventInheritanceFixer(),因为继承事件解决了被这个插件所取代的原始(断)引用.

• 清除私有 API —— 说 typeDocPurgePrivateApiDocs()

  插件去除从私人软件包中收集的反射( 标记为 "private": true 中标 package.json) (中文(简体) ). 要禁用机制,请添加 @publicApi 文件开头的注释.

• 标记 @error —— 说 typeDocTagError()

  插件收集错误定义 @error 注释.

• 标记 @eventName —— 说 typeDocTagEvent()

  插件收集事件定义 @eventName 注释并指定他们为班级或班级的儿童 Observable 接口.

  我们没有使用 @event 注释,从JSDoc规格中得名,因为它在"TypeDoc"中有着特殊的意义,并且很难让它如我们所期望的那样工作.

• 标记 @observable —— 说 typeDocTagObservable()

  添加支持从属性创建 CKEditor 5 事件 @observable。 。 。 .

• 转换后恢复程序 —— 说 typeDocRestoreProgramAfterConversion()

  插件恢复用于源转换的TypeScript程序. 类型文件删除 context.program 属性,一旦转换完成,则防止其他插件监听 EVENT_END 使用 TypeScript API 生成的事件.

• 参考修正器 —— 说 typeDocReferenceFixer()

  插件将从另一个文件中再导出的反射修正为默认导出 。 在这种情况下,TypeDoc将反射声明添加到包含再导出的文件上,而实际的源文件只包含一个引用. 插件将声明移回源地址 .

• 产出清理 —— 说 typeDocOutputCleanUp()

  插件会从反射中去掉不必要的属性来缩小生成输出的大小.

• 验证器 —— 说 validate()

  验证 CKEditor 5 文档 。 它验证 @see 财务报告和审定财务报表 @link 参考文献和 @fires 注释。 选择,当 enableOverloadValidator 选项,它也验证超载签名是否使用 @label 注释.

更改日志

见 CHANGELOG.md 文档.