इस प्रोजेक्ट के बारे में
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, और react-pts-canvas npm पैकेज शामिल हैं। गाइड और डेमो प्रोजेक्ट साइट पर उपलब्ध हैं।
विकास
बनाए रखा गया बिल्ड वातावरण 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 रिज़ॉल्यूशन, डिक्लेरेशन, और ट्री-शेकिंग को मान्य करता है। इसका पैक्ड-पैकेज एकीकरण सूट test/integrations के अंतर्गत बनाए रखे गए React, Vue, skia-canvas, और सिंगल-फ़ाइल vanilla फ़िक्स्चर को भी बनाता और चलाता है।
Prettier रिपॉज़िटरी की फ़ॉर्मेटिंग नियम परिभाषित करता है। pnpm format एक बार चलाने से, या pnpm format:watch चालू रखने से, बनाए रखी गई स्रोत फ़ाइलें बदलते ही पुनः फ़ॉर्मेट हो जाती हैं। अनुशंसित VS Code एक्सटेंशन और वर्कस्पेस सेटिंग्स भी सेव पर Prettier सक्षम करती हैं, जबकि pnpm check CI में बिना फ़ॉर्मेट किए बदलावों को अस्वीकार करता है।
डॉक्युमेंटेशन जनरेशन
डॉक्युमेंटेशन जनरेटर TypeDoc के Node API का उपयोग करके स्पष्ट स्रोत प्रविष्टि बिंदुओं से कस्टम स्टैटिक डॉक्युमेंटेशन JSON को पुनः बनाता है। यह docs.md, guide.md, और llms.txt भी उत्पन्न करता है उन एजेंट और अन्य क्लाइंट के लिए जो डॉक्युमेंटेशन SPA को नेविगेट नहीं कर सकते। उत्पन्न डॉक्युमेंटेशन चेक इन किया जाता है; pnpm check:docs इसे मेमोरी में पुनः उत्पन्न करता है, पुरानी या अतिरिक्त फ़ाइलों की रिपोर्ट करता है, और Chromium में नेविगेशन, खोज, एंकर, और रिस्पॉन्सिव लेआउट का परीक्षण करता है।
योगदान और लाइसेंस
इश्यू और छोटे पुल रिक्वेस्ट का स्वागत है; बड़े बदलावों की शुरुआत मेंटेनर के साथ चर्चा से होनी चाहिए। प्रोजेक्ट Apache License 2.0 के अंतर्गत लाइसेंस प्राप्त है, कॉपीराइट 2017-वर्तमान William Ngan और योगदानकर्ता।
Comments
0 people shared their preference · Deer Point appears after 10 participants
Sign in to join the discussion.