Merge pull request #152 from exploreriii/shared-libraries-guards

feat: dynamic comments

Author: exploreriii

.github/scripts/lib/comments/difficulty-02-beginner.js

@@ -12,29 +12,42 @@
  * @param {string} params.browseGfiUrl - URL to browse available Good First Issues
  * @returns {string} Formatted markdown message explaining the restriction
  */
+const {
+    ISSUE_TYPES,
+    ELIGIBILITY_REQUIREMENTS,
+} = require('../eligibility/requirements');
+
 const beginnerRejection = ({
     username,
     completedGfiCount,
     browseGfiUrl,
 }) => {
-    const gfiPlural = completedGfiCount === 1 ? '' : 's';
+    const req =
+        ELIGIBILITY_REQUIREMENTS[ISSUE_TYPES.BEGINNER];
+
+    const gfiRequirement =
+        req.prerequisites.find(p => p.type === 'gfi');
+
+    const requiredCount = gfiRequirement.requiredCount;
+    const met = completedGfiCount >= requiredCount;
 
     return `Hi @${username},
 
 Thank you for your interest in contributing — we’re glad to see you here.
 
-This issue is labeled **Beginner**, which is intended as the next step after completing a **Good First Issue**.
+This issue is labeled **Beginner**, which is intended as the next step after completing **Good First Issues (GFIs)**.
 
-**Requirement:**  
-- Completion of **one Good First Issue**
+**Requirements:**  
+- Completion of **${requiredCount} Good First Issue${requiredCount === 1 ? '' : 's'}**
 
 **Your progress:**  
-- Completed **${completedGfiCount}** Good First Issue${gfiPlural}
+- Good First Issues completed: **${completedGfiCount} / ${requiredCount}** ${met ? '✅' : '❌'}
+
+To build the required experience, please work on a GFI first:
 
-You can find available tasks here:  
 **[Browse unassigned Good First Issues](${browseGfiUrl})**
 
-Once you’ve completed a GFI, feel free to come back and request this issue again.`;
+Once the requirement is met, feel free to come back and request this issue again.`;
 };
 
 module.exports = {

.github/scripts/lib/comments/difficulty-03-intermediate.js

@@ -13,43 +13,42 @@
  * @param {string} params.browseBeginnerUrl - URL to browse Beginner issues
  * @returns {string} Formatted markdown message explaining the restriction
  */
+const {
+    ISSUE_TYPES,
+    ELIGIBILITY_REQUIREMENTS,
+} = require('../eligibility/requirements');
+
 const INTERMEDIATE_GUARD_MARKER = '<!-- Intermediate Issue Guard -->';
 
 const intermediateRejection = ({
     username,
-    completedGfiCount,
-    hasBeginner,
-    browseGfiUrl,
+    completedBeginnerCount,
     browseBeginnerUrl,
 }) => {
-    const gfiPlural = completedGfiCount === 1 ? '' : 's';
-    const reasons = [];
+    const req =
+        ELIGIBILITY_REQUIREMENTS[ISSUE_TYPES.INTERMEDIATE];
 
-    if (completedGfiCount === 0) {
-        reasons.push('• You have not completed a **Good First Issue** yet');
-    }
+    const beginnerReq =
+        req.prerequisites.find(p => p.type === 'beginner');
 
-    if (!hasBeginner) {
-        reasons.push('• You have not completed a **Beginner issue** yet');
-    }
+    const requiredCount = beginnerReq.requiredCount;
+    const met = completedBeginnerCount >= requiredCount;
 
     return `${INTERMEDIATE_GUARD_MARKER}
 Hi @${username}, thank you for your interest in this issue.
 
-This issue is labeled **Intermediate**, which means it requires some prior experience with the project.
+This issue is labeled **Intermediate**, which requires prior experience working on **Beginner issues**.
 
-**Why you can’t be assigned right now:**
-${reasons.join('\n')}
+**Requirements:**  
+- Completion of **${requiredCount} Beginner issue${requiredCount === 1 ? '' : 's'}**
 
-**Your progress so far:**
-- Completed **${completedGfiCount}** Good First Issue${gfiPlural}
-- Beginner issue completed: **${hasBeginner ? 'Yes' : 'No'}**
+**Your progress:**  
+- Beginner issues completed: **${completedBeginnerCount} / ${requiredCount}** ${met ? '✅' : '❌'}
 
-**Suggested next steps:**
-- [Browse unassigned Good First Issues](${browseGfiUrl})
+**Suggested next steps:**  
 - [Browse unassigned Beginner issues](${browseBeginnerUrl})
 
-Once you meet the requirements, you’re welcome to come back and request this issue again.`;
+Once the requirement is met, you’re welcome to come back and request this issue again.`;
 };
 
 module.exports = {

.github/scripts/lib/comments/difficulty-04-advanced.js

@@ -12,22 +12,40 @@
  * @param {string} params.suggestionUrl - URL to suggested issues - pass advanced URL
  * @returns {string} Formatted markdown message explaining the restriction
  */
+const {
+  ISSUE_TYPES,
+  ELIGIBILITY_REQUIREMENTS,
+} = require('../eligibility/requirements');
+
 const advancedRejection = ({
   username,
-  intermediateCount,
+  completedIntermediateCount,
   suggestionLabel,
   suggestionUrl,
-}) => `Hi @${username}, I can’t assign you to this issue just yet.
+}) => {
+  const req =
+    ELIGIBILITY_REQUIREMENTS[ISSUE_TYPES.ADVANCED];
+
+  const intermediateReq =
+    req.prerequisites.find(p => p.type === 'intermediate');
+
+  const requiredCount = intermediateReq.requiredCount;
+  const met = completedIntermediateCount >= requiredCount;
+
+  return `Hi @${username}, I can’t assign you to this issue just yet.
 
 **Why?**  
 Advanced issues involve higher-risk changes to core parts of the codebase. They typically require more extensive testing and may impact automation and CI behavior.
 
 **Requirements:**  
-- Completion of at least **2 intermediate issues**  
-  (you have completed **${intermediateCount}**)
+- Completion of **${requiredCount} Intermediate issue${requiredCount === 1 ? '' : 's'}**
 
-To build the required experience, please review our **[${suggestionLabel}](${suggestionUrl})** tasks. Once you’ve completed a few more, you’ll be eligible to work on advanced issues.`;
+**Your progress:**  
+- Intermediate issues completed: **${completedIntermediateCount} / ${requiredCount}** ${met ? '✅' : '❌'}
+
+To build the required experience, please review our **[${suggestionLabel}](${suggestionUrl})** tasks. Once the requirement is met, you’ll be eligible to work on advanced issues.`;
+};
 
 module.exports = {
   advancedRejection,
-};
+};

.github/scripts/lib/comments/render-requirements.js

@@ -0,0 +1,35 @@
+// comments/renderRequirements.js
+const { ELIGIBILITY_REQUIREMENTS } =
+    require('../eligibility/requirements');
+
+const renderRequirements = ({
+    issueType,
+    stats, // counts collected by caller
+}) => {
+    const req = ELIGIBILITY_REQUIREMENTS[issueType];
+    const lines = [];
+
+    if (req.capacity) {
+        const max =
+            typeof req.capacity === 'object'
+                ? req.capacity.maxOpenIssues
+                : stats.maxAllowed;
+
+        lines.push(
+            `- Open assignments: **${stats.openAssignedCount} / ${max}**`
+        );
+    }
+
+    for (const prereq of req.prerequisites || []) {
+        const actual = stats[`${prereq.type}Completed`] ?? 0;
+        const met = actual >= prereq.requiredCount;
+
+        lines.push(
+            `- ${prereq.type} issues completed: **${actual} / ${prereq.requiredCount}** ${met ? '✅' : '❌'}`
+        );
+    }
+
+    return lines.join('\n');
+};
+
+module.exports = { renderRequirements };

.github/scripts/lib/eligibility/requirements.js

@@ -0,0 +1,82 @@
+const ISSUE_TYPES = {
+    GFI: 'gfi',
+    BEGINNER: 'beginner',
+    INTERMEDIATE: 'intermediate',
+    ADVANCED: 'advanced',
+};
+
+const ELIGIBILITY_REQUIREMENTS = {
+    [ISSUE_TYPES.GFI]: {
+        bypass: {
+            team: true,
+        },
+        spamPolicy: {
+            allowed: true,
+            maxOpenIssues: {
+                spamListed: 1,
+                normal: 2,
+            },
+        },
+        capacity: true,
+        prerequisites: [],
+    },
+
+    [ISSUE_TYPES.BEGINNER]: {
+        bypass: {
+            team: true,
+        },
+        spamPolicy: {
+            allowed: false,
+        },
+        capacity: {
+            maxOpenIssues: 2,
+        },
+        prerequisites: [
+            {
+                type: 'gfi',
+                requiredCount: 1,
+            },
+        ],
+    },
+
+    [ISSUE_TYPES.INTERMEDIATE]: {
+        bypass: {
+            team: true,
+        },
+        spamPolicy: {
+            allowed: false,
+        },
+        capacity: {
+            maxOpenIssues: 2,
+        },
+        prerequisites: [
+            {
+                type: 'beginner',
+                requiredCount: 1,
+            },
+        ],
+    },
+
+    [ISSUE_TYPES.ADVANCED]: {
+        bypass: {
+            committer: true,
+        },
+        spamPolicy: {
+            allowed: false,
+        },
+        capacity: {
+            maxOpenIssues: 2,
+        },
+        prerequisites: [
+            {
+                type: 'intermediate',
+                requiredCount: 1,
+            },
+        ],
+    },
+};
+
+module.exports = {
+    ISSUE_TYPES,
+    ELIGIBILITY_REQUIREMENTS,
+};