feat(tasks): skippable tasks for N/A & POST-MERGE

Author: stilliard

README.md

@@ -54,6 +54,11 @@ Inside your GitHub repo > Settings > Branches > Branch protection rules > Add ru
 
 By default, we mark the check as in_progress until all tasks pass and then it marks it as successful.
 
+## Skippable tasks
+
+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). 
+
 ## TODO
 
 - [x] ~~unit tests & travis CI~~

src/check-outstanding-tasks.js

@@ -20,6 +20,15 @@ module.exports = function (body) {
     // and filter down to just the task list items
     let listItems = allTokens.filter(token => token.type === 'list_item');
 
+    // filter out skippable items, case sensitive
+    let skippable = [
+        'POST-MERGE',
+        'N/A',
+    ];
+    listItems = listItems.filter(item => {
+        return ! skippable.some(skip => item.text.indexOf(skip) !== -1);
+    });
+
     // return counts of task list items and how many are left to be completed
     return {
         total: listItems.filter(item => item.checked !== undefined).length,

tests/index.test.js

@@ -60,3 +60,18 @@ Hello World
     expect(results.total).toBe(5);
     expect(results.remaining).toBe(2);
 });
+
+test('Test skip items', () => {
+    let markdown = `
+Hello World
+- normal
+- [ ] task one
+- [ ] POST-MERGE: abc
+- [ ] this is not a post-merge test
+- [ ] N/A skipped
+- [x] n/a not skipped
+`;
+    let results = checkOutstandingTasks(markdown);
+    expect(results.total).toBe(3);
+    expect(results.remaining).toBe(2);
+});