feat: add ci.isPR

README.md

@@ -78,6 +78,12 @@ boolean to be set to `true` if they use certain vendor neutral
 environment variables. In those cases `ci.name` will be `null` and no
 vendor specific boolean will be set to `true`.
 
+### `ci.isPR`
+
+A boolean if PR detection is supported for the current CI server. Will
+be `true` if a PR is being tested. Otherwise `false`. If PR detection is
+not supported for the current CI server, the value will be `null`.
+
 ### `ci.<VENDOR-CONSTANT>`
 
 A vendor specific boolean constants is exposed for each support CI

index.js

@@ -10,6 +10,7 @@ Object.defineProperty(exports, '_vendors', {
 })
 
 exports.name = null
+exports.isPR = null
 
 vendors.forEach(function (vendor) {
   var envs = Array.isArray(vendor.env) ? vendor.env : [vendor.env]
@@ -19,8 +20,30 @@ vendors.forEach(function (vendor) {
       return env[k] === obj[k]
     })
   })
+
   exports[vendor.constant] = isCI
-  if (isCI) exports.name = vendor.name
+
+  if (isCI) {
+    exports.name = vendor.name
+
+    if (vendor.pr) {
+      var val = env[vendor.pr.env]
+      if (val) {
+        switch (vendor.pr.type) {
+          case 'not-false':
+            exports.isPR = val !== 'false'
+            break
+          case 'boolean':
+            exports.isPR = val === 'true'
+            break
+          default:
+            exports.isPR = true
+        }
+      } else {
+        exports.isPR = false
+      }
+    }
+  }
 })
 
 exports.isCI = !!(