feat(tasks): details text inside github check now shows a table of the checks, required & optional, showing the task name and if its complete or not

Author: stilliard

index.js

@@ -113,6 +113,10 @@ module.exports = (app) => {
         let commentOutstandingTasks = checkOutstandingTasks(comment.body);
         outstandingTasks.total += commentOutstandingTasks.total;
         outstandingTasks.remaining += commentOutstandingTasks.remaining;
+        outstandingTasks.optionalTotal += commentOutstandingTasks.optionalTotal;
+        outstandingTasks.optionalRemaining += commentOutstandingTasks.optionalRemaining;
+        outstandingTasks.tasks = (outstandingTasks.tasks || []).concat(commentOutstandingTasks.tasks || []);
+        outstandingTasks.optionalTasks = (outstandingTasks.optionalTasks || []).concat(commentOutstandingTasks.optionalTasks || []);
       });
     }
 
@@ -122,6 +126,25 @@ module.exports = (app) => {
       optionalText = ' (+' + outstandingTasks.optionalRemaining + ' optional)';
     }
 
+    // make a markdown table of the tasks
+    let tasksTable = '';
+    if (outstandingTasks.total > 0) {
+      tasksTable += `
+## Required Tasks
+| Task | Status |
+| ---- | ------ |
+${outstandingTasks.tasks.map(task => `| ${task.task} | ${task.status} |`).join('\n')}
+`;
+    }
+    if (outstandingTasks.optionalTotal > 0) {
+      tasksTable += `
+## Optional Tasks
+| Task | Status |
+| ---- | ------ |
+${outstandingTasks.optionalTasks.map(task => `| ${task.task} | ${task.status} |`).join('\n')}
+`;
+    }
+
     let check = {
       name: 'task-list-completed',
       head_branch: '',
@@ -131,7 +154,7 @@ module.exports = (app) => {
       output: {
         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'
+        text: tasksTable
       },
       request: {
         retries: 3,

src/check-outstanding-tasks.js

@@ -33,8 +33,21 @@ module.exports = function (body) {
 
     // return counts of task list items and how many are left to be completed
     return {
+        tasks: listItems.filter(item => item.text.indexOf('OPTIONAL') === -1).map(item => {
+            return {
+                task: item.text.replace(/\[x\]|\[ \]/, '').trim(),
+                status: item.checked ? 'Completed' : '**Incomplete**',
+            };
+        }),
+        optionalTasks: optionalItems.map(item => {
+            return {
+                task: item.text.replace(/\[x\]|\[ \]/, '').trim(),
+                status: item.checked ? 'Completed' : '**Incomplete**',
+            };
+        }),
         total: listItems.filter(item => item.checked !== undefined).length,
         remaining: listItems.filter(item => item.checked === false).length,
+        optionalTotal: optionalItems.filter(item => item.checked !== undefined).length,
         optionalRemaining: optionalItems.filter(item => item.checked === false).length
     };
 };