create-ax-trusted-plugin
v1.0.17
Published
可信(internal)插件脚手架:一条命令生成一个基于 @ax-npm/host-trusted-sdk-v4 的可信插件骨架(ESM 直出 activate + 自带 Vue,dev 裸 vite 原生 sourcemap)。用法:npm create ax-trusted-plugin <id>。生成器本身无机密,公网可装;生成出的工程仍走私有源拉 @ax-npm/* 依赖。
Maintainers
Readme
create-ax-trusted-plugin
可信(internal)插件脚手架:一条命令生成一个基于 @ax-npm/host-trusted-sdk-v4 的可信插件骨架
(ESM 直出 activate + 自带 Vue + 自定义元素面板 + 调 map.flyTo + 遥测订阅;
dev 走裸 vite,原生 sourcemap、无构建步)。
脚手架本身已发公网 npm,生成这步零配置;生成出的工程才走私有源(
192.168.1.209GitLab)拉@ax-npm/*依赖,届时只需一个GITLAB_TOKEN(无需手建任何.npmrc,工程自带)。
用法
# 交互式(缺参数会提示输入 id/标题/锚点)
npm create ax-trusted-plugin@latest my-panel
# 非交互(传参)
npm create ax-trusted-plugin@latest my-panel -- --title "我的面板" --anchor top-right等价于直接跑 bin:node bin/index.mjs my-panel --title "我的面板" --anchor top-right。
生成 my-panel/ 后(把 GITLAB_TOKEN 换成你的只读 PAT,按所用 shell 选一行):
cd my-panel
export GITLAB_TOKEN=<读权限 PAT> # bash / git-bash
# $env:GITLAB_TOKEN="<读权限 PAT>" # PowerShell
# set GITLAB_TOKEN=<读权限 PAT> # cmd
npm install
npm run dev参数
| 参数 | 说明 | 默认 |
|---|---|---|
| <id>(位置参数) | 插件 id,小写短横线 | 必填(缺则提示) |
| --title | 面板标题 | 由 id 推导 |
| --anchor | 浮层锚点 | top-right |
锚点可选:top-left/top-right/top-center/bottom-left/bottom-right/bottom-center/left-center/right-center/center。
生成内容
template/ 经占位替换(__ID__/__TITLE__/__ANCHOR__)后落地:src/{index.ts,Panel.vue,state.ts}、
manifest.json(trust:internal、entry:main.js)、vite.config.ts(一行调 trustedPluginConfig 预设)、
package.json、tsconfig.json、.npmrc、.gitignore、README.md。
发布(维护者)
脚手架包发公网 npm(publishConfig 已指向 registry.npmjs.org、access: public):
npm login --registry https://registry.npmjs.org/ # 首次
npm publish --otp=<6位验证码> # npm 强制 2FA,验证码来自验证器 App- 若提示包名被占,改
package.json的name(及随之的npm create <name>用法)。 - 自动化/CI 免输码:在 npm 生成「可绕过 2FA 的 Granular Access Token」,
以
//registry.npmjs.org/:_authToken=<token>注入后npm publish。
注意:
template/内仍引用私网地址192.168.1.209(RFC1918 不可路由,非机密),发公网后会公开可见。
源码仓:GitLab 项目 1244。
