À propos du projet
Pts est une bibliothèque TypeScript et JavaScript destinée à la visualisation et au codage créatif. Elle fournit des primitives pour dessiner et animer sur canvas, et est distribuée à la fois comme script navigateur et comme paquet npm.
Options d'utilisation
- Script navigateur : téléchargez pts.js ou pts.min.js depuis le répertoire dist, ou chargez-les depuis un CDN tel que cdnjs, jsDelivr ou unpkg. Le script classique expose la bibliothèque comme globalThis.Pts.
- Paquet : installez avec npm install pts. La bibliothèque est d'abord ESM et fournit également une entrée de compatibilité CommonJS, elle peut donc être importée avec import { CanvasSpace, Group, Line, Pt } from "pts" ou requise avec require("pts").
Les projets de démarrage et les intégrations listés dans le README incluent pts-starter-kit, pts-react-example, et le paquet npm react-pts-canvas. Des guides et des démos sont disponibles sur le site du projet.
Développement
L'environnement de build maintenu est Node 24.18 ou plus récent dans la ligne Node 24, et la bibliothèque publiée est également testée sur les versions actuelles de Node 20 et 22. La configuration utilise pnpm install --frozen-lockfile, pnpm exec playwright install chromium, et pnpm check. Les commandes individuelles incluent build, typecheck, test, test:browser, test:integrations, check:package, format et format:watch.
La commande pnpm check valide le formatage, le linting, les types, les tests unitaires, la documentation déterministe, la documentation et le comportement du bundle dans un vrai navigateur, les artefacts reproductibles, le paquet empaqueté, la résolution ESM et CommonJS, les déclarations, et le tree-shaking. Sa suite d'intégration de paquet empaqueté construit et exécute également des fixtures React, Vue, skia-canvas et vanilla à fichier unique maintenues sous test/integrations.
Prettier définit les règles de formatage du dépôt. Exécuter pnpm format une fois, ou garder pnpm format:watch en cours, reformate les fichiers source maintenus à mesure qu'ils changent. L'extension VS Code recommandée et les paramètres d'espace de travail activent également Prettier à la sauvegarde, tandis que pnpm check rejette les changements non formatés dans CI.
Génération de documentation
Le générateur de documentation utilise l'API Node de TypeDoc pour reconstruire le JSON de documentation statique personnalisé à partir de points d'entrée source explicites. Il génère également docs.md, guide.md, et llms.txt pour les agents et autres clients qui ne peuvent pas naviguer dans la SPA de documentation. La documentation générée est vérifiée ; pnpm check:docs la régénère en mémoire, signale les fichiers obsolètes ou supplémentaires, et exerce la navigation, la recherche, les ancres et les mises en page réactives dans Chromium.
Contribution et licence
Les problèmes et les petites demandes de tirage sont les bienvenus ; les changements plus importants devraient commencer par une discussion avec le mainteneur. Le projet est sous licence Apache License 2.0, copyright 2017-présent William Ngan et contributeurs.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.