NPQ दस्तावेज़ीकरण

यह निर्देशिका NPQ (Node Package Quality) सुरक्षा ऑडिटिंग टूल के लिए व्यापक दस्तावेज़ीकरण शामिल करती है।

मुख्य दस्तावेज़ीकरण

optional-features.md

वैकल्पिक सुरक्षा सुविधाओं का कॉन्फ़िगरेशन और उपयोग, जिसमें हालिया सुधार और बग फिक्स शामिल हैं।

age.marshall.md

Age Marshall सुरक्षा घटक का विस्तृत दस्तावेज़ीकरण जो पैकेज की आयु और परिपक्वता को मान्य करता है।

फीचर दस्तावेज़ीकरण

feature/ निर्देशिका में विशिष्ट फीचरों और कार्यान्वयनों के लिए विस्तृत दस्तावेज़ीकरण शामिल है:

हालिया विकास

• test-coverage-improvements.md - व्यापक टेस्ट कवरेज सुधार जिन्होंने समग्र कवरेज को 84.4% से बढ़ाकर 93.39% कर दिया
• signature-verification-fix.md - वर्शन रेंज (जैसे, @angular/common@^20.2.4) के साथ हस्ताक्षर सत्यापन के लिए महत्वपूर्ण बग फिक्स

मौजूदा फीचर

• auto-continue.md - ऑटो-कंटीन्यू फीचर का दस्तावेज़ीकरण जो पैकेज इंस्टॉलेशन वर्कफ़्लो को सुव्यवस्थित करता है
• exit-codes.md - npq और npq-hero प्रक्रिया निकास व्यवहार के लिए संदर्भ
• json-output.md - CI और स्वचालन के लिए संस्करणित, मशीन-पठनीय केवल-ऑडिट आउटपुट
• malicious-package.md - Snyk/OSV डेटा के माध्यम से ज्ञात-दुर्भावनापूर्ण पैकेज का पता लगाने हेतु दस्तावेज़ीकरण
• pacote-dependency-reduction.md - वैकल्पिक pacote निर्भरता न्यूनीकरण के लिए कार्यान्वयन सारांश

दस्तावेज़ीकरण मानक

संरचना

• प्रत्येक फीचर को feature/ में अपनी स्वयं की markdown फ़ाइल मिलती है
• मुख्य कार्यक्षमता रूट डॉक्स स्तर पर प्रलेखित की जाती है
• कोड उदाहरणों के साथ तकनीकी कार्यान्वयन विवरण शामिल होते हैं
• उपयोगकर्ता-समक्ष कॉन्फ़िगरेशन उपयोग उदाहरणों के साथ प्रलेखित किया जाता है

सामग्री दिशानिर्देश

• अवलोकन: फीचर/घटक का संक्षिप्त विवरण
• तकनीकी डिज़ाइन: वास्तुकला और कार्यान्वयन विवरण
• उपयोग उदाहरण: कोड स्निपेट के साथ व्यावहारिक उदाहरण
• परीक्षण: कवरेज और सत्यापन जानकारी
• भविष्य के विचार: रखरखाव और विकास नोट

Marshall दस्तावेज़ीकरण

Marshall घटक NPQ में मुख्य सुरक्षा सत्यापन मॉड्यूल हैं। प्रत्येक marshall एक विशिष्ट सुरक्षा चिंता पर केंद्रित होता है:

• Age Marshall (age.marshall.md) - पैकेज आयु और परिपक्वता सत्यापन
• Signature Marshall - NPM रजिस्ट्री हस्ताक्षर सत्यापन (देखें signature-verification-fix.md)
• Provenance Marshall - पैकेज बिल्ड एटेस्टेशन सत्यापन
• Snyk Marshall - भेद्यता डेटाबेस एकीकरण
• Typosquatting Marshall - पैकेज नाम समानता का पता लगाना

दस्तावेज़ीकरण में योगदान

नए फीचर जोड़ते समय या महत्वपूर्ण परिवर्तन करते समय:

1. फीचर दस्तावेज़ीकरण: feature/ निर्देशिका में एक नई फ़ाइल बनाएं
2. इंडेक्स अपडेट करें: इस README में प्रविष्टि जोड़ें
3. क्रॉस-रेफरेंस: संबंधित दस्तावेज़ीकरण फ़ाइलों को अपडेट करें
4. उदाहरण: व्यावहारिक उपयोग उदाहरण शामिल करें
5. परीक्षण: टेस्ट कवरेज और सत्यापन का दस्तावेज़ीकरण करें

त्वरित संदर्भ

प्रोजेक्ट संदर्भ

• विकास - स्थानीय सेटअप, वर्कफ़्लो, और उपयोगी कमांड।
• परीक्षण - टेस्ट कमांड, टेस्ट संगठन, और सत्यापन अपेक्षाएँ।
• वास्तुकला - रिपॉजिटरी संरचना, पैकेज सीमाएँ, और महत्वपूर्ण फ्लो।
• परंपराएँ - कोडिंग, दस्तावेज़ीकरण, और रखरखाव परंपराएँ।

डिज़ाइन विनिर्देश

• कस्टम रजिस्ट्री समर्थन - npm-संगत Artifactory और निजी रजिस्ट्री समर्थन के लिए अनुमोदित डिज़ाइन।
• कोडिंग-एजेंट JSON पहचान - कोडिंग-एजेंट वातावरण में स्वचालित रूप से JSON ऑडिट मोड चुनने के लिए अनुमोदित डिज़ाइन।
• JSON ऑडिट आउटपुट - संस्करणित, गैर-इंटरैक्टिव मशीन-पठनीय ऑडिट परिणामों के लिए अनुमोदित डिज़ाइन।
• समाप्त-डोमेन मेंटेनर पहचान चेतावनियाँ - विशेषता-योग्य समाप्त-डोमेन चेतावनियों के लिए अनुमोदित डिज़ाइन।
• समाप्त-डोमेन हल किया गया संस्करण - समाप्त-डोमेन जाँचों के लिए सटीक निर्भरता संस्करण हल करने हेतु डिज़ाइन।

कार्यान्वयन योजनाएँ

• कस्टम रजिस्ट्री समर्थन - मुद्दा #429 के लिए कार्य-दर-कार्य कार्यान्वयन योजना।
• कोडिंग-एजेंट JSON पहचान - npq और npq-hero में मुद्दा #426 के लिए टेस्ट-प्रथम कार्यान्वयन योजना।
• JSON ऑडिट आउटपुट - संस्करणित, केवल-ऑडिट JSON CLI आउटपुट के लिए कार्य-दर-कार्य योजना।
• समाप्त-डोमेन हल किया गया संस्करण - समाप्त-डोमेन जाँचों में सटीक निर्भरता-संस्करण समाधान के लिए कार्यान्वयन योजना।
• समाप्त-डोमेन मेंटेनर पहचान चेतावनियाँ - विशेषता-योग्य समाप्त-डोमेन चेतावनियों के लिए टेस्ट-प्रथम कार्यान्वयन योजना।