feat: add none pr check (#114)

* feat: add none pr check * npm run all, add more test Co-authored-by: Fuxing Loh <[email protected]>
fuxingloh · Jan 13, 2022 · b1d1a32 · b1d1a32
1 parent 3386cbc
commit b1d1a32
Show file tree

Hide file tree

Showing 6 changed files with 74 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -480,6 +480,18 @@ checks:
       all: [ "app" ]
 ```
 
+#### PR Check none
+
+```yml
+version: v1
+
+checks:
+  - context: "Merge check"
+    description: "Disable merging when 'DO NOT MERGE' label is set"
+    labels:
+      none: [ "DO NOT MERGE" ]
+```
+
 ## Why?
 
 > There are so many labeler why create another? 😧

diff --git a/__tests__/checks.test.ts b/__tests__/checks.test.ts
@@ -316,6 +316,51 @@ describe('is', () => {
       ).toBeFalsy()
     })
   })
+
+  describe('none', function () {
+    it('should be false when none is present', function () {
+      expect(
+        is(
+          {
+            context: 'abc',
+            labels: {
+              none: ['b']
+            }
+          },
+          ['a', 'b']
+        )
+      ).toBeFalsy()
+    })
+
+    it('should be true when none is not present', function () {
+      expect(
+        is(
+          {
+            context: 'abc',
+            labels: {
+              none: ['c']
+            }
+          },
+          ['a', 'b']
+        )
+      ).toBeTruthy()
+    })
+
+    it('should be true when none is not present but all not valid', function () {
+      expect(
+        is(
+          {
+            context: 'abc',
+            labels: {
+              none: ['c'],
+              all: ['b']
+            }
+          },
+          ['a', 'd']
+        )
+      ).toBeFalsy()
+    })
+  })
 })
 
 describe('checks', () => {

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/checks.ts b/src/checks.ts
@@ -22,6 +22,12 @@ export function is(check: Check, labels: string[]): boolean {
     }
   }
 
+  if (check.labels?.none?.length) {
+    if (check.labels?.none?.some(label => labels.includes(label))) {
+      return false
+    }
+  }
+
   return true
 }
 

diff --git a/src/config.ts b/src/config.ts
@@ -53,7 +53,8 @@ const Check = t.intersection([
     ]),
     labels: t.partial({
       any: t.array(t.string),
-      all: t.array(t.string)
+      all: t.array(t.string),
+      none: t.array(t.string)
     })
   })
 ])