这个项目能做什么
Pts 是一个面向可视化和创意编程的 TypeScript 和 JavaScript 库。它提供用于在画布上绘图和动画的原语,并以浏览器脚本和 npm 包两种形式分发。
使用方式
- 浏览器脚本:从 dist 目录下载 pts.js 或 pts.min.js,或从 cdnjs、jsDelivr 或 unpkg 等 CDN 加载。经典脚本将库暴露为 globalThis.Pts。
- 包:使用 npm install pts 安装。该库以 ESM 优先,并提供 CommonJS 兼容入口,因此可以通过 import { CanvasSpace, Group, Line, Pt } from "pts" 导入,或通过 require("pts") 引用。
README 中列出的入门项目和集成包括 pts-starter-kit、pts-react-example 以及 npm 包 react-pts-canvas。项目网站上提供了指南和演示。
开发
维护的构建环境为 Node 24 系列中的 Node 24.18 或更高版本,发布的库也在当前的 Node 20 和 22 版本上进行了测试。设置使用 pnpm install --frozen-lockfile、pnpm exec playwright install chromium 和 pnpm check。单独的命令包括 build、typecheck、test、test:browser、test:integrations、check:package、format 和 format:watch。
pnpm check 命令验证格式、代码检查、类型、单元测试、确定性文档、真实浏览器中的文档和包行为、可复现产物、打包后的包、ESM 和 CommonJS 解析、声明以及 tree-shaking。其打包包集成套件还在 test/integrations 下构建并运行维护的 React、Vue、skia-canvas 和单文件 vanilla 测试装置。
Prettier 定义了仓库的格式规则。运行一次 pnpm format,或保持 pnpm format:watch 运行,会在维护的源文件更改时重新格式化它们。推荐的 VS Code 扩展和工作区设置也在保存时启用 Prettier,而 pnpm check 会在 CI 中拒绝未格式化的更改。
文档生成
文档生成器使用 TypeDoc 的 Node API,从显式源入口点重建自定义静态文档 JSON。它还为无法导航文档 SPA 的代理和其他客户端生成 docs.md、guide.md 和 llms.txt。生成的文档已提交;pnpm check:docs 在内存中重新生成它,报告过期或多余的文件,并在 Chromium 中测试导航、搜索、锚点和响应式布局。
贡献和许可证
欢迎提交问题和小的拉取请求;较大的更改应首先与维护者讨论。该项目根据 Apache License 2.0 许可,版权所有 2017 至今 William Ngan 和贡献者。
评论
0 评分人数达到10人后显示
登录后参与讨论。