Added a new host.ci property that has information about the CI/CD host

Author: JamesMessinger

package-lock.json

@@ -67,5 +67,8 @@
     "tslint": "^6.0.0",
     "typescript": "^3.7.5",
     "typescript-tslint-plugin": "^0.5.5"
+  },
+  "dependencies": {
+    "@qawolf/ci-info": "^2.1.0"
   }
 }

package.json

@@ -23,6 +23,14 @@ export interface Host {
    */
   env: EnvironmentVariables;
 
+  /**
+   * Information about the CI/CD host.
+   * This property is `false` when not running in a known CI/CD host.
+   *
+   * @see https://www.npmjs.com/package/@qawolf/ci-info#supported-ci-tools
+   */
+  ci: false | CIInfo;
+
   /**
    * Information about the Node host.
    * This property is `false` when running in a web browser.
@@ -89,6 +97,54 @@ export interface EnvironmentVariables {
   [key: string]: string | undefined;
 }
 
+/**
+ * Information about the CI/CD host.
+ */
+export interface CIInfo {
+  /**
+   * The friendly name of the CI/CD host (e.g. "Travis CI", "GitHub Actions", etc.)
+   */
+  name: string;
+
+  /**
+   * Whether the CI/CD job was triggered by a pull-request.
+   */
+  pr: boolean;
+
+  /**
+   * The CI/CD host name, as a boolean. (e.g. `TRAVIS`, `GITHUB_ACTIONS`, `TEAMCITY`, etc.)
+   */
+  CODEBUILD: boolean | undefined;
+  APPVEYOR: boolean | undefined;
+  AZURE_PIPELINES: boolean | undefined;
+  BAMBOO: boolean | undefined;
+  BITBUCKET: boolean | undefined;
+  BITRISE: boolean | undefined;
+  BUDDY: boolean | undefined;
+  BUILDKITE: boolean | undefined;
+  CIRCLE: boolean | undefined;
+  CIRRUS: boolean | undefined;
+  CODESHIP: boolean | undefined;
+  DRONE: boolean | undefined;
+  DSARI: boolean | undefined;
+  GITHUB_ACTIONS: boolean | undefined;
+  GITLAB: boolean | undefined;
+  GOCD: boolean | undefined;
+  HUDSON: boolean | undefined;
+  JENKINS: boolean | undefined;
+  MAGNUM: boolean | undefined;
+  NETLIFY: boolean | undefined;
+  NEVERCODE: boolean | undefined;
+  SAIL: boolean | undefined;
+  SEMAPHORE: boolean | undefined;
+  SHIPPABLE: boolean | undefined;
+  SOLANO: boolean | undefined;
+  STRIDER: boolean | undefined;
+  TASKCLUSTER: boolean | undefined;
+  TEAMCITY: boolean | undefined;
+  TRAVIS: boolean | undefined;
+}
+
 /**
  * Information about the Node host.
  */

src/host.ts

@@ -11,6 +11,7 @@ export const host: Host = {
   node: false,
   browser: getBrowserInfo(),
   env: {},
+  ci: false,
   merge,
   toJSON,
 };

src/isomorphic.browser.ts

@@ -1,4 +1,5 @@
-import { Global, Host, NodeInfo, OSInfo } from "./host";
+import * as ci from "@qawolf/ci-info";
+import { CIInfo, Global, Host, NodeInfo, OSInfo } from "./host";
 import { merge, mergeGlobalHost } from "./merge";
 import { toJSON } from "./to-json";
 
@@ -11,6 +12,7 @@ export const host: Host = {
   node: getNodeInfo(),
   browser: false,
   env: process.env,
+  ci: getCIInfo(),
   merge,
   toJSON,
 };
@@ -45,3 +47,17 @@ function getOSInfo(): OSInfo {
   let linux = !windows && !mac;
   return { windows, mac, linux };
 }
+
+/**
+ * Returns information about the current CI/CD host.
+ */
+function getCIInfo(): false | CIInfo {
+  if (!ci.isCI) {
+    return false;
+  }
+
+  return {
+    pr: ci.isPR,
+    ...ci,
+  };
+}

src/isomorphic.node.ts

@@ -0,0 +1,39 @@
+declare module "@qawolf/ci-info" {
+  interface CIInfo {
+    isCI: boolean;
+    isPR: boolean;
+    name: string;
+    CODEBUILD: boolean | undefined;
+    APPVEYOR: boolean | undefined;
+    AZURE_PIPELINES: boolean | undefined;
+    BAMBOO: boolean | undefined;
+    BITBUCKET: boolean | undefined;
+    BITRISE: boolean | undefined;
+    BUDDY: boolean | undefined;
+    BUILDKITE: boolean | undefined;
+    CIRCLE: boolean | undefined;
+    CIRRUS: boolean | undefined;
+    CODESHIP: boolean | undefined;
+    DRONE: boolean | undefined;
+    DSARI: boolean | undefined;
+    GITHUB_ACTIONS: boolean | undefined;
+    GITLAB: boolean | undefined;
+    GOCD: boolean | undefined;
+    HUDSON: boolean | undefined;
+    JENKINS: boolean | undefined;
+    MAGNUM: boolean | undefined;
+    NETLIFY: boolean | undefined;
+    NEVERCODE: boolean | undefined;
+    SAIL: boolean | undefined;
+    SEMAPHORE: boolean | undefined;
+    SHIPPABLE: boolean | undefined;
+    SOLANO: boolean | undefined;
+    STRIDER: boolean | undefined;
+    TASKCLUSTER: boolean | undefined;
+    TEAMCITY: boolean | undefined;
+    TRAVIS: boolean | undefined;
+  }
+
+  const ci: CIInfo;
+  export = ci;
+}