1 Star 3 Fork 0

LvHuaiSheng / leafer-x-ruler

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
template.md 1.57 KB
一键复制 编辑 原始数据 按行查看 历史
LvHuaiSheng 提交于 2023-12-14 17:11 . init

插件开发模版

Typescript + Rollup.js + Vite + Vitest 点此下载模版

git clone https://github.com/leaferjs/LeaferX

目录结构

main.ts # 开发插件时用的调试demo入口,可以引入 leafer-ui 进行开发调试插件
src # 插件代码主目录, 只能引入 @leafer-ui/core、@leafer-ui/interface

package.json  # 根据需要修改插件名、入口文件等信息,支持web与node环境
tsconfig.json # typescript 配置文件
rollup.config.js # 需修改导出的全局变量名,rollup 打包脚本配置文件

.gitignore # 提交git时忽略哪些文件和目录
.eslintrc.js # 代码语法检查配置
.prettierrc # 代码格式化配置

__tests__ # 单元测试目录

README.md # 插件介绍,需修改为你自己的内容
LICENSE # 授权文件,修改为你自己的姓名

# 自动创建
dev # 开发目录,放置以 main.ts 作为入口的 demo 打包代码
dist # 打包目录,放置以 src/index.ts 作为入口的打包代码
types # 放置插件的 d.ts 类型描述文件

运行

npm run start # 开始运行项目

npm run build # 打包插件代码,同时会创建types

npm run test # 自动化测试

代码风格

使用 @typescript-eslint, 单引号优先、句尾无分号,可以给编辑器设置保存时自动格式化。

建议大家保持一致的代码风格,这样互相 review 代码,提 PR 比较方便。

1
https://gitee.com/sourcenet/leafer-x-ruler.git
git@gitee.com:sourcenet/leafer-x-ruler.git
sourcenet
leafer-x-ruler
leafer-x-ruler
master

搜索帮助