动态- cli- 框架- api

API 用于 动态框架

使用量

插件作者应该依赖于此软件包( 不是完整的) @flowscripter/dynamic-cli-framework作为 peerDependency数字 :

{
  "peerDependencies": {
    "@flowscripter/dynamic-cli-framework-api": "*",
  },
}

主要出口:

• createCLIPlugin - 脚手架助手来建造一个 CLIPlugin 从a CommandFactory 和(或) ServiceProviderFactory。 。 。 .
• CommandFactory, (中文(简体) ), ServiceProviderFactory - 插件实施的扩展接口.
• Command, (中文(简体) ), SubCommand, (中文(简体) ), GlobalCommand, (中文(简体) ), GroupCommand - 命令类型.
• Context, (中文(简体) ), CLIConfig - 运行时背景传递给命令.
• 核心服务接口及其 *_SERVICE_ID 标识符(PrinterService, (中文(简体) ), TableGeneratorService, (中文(简体) ), SyntaxHighlighterService, (中文(简体) ), ConfigurationService(例如)过去通过 Context。 。 。 .
• StartupService编号 :StartupTask, (中文(简体) ), ShutdownService编号 :ShutdownTask - 优先安排的登记工作,以便在CLI启动/关闭期间运行一次,通过 registerTask({id, priority, run}) 无论是.

见 动态框架 (d) 实施可操作的框架及其具体服务.

API 密码

链接自动生成的 API 文件 :

API 文档

发展

安装依赖性 :

bun install

构建(生产) dist/ 对于Node.js和TypeScript消费者; Bun 直接使用原始来源:

bun run build

格式 :

bunx oxfmt

林特:

bunx oxlint index.ts src/ tests/

生成 HTML API 文档 :

bunx typedoc index.ts

许可证

麻省理工学院