TypeScript Plugin Runtime
Pluxel
写一个普通的 TypeScript 类,直接在构造函数中注入所需插件。 配置校验、路由挂载与资源回收清晰直观,开发阶段支持快速热重载。
import { HealthPlugin } from '@acme/health' // 值导入:提供必需依赖的来源
import type { AuditPlugin } from '@acme/audit' // 类型导入:不会加载可选插件
const Audit = definePluginRef<AuditPlugin>() // 模块级引用:声明可选依赖
@Plugin()
class StatusPlugin extends BasePlugin {
constructor(readonly health: HealthPlugin) { super() } // 构造器参数:注入必需依赖
protected override init() {
// init 中的直接语句:消费可选依赖
this.plugins.use(Audit, (audit) => audit.attach(this))
}
status() { return this.health.status() } // 直接调用必需依赖
}直接看日常写法
写 Plugin 最常用的三个位置
01
注入依赖
constructor(private readonly http: WretchPlugin) { super() }需要另一个 Plugin 时,直接写构造函数参数。类型就是依赖声明。
阅读文档02
读取配置
private readonly config = this.configs.use(StatusConfig)读取经过默认值和校验的冻结配置,不再维护平行的 TypeScript interface。
阅读文档03
登记清理
this.ctx.effects.defer(() => clearInterval(timer))创建资源后立即登记释放函数;停止、替换和启动回滚都会执行。
阅读文档最后放进宿主
Plugin 写法不随宿主改变
固定插件目录
import { defineHostApplication } from '@pluxel/host'
import { OrdersPlugin } from '@app/orders'
export default defineHostApplication(() => ({
plugins: [OrdersPlugin],
}))插件清单在应用构建时静态打包,开发时支持实时热更新。通过 policy.autoStart 指定应用启动时默认运行的插件。
配置宿主增加动态来源
import { defineHostApplication } from '@pluxel/host'
import { pluginSource } from '@pluxel/host/sources'
export default defineHostApplication(() => ({
plugins: [],
sources: [pluginSource({
kind: 'directory', path: './plugins',
include: ['*.mjs'],
})],
}))开发期间可在指定目录新增、更新或移除插件文件,宿主会自动发现变动并按运行策略加载。
配置宿主同一份应用,开发与生产共用
在应用配置中按需挂载核心服务;本地尝鲜支持纯内存模式,生产部署可自由配置持久化存储。
安装服务
import { defineHostApplication } from '@pluxel/host'
import { servicesPreset } from '@pluxel/services/preset'
export default defineHostApplication(async (startup) => ({
plugins: [],
services: await servicesPreset(startup, {}),
}))开发与热更新
import { defineConfig } from 'vite'
import { vitePreset } from '@pluxel/services/vite'
export default defineConfig({
plugins: [vitePreset({
entry: './src/app.ts', devConsole: true,
})],
})生产构建
import { defineConfig } from 'vite-plus/pack'
import { pluxel } from '@pluxel/rolldown'
export default defineConfig({
entry: './src/app.ts',
plugins: [pluxel()],
})