वर्ष के अंत की रिपोरट के लिए git commit का सारांश देने वाला NodeJS उपकरण, Markdown का स्वचालित निर्माण
year-report व्यक्तियों की सेवा के लिए समर्पित एक उपकरण है, जो वार्षिक रिपोर्ट लिखने में सहायता करता है।
यह आपकी सहायता कर सकता है:
व्यक्तिगत गिट कार्य लॉग का सारांश तैयार करना
सुंदर मार्कडाउन आउटपुट करना
निर्दिष्ट कार्य प्रकारों की सूची और संख्या निकालना
यह changelog-cli से कैसे अलग है:
व्यक्तियों की सेवा पर केंद्रित है
लचीला और नियंत्रण योग्य समय सीमा
अधिक नियंत्रित आउटपुट परिणाम मोड
वार्षिक रिपोर्ट लिखने वाले डेवलपर्स के लिए बेहतर मानक सामग्री
GPT को खिलाए गए डेटा का पूर्व-पार्स
Markdown आउटपुट परिणाम प्रदर्शन
- रिपोजिटरी क्लोन करें
git clone https://github.com/kabeep/yeareport.git- इंस्टालेशन निर्भरता
cd yeareport
# NPM
npm install
# या Yarn
yarn- प्रोग्राम कंपाइल करें
npm run build- एनपीएम सॉफ्ट लिंक
npm link- परीक्षण
yeareport -h
yeareport <command> [options]
आदेश:
yeareport add वर्तमान डायरेक्टरी को कतार में जोड़ें
yeareport remove वर्तमान कार्य डायरेक्टरी को कतार से हटाएं [aliases: rm]
yeareport clear कतार को साफ करें [aliases: clr]
yeareport print कतार को मार्कडाउन फ़ाइल के रूप में आउटपुट करें [aliases: ptr]
yeareport show कतार में लॉग सूची दिखाएं
विकल्प:
--author `auto` पर, git global config से खोजें, डिफॉल्ट सभी लॉग आउटपुट
करें [स्ट्रिंग]
--since किसी तारीख से आउटपुट शुरू करें, डिफॉल्ट है `2023-01-01`
[स्ट्रिंग]
--before किसी तारीख पर आउटपुट खत्म करें, डिफॉल्ट है `2024-01-01`
[स्ट्रिंग]
--output प्रिंट आउटपुट डायरेक्टरी, वर्तमान कार्य डायरेक्टरी के
सापेक्ष, डिफॉल्ट User/Downloads` [स्ट्रिंग]
-o, --overwrite add ओवरराइट प्राधिकरण, जब वर्तमान कार्य डायरेक्टरी पहले से
मौजूद हो तो ओवरराइट करने की क्रिया करें [बूलियन] [डिफ़ॉल्ट मान: false]
-p, --pretty प्रिंट सुंदर शीर्षक, इमोजी का इस्तेमाल करके Markdown शीर्षकों
को सुंदर बनाएं [बूलियन] [डिफ़ॉल्ट मान: false]
-h, --help मदद की जानकारी दिखाएं [बूलियन]
-v, --version संस्करण संख्या दिखाएं [बूलियन]
उदाहरण:
yeareport add -o add कमांड के लिए अधिकार दें जब
वर्तमान कार्य डायरेक्टरी के लॉग पहले
से कतार में हों तो ओवरराइट करें
yeareport add --author=kabeep केवल लेखक kabeep के लॉग को कतार में
जोड़ें
yeareport add --since=2023-01-01 2023-01-01 से 2024-01-01 तक के लॉग
--before=2024-01-01 कतार में जोड़ें
yeareport print -p Markdown शीर्षक इस प्रकार आउटपुट
होंगे # {emoji} {commit-type}
-
सांख्यिकीय विश्लेषण और शब्द विभाजन
-
प्रतिशत गणना
-
प्रवृत्ति चार्ट
-
गैंट चार्ट
पुल रिक्वेस्ट्स या Issues के माध्यम से योगदान का स्वागत है।
यह परियोजना एमआईटी लाइसेंस के अंतर्गत लाइसेंस प्राप्त है। विवरण के लिए LICENSE फ़ाइल देखें।