Add support for labeling based on checkboxes ☑️

README.md

@@ -183,7 +183,7 @@ policy:
           - name: 'kind: reptiles'
             keys: ['🐊 Crocodile']
           - name: 'invertebrates'
-            keys: ['🐛 Bug', '🕷️ Spider'] 
+            keys: ['🐛 Bug', '🕷️ Spider']
 ```
 
 GitHub workflow that automatically marks issues with animal types labels:

src/issue-form.ts

@@ -14,15 +14,16 @@ export class IssueForm {
   }
 
   listKeywords(key: string, blockList: string[]) {
-    const propertySection = this.getSafeProperty(key);
+    let propertySection = this.getSafeProperty(key);
 
     if (!propertySection) return undefined;
-    // Array can be only checkbox type - currently unsupported
-    if (Array.isArray(propertySection)) return undefined;
 
-    return propertySection
-      .split(', ', 25)
-      .filter(label => !this.isCompliant(blockList, label));
+    // Only Checkboxes are in form of array, dropdowns are strings separated by ', '
+    if (!Array.isArray(propertySection)) {
+      propertySection = propertySection.split(', ', 25);
+    }
+
+    return propertySection.filter(label => !this.isCompliant(blockList, label));
   }
 
   isCompliant(policy: string[], keyword: string) {

test/action.test.ts

@@ -162,7 +162,7 @@ describe('Integration test', () => {
     setDefaultInputs();
     vi.stubEnv('INPUT_ISSUE-FORM', JSON.stringify(dropdownForm));
     vi.stubEnv('INPUT_SECTION', 'type');
-    vi.stubEnv('INPUT_BLOCK-LIST', 'other\nnone');
+    vi.stubEnv('INPUT_BLOCK-LIST', 'other\nnone\nOther');
 
     vi.mocked(mocks['@octokit/core']).config.get.mockImplementation(
       async (params: { owner: string; repo: string; path: string }) => {
@@ -268,10 +268,10 @@ describe('Integration test', () => {
 
     // Check outputs
     expect(process.env['OUTPUT_LABELS']).toMatchInlineSnapshot(
-      `"["bug 🐛","RFE 🎁","high"]"`
+      `"["bug 🐛","RFE 🎁","high","type: two","type: three"]"`
     );
     expect(process.env['OUTPUT_POLICY']).toMatchInlineSnapshot(
-      `"{"template":"bug.yml","section":{"type":["bug 🐛","RFE 🎁"],"severity":["high"]}}"`
+      `"{"template":"bug.yml","section":{"type":["bug 🐛","RFE 🎁"],"severity":["high"],"checkList":["type: two","type: three"]}}"`
     );
 
     // Check if the action has set the labels
@@ -282,7 +282,7 @@ describe('Integration test', () => {
         owner: 'redhat-plumbers-in-action',
         repo: 'advanced-issue-labeler',
         issue_number: 1,
-        labels: ['bug 🐛', 'RFE 🎁', 'high'],
+        labels: ['bug 🐛', 'RFE 🎁', 'high', 'type: two', 'type: three'],
       }
     );
   });

test/unit/config.fixture.ts

@@ -23,19 +23,30 @@ export const templateConfig = {
       section: [
         {
           id: ['type'],
+          'block-list': ['Other'],
           label: [
             { name: 'bug 🐛', keys: ['Bug Report'] },
             { name: 'RFE 🎁', keys: ['Feature Request'] },
           ],
         },
         {
           id: ['severity'],
+          'block-list': ['None', 'Other'],
           label: [
             { name: 'high', keys: ['High'] },
             { name: 'medium', keys: ['Medium'] },
             { name: 'low', keys: ['Low'] },
           ],
         },
+        {
+          id: ['checkList'],
+          'block-list': ['one'],
+          label: [
+            { name: 'type: one', keys: ['one'] },
+            { name: 'type: two', keys: ['two'] },
+            { name: 'type: three', keys: ['three'] },
+          ],
+        },
       ],
     },
     {

test/unit/config.test.ts

@@ -137,7 +137,9 @@ describe('Test Config class', () => {
         {
           "section": [
             {
-              "block-list": [],
+              "block-list": [
+                "Other",
+              ],
               "id": [
                 "type",
               ],
@@ -157,7 +159,10 @@ describe('Test Config class', () => {
               ],
             },
             {
-              "block-list": [],
+              "block-list": [
+                "None",
+                "Other",
+              ],
               "id": [
                 "severity",
               ],
@@ -182,6 +187,34 @@ describe('Test Config class', () => {
                 },
               ],
             },
+            {
+              "block-list": [
+                "one",
+              ],
+              "id": [
+                "checkList",
+              ],
+              "label": [
+                {
+                  "keys": [
+                    "one",
+                  ],
+                  "name": "type: one",
+                },
+                {
+                  "keys": [
+                    "two",
+                  ],
+                  "name": "type: two",
+                },
+                {
+                  "keys": [
+                    "three",
+                  ],
+                  "name": "type: three",
+                },
+              ],
+            },
           ],
           "template": [
             "bug.yml",

test/unit/issue-form.fixture.ts

@@ -10,6 +10,6 @@ export const dropdownForm = {
   title: 'Test issue',
   body: 'Test body',
   severity: 'High',
-  type: 'Bug Report, Feature Request, other, none',
+  type: 'Bug Report, Feature Request, Other, none',
   checkList: ['one', 'two', 'three'],
 };

test/unit/issue-form.test.ts

@@ -44,16 +44,21 @@ describe('Test IssueForm class', () => {
       ]
     `);
 
-    expect(issueForm.listKeywords('type', ['other', 'none']))
+    expect(issueForm.listKeywords('type', ['other', 'none', 'Other']))
       .toMatchInlineSnapshot(`
         [
           "Bug Report",
           "Feature Request",
         ]
       `);
 
-    // Checklists are unsupported at the moment
-    expect(issueForm.listKeywords('checkList', [])).toBeUndefined();
+    expect(issueForm.listKeywords('checkList', ['one'])).toMatchInlineSnapshot(`
+      [
+        "two",
+        "three",
+      ]
+    `);
+
     expect(issueForm.listKeywords('nonexistent', ['none'])).toBeUndefined();
   });
 });

test/unit/labeler.test.ts

@@ -26,7 +26,7 @@ describe('Test Labeler class', () => {
 
     beforeEach(() => {
       vi.stubEnv('INPUT_SECTION', 'type');
-      vi.stubEnv('INPUT_BLOCK-LIST', 'other\nnone');
+      vi.stubEnv('INPUT_BLOCK-LIST', 'other\nnone\nOther');
 
       labeler = new Labeler(
         new IssueForm(dropdownForm),
@@ -43,6 +43,7 @@ describe('Test Labeler class', () => {
         [
           "other",
           "none",
+          "Other",
         ]
       `);
 
@@ -151,6 +152,8 @@ describe('Test Labeler class', () => {
           "bug 🐛",
           "RFE 🎁",
           "high",
+          "type: two",
+          "type: three",
         ]
       `);
     });
@@ -162,6 +165,10 @@ describe('Test Labeler class', () => {
         expect(labeler.outputPolicy).toMatchInlineSnapshot(`
           {
             "section": {
+              "checkList": [
+                "type: two",
+                "type: three",
+              ],
               "severity": [
                 "high",
               ],
@@ -178,6 +185,8 @@ describe('Test Labeler class', () => {
             "bug 🐛",
             "RFE 🎁",
             "high",
+            "type: two",
+            "type: three",
           ]
         `);
       });