@ham2k/extension-sdk

中文文档
1.26.0发布于 2026/11/15MITTypeScriptES Module零依赖近 30 天下载 5957

为 Ham2K Logger 写入扩展: 已键入钩子合同和主机 API

中文使用文档
文档目录4 节
  1. 参考文献在此包中
  2. 版本数
  3. 导出类型和设置
  4. 关于同伴的依赖关系

@ham2k/ extension- sdk

写入扩展名 Ham2K 调试器 ——打入的钩子 合同和主机API的扩展是针对构建的.

npm install @ham2k/extension-sdk
npm install --save-dev @ham2k/extension-tools esbuild
import { defineExtension } from "@ham2k/extension-sdk"
import type { PanelHook } from "@ham2k/extension-sdk"

import manifest from "../manifest.json"

const HelloPanel: PanelHook = {
  async getPanels() {
    return [{ key: "hello", title: "Hello World", icon: "hand-wave-outline" }]
  },
  async render() {
    return { kind: "markdown", content: "# Hello, World!" }
  },
}

defineExtension({
  ...manifest,
  onActivation({ registerHook }) {
    registerHook("panel", { key: manifest.key, hook: HelloPanel })
  },
})

一个面板返回 内容,而不是部件——这就是不让扩展到 应用程序的UI工具包.

npx -p @ham2k/extension-tools h2kext-init <yourcallsign>-<name> 写入 所有这一切和构建脚本;同一软件包将结果包成 .h2kext 应用程序可以安装.

参考文献在此包中

samples/ 每个形状都有一个工作过的扩展,即与 它需要的证书,一个颁奖程序,一个比赛及其计分器,一个HTML 显示面板。 每一个建筑和包; 每一个在标题中说它漏出的东西.

AGENTS.md 除了这个文件,还有地图—— 清单,沙盒的极限, 和哪一个 docs/ 回答什么问题. docs/ 保存文件本身: 正在启动, 扩展如何运行, 列表, 主机 API, 每个钩 类别、表格、设置面板、模板、包装和出版.

他们用包裹旅行,而不是被连接,所以可以读取 离线并描述安装在此的版本,而不是任何 仓库今天说。 如果代理正在写您的扩展名,请指向 node_modules/@ham2k/extension-sdk/AGENTS.md —— 说 h2kext-init 这样做是为了你.

版本数

小版本为扩展API:SDK 1.26描述API 26 以 API_VERSION。 。 。 . @ham2k/extension-tools 遵循同样的规则, 这样 ^1.19.0 范围表示扩展需要 API 19 并每晚承认一次 一个 一个主要的版本是打破已写入扩展的更改.

导出类型和设置

导出钩头可以注册共享类型 getExportTypes()启用 exportTypeDefinition(activationType, format, label) 为共享身份 为同一活动服务的延长. exportType 确定设置; exportKey 识别单个文件,例如激活中的一个公园.

这个 activityExportHook 财务报告和审定财务报表 huntingExportHook 帮助者注册其类型 并转发到 ADIF 生成器。 参考活动类型 使用情况 templateCategory: 'reference';其他类型使用其他活动默认值. GlobalExportSettings 提供单独的普通文件名、 紧凑的文件名, 和每个类别的标题模板,加上共享的 ADIF 字段模板.

在从 SDK 0.3 更新出口商时,保留特定参考标识符 内 exportKey,登记一个稳定 exportType和前进 exportSettings, (中文(简体) ), exportData, (中文(简体) ), exportTitle,以及 includeLookupData 当授予世代. 每个类型的自定义模板仅在启用时才会覆盖所继承的默认值. 见 docs/import-export.md § 翻译:export 整个合同和 docs/forms.md 联 合 国 textTemplate 窗体字段.

关于同伴的依赖关系

这个软件包列出扩展主机携带的库—— @ham2k/lib-*, (中文(简体) ), i18next, (中文(简体) ), liquidjs 作为 选项 同伴,你几乎肯定不会 需要安装任何它们.

您的扩展声明于 manifest.json 他们用哪一种 在主机的单个实例上将每个重写为查看 esbuilt 永远到达文件系统。 带主机上去是值得的 大约是捆绑大小的30倍 出版的种类都卷了起来 中,所以您的编辑器只安装了这个软件包.

只安装一个给 inline 运送自己的副本 因为你需要一个 版本的主机不携带.

版本与发布记录

@ham2k/extension-sdk 共发布 63 个版本,首次发布于 2026/08/31;过去 12 个月发布了 63 个版本。

版本发布日期距今
1.26.0latest2026/11/151 天前
1.25.02026/11/152 天前
1.24.02026/11/124 天前
1.23.22026/11/125 天前
1.23.12026/11/116 天前
1.23.02026/11/116 天前

关于 @ham2k/extension-sdk 的常见问题

@ham2k/extension-sdk 是什么?

为 Ham2K Logger 写入扩展: 已键入钩子合同和主机 API

如何安装 @ham2k/extension-sdk?

在项目目录运行 npm install @ham2k/extension-sdk,或使用 pnpm add / yarn add / bun add。

@ham2k/extension-sdk 支持 TypeScript 吗?

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

@ham2k/extension-sdk 支持 ESM 还是 CommonJS?

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

@ham2k/extension-sdk 需要什么版本的 Node.js?

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

@ham2k/extension-sdk 可以商用吗?

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

@ham2k/extension-sdk 的下载量有多少?

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

@ham2k/extension-sdk 还在维护吗?

最新版本 1.26.0 发布于 2026/11/15(1 天前);至今共发布 63 个版本,其中过去 12 个月发布了 63 个;首次发布于 2026/08/31。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。