@boost/plugin

中文文档
5.0.0发布于 2024/03/01MITTypeScriptES Module近 30 天下载 6368

基于插件的架构支持模块加载,自定义类型,注册,范围等等.

中文使用文档
文档目录3 节
  1. 特征
  2. 安装
  3. 文档

插件 - 脚

build status npm version

基于插件的架构支持模块加载,自定义类型,注册,范围等等.

import { Registry, Pluggable } from '@boost/plugin';

export interface Renderable<T> extends Pluggable<T> {
  render(): string | Promise<string>;
}

const registry = new Registry<Renderable>('boost', 'plugin', {
  validate(plugin) {
    if (typeof plugin.render !== 'function') {
      throw new TypeError('Plugins require a `render()` method.');
    }
  },
});

const plugin = await registry.load('boost-plugin-example');

特征

  • 自定义插件类型和注册 .
  • 节点模块,文件路径,以及配置文件加载策略.
  • 多个模块名称格式:公用,范围公用,范围私用.
  • 结构合同与生命周期事件.
  • 用于插件创建的工厂函数模式 .
  • 默认同步 .

安装

yarn add @boost/plugin

文档

版本与发布记录

@boost/plugin 共发布 41 个版本,首次发布于 2020/02/04;过去 12 个月发布了 0 个版本。

版本发布日期距今
5.0.0latest2024/03/012 年前
5.0.0-alpha.2next2024/02/272 年前
5.0.0-alpha.12024/02/122 年前
4.0.12023/05/023 年前
4.0.02022/08/194 年前
4.0.0-alpha.12022/05/034 年前

关于 @boost/plugin 的常见问题

@boost/plugin 是什么?

基于插件的架构支持模块加载,自定义类型,注册,范围等等.

如何安装 @boost/plugin?

在项目目录运行 npm install @boost/plugin,或使用 pnpm add / yarn add / bun add。

@boost/plugin 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@boost/plugin 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@boost/plugin 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18.12.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@boost/plugin 可以商用吗?

@boost/plugin 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@boost/plugin 的下载量有多少?

根据 npm 官方下载统计,@boost/plugin 在 2026/10/09 – 2026/11/07 这 30 天内被下载 6,368 次,日均约 212 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@boost/plugin 还在维护吗?

最新版本 5.0.0 发布于 2024/03/01(2 年前);至今共发布 41 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/02/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。