项目简介
本项目是一个基于React.js和TypeScript的WPS插件开发框架,为开发者提供模块化、现代化的开发环境,用于快速构建和测试WPS插件。TypeScript的使用让项目具备更好的类型安全性与代码可维护性,React.js则助力构建动态且响应式的用户界面。
项目的主要特性和功能
- 模块化开发:运用TypeScript进行模块化开发,支持现代JavaScript特性,增强代码可维护性与可扩展性。
- 自动化编译:借助Webpack和TypeScript配置,实现自动编译和热更新,开发时无需手动编译代码。
- WPS API集成:对WPS API进行封装,开发者能通过TypeScript调用WPS API,操作Excel、Word等文档。
- 开发与构建分离:支持开发环境和生产环境分离,开发用
npm start
实时编译,发布用npm run build
生成优化版本。 - 丰富的开发工具:集成VS Code、Node.js、TypeScript等开发工具,提供完整开发体验。
安装使用步骤
环境准备
安装项目依赖
在项目根目录下执行以下命令,安装项目所需的依赖:
bash
npm i
开发与调试
- 使用VS Code打开项目目录。
- 在项目根目录下执行以下命令,启动开发服务器:
bash npm start
此命令会监控src
目录下的文件变化,自动编译并将输出文件保存到web
目录。开发过程中,可通过WPS加载main.rb
文件来测试插件,WPS会自动加载web
目录下的index.html
文件。
构建发布版本
在项目根目录下执行以下命令,生成优化后的发布版本:
bash
npm run build
该命令会将编译后的文件、SDK文件等打包到dist
目录,生成一个完整的可执行插件。可以使用WPS加载dist/main.rb
文件来测试发布版本。
注意事项
- 开发时,请勿直接修改
web
目录下的文件,所有源代码应放在src
目录下。 - 若开发中遇到控制台阻塞或编译不及时的情况,可尝试按回车键或使用
Ctrl+C
终止命令后重新执行。 - 项目依赖的WPS SDK和相关API可能因版本不同而有差异,请根据实际情况调整代码。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】