NPP 开发快速上手指南

插件开发规范

nitaiPage 给开发者的自由度很高，Npp 几乎可以做常规 JS 文件能做的任何事情，但请遵守以下规范：

1. 在执行敏感操作(包括但不限于收集信息、修改页面元素、发送网络请求等)时，务必将行为告知用户，做好相关日志记录，避免对用户的数据造成风险
2. NPP 内容应遵守法律法规
3. 由 NPP 导致的问题应由 NPP 开发者承担，与 nitaiPage 及 nitaiPage 作者无关
4. NPP 相关 API 可能随时变动，请关注此文档
5. NPP 相关最终解释权归 nitaiPage 作者 所有
6. 持久化请用 NPP API 的 npp.set / npp.get / npp.remove —— 数据永久保存，卸载插件也不会丢失【将来用户可以一键清理已卸载插件的残留数据】localStorage 也可以用，但不建议（卸载后残留、用户无法清理）；Cookie 不要用（浏览器扩展环境下不可用，见NPP API）

开发环境

方式一：使用官方 CLI 工具（推荐）

使用官方 CLI 工具可以快速创建、验证和调试插件：

npm install -g nitaipage-npp-cli

详细使用方法请参考 NPP 开发工具

方式二：手动开发

1. 文本编辑器
2. 浏览器

创建插件

创建插件文件

创建一个新的 JavaScript 文件（例如 myFirstNpp.js ），并添加以下基本结构：

// ==Npplication==
// @name 第一个插件
// @id 1789000000000_3f2a1b4c-5d6e-4f70-8a91-b2c3d4e5f607
// @version 1.0.0
// @time body
// ==/Npplication==
console.log('hello world!');

// 函数
function myFirstNppFunction() {
    alert('hello world!');
}

// 事件监听
document.addEventListener('DOMContentLoaded', function() {
    // 页面加载完成后执行
    console.log('页面已加载');
    myFirstNppFunction();
});

关于元数据

MetaData 详解

测试

使用 CLI 工具测试（推荐）

# 启动开发服务器（默认端口 11126）
npplication dev

# 或指定端口
npplication dev --port 11124

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

注意：CLI 开发服务器已自动配置 CORS，无需手动设置。

手动测试

1. 开启文件服务器，获取 JS 文件 URL (注意跨域(CORS)问题)
2. 开启 NitaiPage 浏览器控制台
3. 执行 installNpplication(JSUrl) 安装插件

发布插件

1. 将插件代码上传到可公开访问的服务器 (注意跨域(CORS)问题)
2. 确保插件文件可以通过 HTTP/HTTPS 访问
3. 在 Npplication 商店源 中添加插件信息

常见问题

Q: 插件无法加载怎么办？

A: 检查浏览器控制台是否有错误信息，确保插件元数据格式正确，依赖项已安装。

Q: 如何更新插件？

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