feat(tasks): optional tasks support! fixes #21

Author: stilliard

README.md

@@ -59,6 +59,10 @@ By default, we mark the check as in_progress until all tasks pass and then it ma
 Tasks that contain "POST-MERGE" or "N/A" in all caps are skipped. This is useful for tasks that are not applicable to the PR, or tasks that are only applicable after the PR is merged.
 This was inspired by [another project here](https://github.com/Shopify/task-list-checker/tree/main?tab=readme-ov-file#in-a-pull-request). 
 
+## Optional tasks
+
+Tasks that contain "OPTIONAL" in all caps are also skipped unless checked, they are also added to an "(+X optional)" text in the check. This is useful for tasks that are not required to be completed before the PR can be merged.
+
 ## TODO
 
 - [x] ~~unit tests & travis CI~~

index.js

@@ -94,15 +94,21 @@ module.exports = (app) => {
       });
     }
 
+    // optional addon text
+    let optionalText = '';
+    if (outstandingTasks.optionalRemaining > 0) {
+      optionalText = ' (+' + outstandingTasks.optionalRemaining + ' optional)';
+    }
+
     let check = {
       name: 'task-list-completed',
       head_branch: '',
       head_sha: pr.head.sha,
       started_at: (new Date).toISOString(),
       status: 'in_progress',
       output: {
-        title: (outstandingTasks.total - outstandingTasks.remaining) + ' / ' + outstandingTasks.total + ' tasks completed',
-        summary: outstandingTasks.remaining + ' task' + (outstandingTasks.remaining > 1 ? 's' : '') + ' still to be completed',
+        title: (outstandingTasks.total - outstandingTasks.remaining) + ' / ' + outstandingTasks.total + ' tasks completed' + optionalText,
+        summary: outstandingTasks.remaining + ' task' + (outstandingTasks.remaining > 1 ? 's' : '') + ' still to be completed' + optionalText,
         text: 'We check if any task lists need completing before you can merge this PR'
       },
       request: {
@@ -116,7 +122,7 @@ module.exports = (app) => {
       check.status = 'completed';
       check.conclusion = 'success';
       check.completed_at = (new Date).toISOString();
-      check.output.summary = 'All tasks have been completed';
+      check.output.summary = 'All tasks have been completed' + optionalText;
     };
 
     log(pr, 'Complete and sending back to GitHub');

src/check-outstanding-tasks.js

@@ -19,19 +19,22 @@ module.exports = function (body) {
     });
     // and filter down to just the task list items
     let listItems = allTokens.filter(token => token.type === 'list_item');
+    let optionalItems = listItems.filter(item => item.text.indexOf('OPTIONAL') !== -1);
 
     // filter out skippable items, case sensitive
     let skippable = [
         'POST-MERGE',
         'N/A',
+        'OPTIONAL', // this is a special case, we want to count these items but not include them in the remaining count
     ];
     listItems = listItems.filter(item => {
-        return ! skippable.some(skip => item.text.indexOf(skip) !== -1);
+        return ! skippable.some(skip => item.text.indexOf(skip) !== -1) || item.text.indexOf('OPTIONAL') !== -1 && item.checked === true;
     });
 
     // return counts of task list items and how many are left to be completed
     return {
         total: listItems.filter(item => item.checked !== undefined).length,
-        remaining: listItems.filter(item => item.checked === false).length
+        remaining: listItems.filter(item => item.checked === false).length,
+        optionalRemaining: optionalItems.filter(item => item.checked === false).length
     };
 };

tests/index.test.js

@@ -75,3 +75,17 @@ Hello World
     expect(results.total).toBe(3);
     expect(results.remaining).toBe(2);
 });
+
+test('Test optional items', () => {
+    let markdown = `
+Hello World
+- normal
+- [x] OPTIONAL: one
+- [ ] OPTIONAL: two
+- [x] this is not an optional test
+`;
+    let results = checkOutstandingTasks(markdown);
+    expect(results.total).toBe(2);
+    expect(results.remaining).toBe(0);
+    expect(results.optionalRemaining).toBe(1);
+});