Detect provider types (#15)

* rename 'detectProvider' to 'types' * refactor types name
justjavac · Aug 24, 2022 · 2971915 · 2971915
1 parent 428885f
commit 2971915
Show file tree

Hide file tree

Showing 26 changed files with 53 additions and 52 deletions.
diff --git a/mod.ts b/mod.ts
@@ -22,11 +22,11 @@ import vsts from "./services/vsts.ts";
 import wercker from "./services/wercker.ts";
 import git from "./services/git.ts";
 
-import IDetectProvider, { Info } from "./detectProvider.ts";
+import type { DetectProvider, Info } from "./types.ts";
 
 const { env, cwd } = Deno;
 
-const services: { [index: string]: IDetectProvider } = {
+const services: { [index: string]: DetectProvider } = {
   appveyor,
   bamboo,
   bitbucket,

diff --git a/services/appveyor.ts b/services/appveyor.ts
@@ -1,8 +1,8 @@
 // https://www.appveyor.com/docs/environment-variables
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
-const appveyorProvider: IDetectProvider = {
+const appveyorProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.APPVEYOR);
   },

diff --git a/services/bamboo.ts b/services/bamboo.ts
@@ -1,8 +1,8 @@
 // https://confluence.atlassian.com/bamboo/bamboo-variables-289277087.html
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
-const bambooProvider: IDetectProvider = {
+const bambooProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.bamboo_agentId);
   },

diff --git a/services/bitbucket.ts b/services/bitbucket.ts
@@ -1,8 +1,8 @@
 // https://confluence.atlassian.com/bitbucket/environment-variables-794502608.html
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
-const bitbucketProvider: IDetectProvider = {
+const bitbucketProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.BITBUCKET_BUILD_NUMBER);
   },

diff --git a/services/bitrise.ts b/services/bitrise.ts
@@ -1,8 +1,8 @@
 // https://devcenter.bitrise.io/builds/available-environment-variables/#exposed-by-bitriseio
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
-const bitriseProvider: IDetectProvider = {
+const bitriseProvider: DetectProvider = {
   detect(env: { [index: string]: string }) {
     return Boolean(env.BITRISE_IO);
   },

diff --git a/services/buddy.ts b/services/buddy.ts
@@ -1,8 +1,8 @@
 // https://buddy.works/knowledge/deployments/how-use-environment-variables#default-environment-variables
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 import prNumber from "../utils/prNumber.ts";
 
-const buddyProvider: IDetectProvider = {
+const buddyProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.BUDDY_WORKSPACE_ID);
   },

diff --git a/services/buildkite.ts b/services/buildkite.ts
@@ -1,8 +1,8 @@
 // https://buildkite.com/docs/builds/environment-variables
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
-const buildkiteProvider: IDetectProvider = {
+const buildkiteProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.BUILDKITE);
   },

diff --git a/services/circleci.ts b/services/circleci.ts
@@ -1,9 +1,9 @@
 // https://circleci.com/docs/2.0/env-vars/#built-in-environment-variables
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 import prNumber from "../utils/prNumber.ts";
 
-const circleciProvider: IDetectProvider = {
+const circleciProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.CIRCLECI);
   },

diff --git a/services/cirrus.ts b/services/cirrus.ts
@@ -1,10 +1,10 @@
 // https://cirrus-ci.org/guide/writing-tasks/#environment-variables
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
 const CIRRUS_CI_DASHBOARD = "https://cirrus-ci.com";
 
-const cirrusProvider: IDetectProvider = {
+const cirrusProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.CIRRUS_CI);
   },

diff --git a/services/codebuild.ts b/services/codebuild.ts
@@ -1,9 +1,9 @@
 import { branch, head } from "../utils/git.ts";
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
 // https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html
 
-const codebuildProvider: IDetectProvider = {
+const codebuildProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.CODEBUILD_BUILD_ID);
   },

diff --git a/services/codefresh.ts b/services/codefresh.ts
@@ -1,8 +1,8 @@
 // https://codefresh.io/docs/docs/codefresh-yaml/variables#system-provided-variables
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
-const codefreshProvider: IDetectProvider = {
+const codefreshProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.CF_BUILD_ID);
   },

diff --git a/services/codeship.ts b/services/codeship.ts
@@ -1,8 +1,8 @@
 // https://documentation.codeship.com/basic/builds-and-configuration/set-environment-variables/#default-environment-variables
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
-const codeshipProvider: IDetectProvider = {
+const codeshipProvider: DetectProvider = {
   detect(env): boolean {
     return env.CI_NAME != null && env.CI_NAME === "codeship";
   },

diff --git a/services/drone.ts b/services/drone.ts
@@ -1,8 +1,8 @@
 // https://readme.drone.io/reference/environ
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
-const droneProvider: IDetectProvider = {
+const droneProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.DRONE);
   },

diff --git a/services/git.ts b/services/git.ts
@@ -1,8 +1,8 @@
 import { branch, head } from "../utils/git.ts";
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
 // FIXME
-const gitProvider: IDetectProvider = {
+const gitProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.CI);
   },

diff --git a/services/github.ts b/services/github.ts
@@ -1,6 +1,6 @@
 // https://developer.github.com/actions/creating-github-actions/accessing-the-runtime-environment/#environment-variables
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
 function readJsonSync(path: string) {
   const decoder = new TextDecoder("utf-8");
@@ -46,7 +46,7 @@ function getPrEvent(env: {
   return { pr: undefined, branch: undefined };
 }
 
-const githubProvider: IDetectProvider = {
+const githubProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.GITHUB_ACTION);
   },

diff --git a/services/gitlab.ts b/services/gitlab.ts
@@ -1,8 +1,8 @@
 // https://docs.gitlab.com/ce/ci/variables/README.html
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
-const gitlabProvider: IDetectProvider = {
+const gitlabProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.GITLAB_CI);
   },

diff --git a/services/jenkins.ts b/services/jenkins.ts
@@ -1,9 +1,9 @@
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 import { head } from "../utils/git.ts";
 
 // https://wiki.jenkins.io/display/JENKINS/Building+a+software+project
 
-const jenkinsProvider: IDetectProvider = {
+const jenkinsProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.JENKINS_URL);
   },

diff --git a/services/netlify.ts b/services/netlify.ts
@@ -1,12 +1,13 @@
 // https://docs.netlify.com/configure-builds/environment-variables/
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
-const netlifyProvider: IDetectProvider = {
+const netlifyProvider: DetectProvider = {
   detect(env) {
     return env.NETLIFY === "true";
   },
-  configuration(env) {
+  // deno-lint-ignore require-await
+  async configuration(env) {
     const isPr = env.PULL_REQUEST === "true";
 
     return {

diff --git a/services/sail.ts b/services/sail.ts
@@ -1,8 +1,8 @@
 // https://sail.ci/docs/environment-variables
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
-const sailProvider: IDetectProvider = {
+const sailProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.SAILCI);
   },

diff --git a/services/semaphore.ts b/services/semaphore.ts
@@ -1,9 +1,9 @@
 import { head } from "../utils/git.ts";
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
 // https://semaphoreci.com/docs/available-environment-variables.html
 
-const semaphoreProvider: IDetectProvider = {
+const semaphoreProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.SEMAPHORE);
   },

diff --git a/services/shippable.ts b/services/shippable.ts
@@ -1,8 +1,8 @@
 // http://docs.shippable.com/ci/env-vars/#stdEnv
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
-const shippableProvider: IDetectProvider = {
+const shippableProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.SHIPPABLE);
   },

diff --git a/services/teamcity.ts b/services/teamcity.ts
@@ -4,7 +4,7 @@
 
 const javaProperties = require("java-properties");
 import { branch } from "../utils/git.ts";
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
 const PROPERTIES_MAPPING = {
   root: "teamcity.build.workingDir",
@@ -50,7 +50,7 @@ function getProperties(
   );
 }
 
-const teamcityProvider: IDetectProvider = {
+const teamcityProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.TEAMCITY_VERSION);
   },

diff --git a/services/travis.ts b/services/travis.ts
@@ -1,8 +1,8 @@
 // https://docs.travis-ci.com/user/environment-variables#default-environment-variables
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
-const travisProvider: IDetectProvider = {
+const travisProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.TRAVIS);
   },

diff --git a/services/vsts.ts b/services/vsts.ts
@@ -1,9 +1,9 @@
 // https://docs.microsoft.com/en-us/vsts/pipelines/build/variables
 // The docs indicate that SYSTEM_PULLREQUEST_SOURCEBRANCH and SYSTEM_PULLREQUEST_TARGETBRANCH are in the long format (e.g `refs/heads/master`) however tests show they are both in the short format (e.g. `master`)
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
-const vstsProvider: IDetectProvider = {
+const vstsProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.BUILD_BUILDURI);
   },

diff --git a/services/wercker.ts b/services/wercker.ts
@@ -1,8 +1,8 @@
 // http://devcenter.wercker.com/docs/environment-variables/available-env-vars#hs_cos_wrapper_name
 
-import IDetectProvider from "../detectProvider.ts";
+import type { DetectProvider } from "../types.ts";
 
-const werckerProvider: IDetectProvider = {
+const werckerProvider: DetectProvider = {
   detect(env) {
     return Boolean(env.WERCKER_MAIN_PIPELINE_STARTED);
   },

diff --git a/detectProvider.ts → types.ts b/detectProvider.ts → types.ts
@@ -15,7 +15,7 @@ export type Info = {
   root?: string;
 };
 
-export default interface IDetectProvider {
+export interface DetectProvider {
   detect(env: { [index: string]: string }, cwd?: string): boolean;
   configuration(env: { [index: string]: string }, cwd?: string): Promise<Info>;
 }