feat(check): check title now shows counts of complete & total tasks to be completed

Author: stilliard

index.js

@@ -30,7 +30,7 @@ module.exports = (app) => {
       pr = response.data;
     }
 
-    let hasOutstandingTasks = checkOutstandingTasks(pr.body);
+    let outstandingTasks = checkOutstandingTasks(pr.body);
 
     // lookup comments on the PR
     let comments = await context.github.issues.listComments(context.repo({
@@ -56,9 +56,9 @@ module.exports = (app) => {
     // & check them for tasks
     if (comments.data.length) {
       comments.data.forEach(function (comment) {
-        if (checkOutstandingTasks(comment.body)) {
-          hasOutstandingTasks = true;
-        }
+        let commentOutstandingTasks = checkOutstandingTasks(comment.body);
+        outstandingTasks.total += commentOutstandingTasks.total;
+        outstandingTasks.remaining += commentOutstandingTasks.remaining;
       });
     }
 
@@ -68,18 +68,18 @@ module.exports = (app) => {
       started_at: startTime,
       status: 'in_progress',
       output: {
-        title: 'Outstanding tasks',
-        summary: 'Tasks still remain to be completed',
+        title: (outstandingTasks.total - outstandingTasks.remaining) + ' / ' + outstandingTasks.total + ' tasks completed',
+        summary: outstandingTasks.remaining + ' task' + (outstandingTasks.remaining > 1 ? 's' : '') + ' still to be completed',
         text: 'We check if any task lists need completing before you can merge this PR'
       }
     };
 
     // all finished?
-    if (hasOutstandingTasks === false) {
+    console.log(outstandingTasks);
+    if (outstandingTasks.remaining === 0) {
       check.status = 'completed';
       check.conclusion = 'success';
       check.completed_at = (new Date).toISOString();
-      check.output.title = 'Tasks completed';
       check.output.summary = 'All tasks have been completed';
     };
 

src/check-outstanding-tasks.js

@@ -2,11 +2,18 @@ const marked = require('marked');
 
 module.exports = function (body) {
     if (body === null) {
-        return false;
+        return {
+            total: 0,
+            remaining: 0
+        };
     }
+
     let tokens = marked.lexer(body, { gfm: true });
     let listItems = tokens.filter(token => token.type === 'list_item_start');
 
-    // check if it contains any not checked task list items
-    return listItems.some(item => item.checked === false);
+    // return counts of task list items and how many are left to be completed
+    return {
+        total: listItems.length,
+        remaining: listItems.filter(item => item.checked === false).length
+    };
 };

tests/index.test.js

@@ -8,13 +8,17 @@ Hello World
 - [ ] testing
 - [x] 123
 `;
-    expect(checkOutstandingTasks(markdown)).toBe(true);
+    let results = checkOutstandingTasks(markdown);
+    expect(results.total).toBe(2);
+    expect(results.remaining).toBe(1);
 });
 test('Test no outstanding tasks', () => {
     let markdown = `
 Hello World
 - [x] testing
 - [x] 123
 `;
-    expect(checkOutstandingTasks(markdown)).toBe(false);
+    let results = checkOutstandingTasks(markdown);
+    expect(results.total).toBe(2);
+    expect(results.remaining).toBe(0);
 });