readme: Add more information on where they can report missing CI

README.md

@@ -1,12 +1,14 @@
 # inside-ci
 
-Quick tool to check if we are inside a CI environment
+Returns true if code is running inside CI, otherwise false.
+
+This also works as a drop-in replacement for anyone currently using `is-ci`.
+
+If your CI is not being detected, feel free to [add an issue for it](https://git.nfp.is/TheThing/inside-ci/issues) or hit me up on [X (formerly Twitter)](https://x.com/TheThing89) or on discord as `thething_89`.
 
 # API
 
-`insideCi()`
-
-Returns true if inside CI. Otherwise returns false.
+`const inside = require('inside-ci')`
 
 # CLI
 
@@ -14,7 +16,7 @@ Returns true if inside CI. Otherwise returns false.
 
 Returns error code 0 if inside CI.
 
-* `in-ci && echo 'running inside CI'`
+`in-ci && echo 'running inside CI'`
 
 ## `not-ci`
 

in.js

@@ -1,12 +1,10 @@
 #!/usr/bin/env node
 
-let is = module.exports.insideCi = () => {
 // Bail out if CI is overrided
-  return process.env.CI === 'false'
+let is = module.exports = process.env.CI === 'false'
   ? false
   : !!['CI','CI_APP_ID','BUILD_NUMBER','CI_NAME','RUN_ID'].some(x => process.env[x])
-}
 
 if (require.main === module) {
-  process.exit(is() ? 0 : 1)
+  process.exit(is ? 0 : 1)
 }

not.js

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-process.exit(!require("./in.js").insideCi() ? 0 : 1)
+process.exit(!require("./in.js") ? 0 : 1)

package.json

@@ -1,8 +1,8 @@
 {
   "name": "inside-ci",
-  "version": "1.1.1",
+  "version": "2.0.1",
   "description": "Quick tool to check if we are inside CI",
-  "main": "index.js",
+  "main": "in.js",
   "scripts": {
     "test": "eltro -r dot test.mjs",
     "test:watch": "eltro -r dot -w test test.mjs"

test.mjs

@@ -1,8 +1,9 @@
 import { exec } from 'child_process'
 import { Eltro as t, assert } from 'eltro'
-import { insideCi } from './in.js'
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
 
-t.describe('#insideCi()', function () {
+t.describe('in.js', function () {
   // Most CI use env.CI (travis, Gitlab, etc.)
   // There are some exceptions though:
   // CI_APP_ID is used by Appflow: https://ionic.io/docs/appflow/package/environments#predefined-environments
@@ -23,27 +24,35 @@ t.describe('#insideCi()', function () {
     }
   })
 
+  let n = 1
+  function insideCi() {
+    Object.keys(require.cache).forEach(key => {
+      delete require.cache[key]
+    })
+    return import(`./in.js?${n++}`).then(x => x.default)
+  }
+
   testVariables.forEach(name => {
-    t.test(`env.${name} should return true if set`, function () {
+    t.test(`env.${name} should return true if set`, async function () {
       process.env[name] = 'asdf'
-      assert.ok(insideCi())
+      assert.ok(await insideCi())
     })
   })
 
-  t.test('should return false by default', function() {
-    assert.notOk(insideCi())
+  t.test('should return false by default', async function() {
+    assert.notOk(await insideCi())
   })
 
-  t.test('should return false if all are empty strings', function () {
+  t.test('should return false if all are empty strings', async function () {
     for (let name of testVariables) {
       process.env[name] = ''
     }
-    assert.notOk(insideCi())
+    assert.notOk(await insideCi())
   })
 
-  t.test('should return false if env.CI is specifically "false"', function () {
+  t.test('should return false if env.CI is specifically "false"', async function () {
     process.env.CI = 'false'
-    assert.notOk(insideCi())
+    assert.notOk(await insideCi())
   })
 })