Skip to content

NPP 开发工具

NitaiPage 提供了官方的命令行工具 npplication-CLI,旨在帮助开发者快速创建、验证和调试 NPP 插件

[Github 仓库] [NPM Package]

安装

bash
npm install -g nitaipage-npp-cli

功能特性

  • 🚀 快速创建插件文件或商店 JSON 文件
  • 🔧 集成本地开发服务器
  • 🔍 插件元数据验证
  • 📦 插件代码压缩

命令参考

创建新插件

bash
npplication create

# 可直接指定名称
npplication create my-plugin

# 使用别名
npplication c my-plugin

# 快速生成插件 ID
npplication c -id
# 或
npplication create --id

创建向导会提示输入以下信息:

  • 插件名称
  • 插件描述
  • 作者信息
  • 加载时机(head/body)
  • 插件类型(normal/coreNpp/translate)
  • 图标 URL(可选)
  • 截图 URL(可选)
  • 是否需要设置界面(可选)
  • 是否开启强制更新(可选)
  • 依赖项(可选)

启动开发服务器

bash
# 使用默认端口 11123
npplication dev

# 指定端口
npplication dev --port 11124

# 使用别名
npplication d

在 NitaiPage 浏览器控制台执行显示的安装命令即可安装插件并进行调试。

注意:开发服务器已自动配置 CORS,无需手动设置。

验证插件

bash
# 验证当前目录的插件文件
npplication check

# 验证指定文件
npplication check --file path/to/plugin.js

验证功能会检查:

  • 元数据格式
  • 必需元数据
  • ID 格式(13位时间戳 + UUID v4)
  • 版本号格式
  • 加载时机
  • 翻译插件的语言代码(仅翻译插件)

构建插件(压缩插件)

bash
# 构建当前目录的插件文件
npplication build

# 构建指定文件
npplication build --file path/to/plugin.js

# 使用别名
npplication b

构建功能会:

  • 压缩插件代码
  • 生成 plugin-compressed.js 文件
  • 自动验证构建结果

创建商店 JSON 文件

bash
npplication store

# 使用别名
npplication s

开发工作流

1. 创建项目

bash
npplication create my-plugin
cd my-plugin

2. 开发插件

编辑生成的 my-plugin.js 文件,实现你的插件功能。

3. 本地调试

bash
npplication dev

在 NitaiPage 控制台执行显示的安装命令。

4. 验证插件

bash
npplication check

5. 构建压缩

bash
npplication build

命令速查表

命令别名说明
npplication create <name>npplication c创建新插件项目
npplication create --idnpplication c -id快速生成插件 ID
npplication dev --port <port>npplication d启动开发服务器
npplication check-验证插件元数据
npplication buildnpplication b构建插件
npplication storenpplication s创建商店 JSON 文件

常见问题

Q: 如何更新插件?

A: 更新插件文件并增加版本号,NitaiPage 会自动检测更新。或者再次在控制台执行 installNpplication(JSUrl) 覆盖安装插件。

Q: 如何设置 CORS?

A: 开发服务器已自动配置 CORS,无需手动设置。

Q: 开发服务器端口被占用怎么办?

A: 使用 --port 参数指定其他端口,例如:npplication dev --port 11124

相关链接

Released under the Apache-2.0 License.