feat(config): config.CI to override env.CI

BREAKING CHANGE: Prioritize config over environment variables when resolving value for CI
AriPerkkio · Nov 4, 2020 · 377a869 · 377a869
1 parent 015a78c
commit 377a869
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 10 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -19,6 +19,4 @@ jobs:
                 command: yarn test
             - run:
                 name: Integration test
-                command: yarn test:integration
-                environment:
-                  CI: 'null'
+                command: yarn test:integration
diff --git a/README.md b/README.md
@@ -55,7 +55,7 @@ module.exports = {
     /** ESLint configuration */
     eslintrc: {},
 
-    /** Optional boolean flag used to set CI mode. Ignored when process.env.CI is set. */
+    /** Optional boolean flag used to set CI mode. process.env.CI is used when not set. */
     CI: false,
 }
 ```

diff --git a/lib/config/config-templates.ts b/lib/config/config-templates.ts
@@ -49,6 +49,6 @@ export const CONFIGURATION_FILE_TEMPLATE =
         },
     },
 
-    /** Optional boolean flag used to set CI mode. Ignored when process.env.CI is set. */
+    /** Optional boolean flag used to set CI mode. process.env.CI is used when not set. */
     CI: false,
 }`;
diff --git a/lib/config/validator.ts b/lib/config/validator.ts
@@ -57,11 +57,8 @@ export default function constructAndValidateConfiguration(
     if (CI != null && typeof CI !== 'boolean') {
         errors.push(`CI (${CI}) should be a boolean.`);
     } else {
-        // Resolve CI from environment variables, if found. Fallback to configuration file.
-        config.CI =
-            process.env.CI == null || process.env.CI == 'null'
-                ? CI
-                : process.env.CI === 'true';
+        // Resolve CI from configuration file, if found. Fallback to environment variables.
+        config.CI = CI == null ? process.env.CI === 'true' : CI;
     }
 
     if (resultParser && !RESULT_PARSERS.includes(resultParser)) {