Repository files navigation

Example plugin for WinJS.

Install:

npm add winjs-plugin-example -D

Add plugin to your.winrc.ts:

// .winrc.tsexportdefault{plugins:['winjs-plugin-example'],// 开启配置example:{}};

Some description.

• Type:string
• Default:undefined
• Example:

exportdefault{plugins:['winjs-plugin-example'],// 开启配置example:{foo:'bar'}};

1. 使用此模板创建新的 WinJS 插件项目
2. 修改包名为你的插件名称

使用模板后，如果你修改了 npm 包名，需要更新以下文件中的包名引用：

修改以下字段：

• name: 将winjs-plugin-template 改为你的新包名
• repository.url: 更新为你的仓库地址

{"name":"your-plugin-name","repository": {"type":"git","url":"git+https://github.com/your-org/your-plugin-name.git"  }}

需要更新以下位置的包名引用：

• 文档标题（第一行）
• npm 版本徽章链接中的包名
• npm 下载量徽章链接中的包名
• 安装命令中的包名
• 使用示例中的插件名称

将所有的winjs-plugin-example 替换为你的新包名。

如果你的项目中有其他配置文件引用了包名（如renovate.json、CHANGELOG.md 等），也需要相应更新。

• 修改src/index.ts 中的key 值（当前为example）为你的插件配置键名
• 根据插件功能完善Options 配置说明
• 更新README.md 中的插件描述和功能说明

安装依赖：

pnpm install

开发模式（监听文件变化自动构建）：

pnpm run dev

构建项目：

pnpm run build

代码格式检查：

pnpm run lint

自动修复代码格式：

pnpm run lint:write

运行测试：

pnpm runtest

本地测试插件：

在playground 目录中测试插件功能：

cd playgroundpnpm installpnpm run dev

版本号管理：

pnpm run bump

1. 在src/index.ts 中实现插件逻辑
2. 运行pnpm run dev 监听文件变化
3. 在playground 目录中运行pnpm run dev 测试插件
4. 运行pnpm run lint:write 确保代码格式正确
5. 运行pnpm run test 确保测试通过
6. 提交代码前运行pnpm run build 确保构建成功

MIT.