Added support for inapplicable checklist items (#28)

* Added support for inapplicable checklist items
* Update readme

README.md

@@ -23,3 +23,10 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
+
+### Inapplicable checklist items
+
+In case there are some items that are not applicable in given checklist they can be ~stroked through~ and this action will ignore them. For example:
+
+- [X] Applicable item
+- [ ] ~Inapplicable item~

index.js

@@ -1,5 +1,5 @@
 const { Toolkit } = require("actions-toolkit");
-const TASK_LIST_ITEM = /(?:^|\n)\s*-\s+\[([ xX])\]\s+(.*)/g;
+const TASK_LIST_ITEM = /(?:^|\n)\s*-\s+\[([ xX])\]\s+((?!~).*)/g;
 
 Toolkit.run(async (tools) => {
   const bodyList = [];

index.test.js

@@ -93,6 +93,21 @@ describe("Require Checklist", () => {
     );
   });
 
+  it("handles checklist with inapplicable items in body", async () => {
+    mockIssueBody("Demo\r\n\r\n- [x] One\r\n- [ ] ~Two~");
+    mockIssueComments(["No checklist in comment"]);
+
+    tools.log.success = jest.fn();
+    tools.exit.success = jest.fn();
+    await action(tools);
+
+    expect(tools.log.success).toBeCalledWith("Completed task list item: One");
+
+    expect(tools.exit.success).toBeCalledWith(
+      "There are no incomplete task list items"
+    );
+  });
+
   it("handles incomplete checklist in comments", async () => {
     mockIssueBody("Nothing in the body");
     mockIssueComments(["Demo\r\n\r\n- [x] One\r\n- [ ] Two\n- [ ] Three"]);
@@ -111,6 +126,21 @@ describe("Require Checklist", () => {
     );
   });
 
+  it("handles checklist with inapplicable items in comments", async () => {
+    mockIssueBody("Nothing in the body");
+    mockIssueComments(["Demo\r\n\r\n- [x] One\r\n- [ ] ~Two~"]);
+
+    tools.log.success = jest.fn();
+    tools.exit.success = jest.fn();
+    await action(tools);
+
+    expect(tools.log.success).toBeCalledWith("Completed task list item: One");
+
+    expect(tools.exit.success).toBeCalledWith(
+      "There are no incomplete task list items"
+    );
+  });
+
   it("handles issues with empty body, requireChecklist disabled", async () => {
     process.env.INPUT_REQUIRECHECKLIST = "false";