SuperAPI AI 工具集

obsidian-scaffold

编程与开发

查看项目

更新于 10-15 11:09

技能介绍

Obsidian Plugin Scaffold 用于从零生成一个符合 Obsidian 社区插件自动审核规则的新插件项目。它的目标是在项目创建之初就满足审核要求,减少后续返工。

用途 用于创建新的 Obsidian 社区插件工程,生成项目布局、清单文件、TypeScript 配置、esbuild 配置以及一个可通过自动化审核的最小插件类。

主要能力与生成内容 该技能会创建如下结构: my-plugin/ src/main.ts(包含 onload/onunload 的插件类) styles.css(空的、作用域受限的样式) manifest.json(有效的、符合审核规则的清单) package.json(依赖:obsidian、typescript、esbuild、@types/node) tsconfig.json(strict: true,target ES2018,moduleResolution node) esbuild.config.mjs(CJS 打包,externalize obsidian + electron) eslint.config.mjs(eslint-plugin-obsidianmd 与 eslint-comments 的 flat config) LICENSE(MIT,使用当前年份) README.md(最小描述) .gitignore(node_modules、main.js、data.json)

使用方式 这是一个技能(skill),不是斜杠命令。通过请求“创建一个新的 Obsidian 插件”来调用,或使用其技能名 obsidian-development:obsidian-scaffold,然后按提示填写插件 ID、名称、作者和描述。

流程会要求填写:插件 ID(字母数字和短横线,不含 obsidian,不以 plugin 结尾)、插件名称(不含 Obsidian,不以 Plugin 结尾)、作者名、描述(不含 Obsidian,不以 This plugin 开头,以 . ? ! 结尾,且少于 250 字符)、作者 URL(可选)、是否仅桌面端(默认 false)。

输入会按 Obsidian 自动审核规则进行校验:ID 匹配 /^[a-z0-9-]+$/,不含 obsidian,不以 plugin 结尾;名称不含 Obsidian,不以 Plugin 结尾;描述不以 This plugin 开头,不含 Obsidian,以 .?! 结尾。 随后使用模板创建全部文件,运行 npm install 安装依赖,并验证 npx tsc --noEmit 零错误通过。

适用场景 适合需要新建 Obsidian 社区插件、并希望项目一开始就符合官方审核规范(清单、TypeScript、esbuild、ESLint 配置齐全)的开发者。

限制与后续提醒 创建完成后需注意:开发时运行 npm run dev 进入监听模式;生产构建运行 npm run build;本地检查审核规则运行 npm run lint;发布时创建 GitHub release,将 main.js、manifest.json、styles.css 作为独立资源上传;release 标签必须与 manifest.json 中的版本完全一致(不加 v 前缀);在 community.obsidian.md 提交新插件(用 Obsidian 账户登录、关联 GitHub,然后在 Plugins > New plugin 填入仓库 URL);旧的向 obsidianmd/obsidian-releases 提交 PR 的流程已于 2026 年 5 月退役;更新无需在面板操作,每次新的 GitHub release 都会被审核系统自动扫描。

以上信息中未提供的内容(如收费、价格、平台等)暂未提供。