std-env 4.2.0: detectProvider

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify std-env.detectProvider in pkg:npm/std-env@4.2.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/std-env@4.2.0
Demonstrate these symbols/APIs:
  - std-env.detectProvider
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:5852e802377c5e9458c0fea62c69b3018d289e88b961edf42d3fb9e4143f0597","constraints":{"executionContext":"node"},"contract":["assert detectProvider returns empty name and ci false when no provider environment variables are present","assert detectProvider detects github_actions provider when GITHUB_ACTIONS environment variable is set","assert detectProvider detects vercel provider with ci false when VERCEL environment variable is set","assert detectProvider detects cloudflare_pages provider with ci true when CF_PAGES environment variable is set","assert detectProvider detects netlify provider when NETLIFY environment variable is set","assert detectProvider detects circle provider when CIRCLECI environment variable is set","assert detectProvider detects gitlab provider when GITLAB_CI environment variable is set","assert detectProvider detects aws_amplify provider with ci true when AWS_APP_ID environment variable is set","assert detectProvider detects railway provider when RAILWAY_PROJECT_ID environment variable is set","assert detectProvider detects google_cloudrun provider when K_SERVICE environment variable is set"],"goal":"verify std-env.detectProvider in pkg:npm/std-env@4.2.0","kind":"HOW","packages":["pkg:npm/std-env@4.2.0"],"schemaVersion":1,"symbols":["std-env.detectProvider"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/std-env@4.2.0"],"schemaVersion":1,"subject":"pkg:npm/std-env@4.2.0","symbols":["std-env.detectProvider"],"verifierAdapter":"node-typescript@1"}

const { detectProvider } = require('std-env');

function getDetectedProvider() {
  return detectProvider();
}

function isProvider(expectedName) {
  const info = detectProvider();
  return info.name === expectedName;
}

module.exports = {
  detectProvider,
  getDetectedProvider,
  isProvider,
};

{
  "name": "sample-std-env",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-std-env",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "std-env": "4.2.0"
      }
    },
    "node_modules/std-env": {
      "version": "4.2.0",
      "resolved": "https://registry.npmjs.org/std-env/-/std-env-4.2.0.tgz",
      "integrity": "sha512-oCUKSupKTHX53EyjDtuZQ64pjLJ6yYCtpmEw0goYxtjG9KpbRe8KAsl2tBUGU9DyMcJ0RwJ8GqJAFzMXcXW1Rw==",
      "license": "MIT"
    }
  }
}

{
  "name": "sample-std-env",
  "version": "1.0.0",
  "description": "Minimal clean-room sample verifying detectProvider in std-env",
  "main": "index.js",
  "license": "MIT-0",
  "dependencies": {
    "std-env": "4.2.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify std-env.detectProvider in pkg:npm/std-env@4.2.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/std-env@4.2.0"
  ],
  "symbols": [
    "std-env.detectProvider"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

import assert from 'node:assert';
import { detectProvider } from 'std-env';
import { getDetectedProvider, isProvider } from '../index.js';

const KNOWN_PROVIDER_ENV_VARS = [
  'APPVEYOR',
  'AWS_APP_ID',
  'AWS_AMPLIFY',
  'SYSTEM_TEAMFOUNDATIONCOLLECTIONURI',
  'INPUT_AZURE_STATIC_WEB_APPS_API_TOKEN',
  'AC_APPCIRCLE',
  'bamboo_planKey',
  'BITBUCKET_COMMIT',
  'BITRISE_IO',
  'BUDDY_WORKSPACE_ID',
  'BUILDKITE',
  'CIRCLECI',
  'CIRRUS_CI',
  'CF_PAGES',
  'WORKERS_CI',
  'K_SERVICE',
  'CLOUD_RUN_JOB',
  'CODEBUILD_BUILD_ARN',
  'CF_BUILD_ID',
  'DRONE',
  'DRONE_BUILD_EVENT',
  'DSARI',
  'GITHUB_ACTIONS',
  'GITLAB_CI',
  'CI_MERGE_REQUEST_ID',
  'GO_PIPELINE_LABEL',
  'LAYERCI',
  'JENKINS_URL',
  'HUDSON_URL',
  'MAGNUM',
  'NETLIFY',
  'NETLIFY_LOCAL',
  'NEVERCODE',
  'RENDER',
  'SAILCI',
  'SEMAPHORE',
  'SCREWDRIVER',
  'SHIPPABLE',
  'TDDIUM',
  'STRIDER',
  'TEAMCITY_VERSION',
  'TRAVIS',
  'NOW_BUILDER',
  'VERCEL',
  'VERCEL_ENV',
  'APPCENTER_BUILD_ID',
  'CODESANDBOX_SSE',
  'CODESANDBOX_HOST',
  'STACKBLITZ',
  'STORMKIT',
  'CLEAVR',
  'ZEABUR',
  'CODESPHERE_APP_ID',
  'RAILWAY_PROJECT_ID',
  'RAILWAY_SERVICE_ID',
  'DENO_DEPLOY',
  'DENO_DEPLOYMENT_ID',
  'FIREBASE_APP_HOSTING',
  'EO_PAGES_CI',
];

function withEnv(tempEnv, fn) {
  const saved = {};
  for (const k of KNOWN_PROVIDER_ENV_VARS) {
    saved[k] = process.env[k];
    delete process.env[k];
  }
  for (const [k, v] of Object.entries(tempEnv)) {
    if (v === undefined) {
      delete process.env[k];
    } else {
      process.env[k] = v;
    }
  }
  try {
    fn();
  } finally {
    for (const [k, v] of Object.entries(tempEnv)) {
      if (!(k in saved)) {
        delete process.env[k];
      }
    }
    for (const k of KNOWN_PROVIDER_ENV_VARS) {
      if (saved[k] !== undefined) {
        process.env[k] = saved[k];
      } else {
        delete process.env[k];
      }
    }
  }
}

// 1. Empty/clean environment
withEnv({}, () => {
  const info = detectProvider();
  assert.strictEqual(info.name, '', 'Provider name must be empty string when no provider is detected');
  assert.strictEqual(info.ci, false, 'Provider ci property must be false when no provider is detected');
  assert.strictEqual(isProvider('github_actions'), false, 'isProvider must return false for non-matching provider');
});

// 2. GitHub Actions
withEnv({ GITHUB_ACTIONS: 'true' }, () => {
  const info = detectProvider();
  assert.strictEqual(info.name, 'github_actions', 'detectProvider must detect github_actions');
  assert.strictEqual(isProvider('github_actions'), true, 'isProvider must return true for github_actions');
});

// 3. Vercel
withEnv({ VERCEL: '1' }, () => {
  const info = detectProvider();
  assert.strictEqual(info.name, 'vercel', 'detectProvider must detect vercel');
  assert.strictEqual(info.ci, false, 'detectProvider for vercel must set ci to false');
  assert.strictEqual(isProvider('vercel'), true, 'isProvider must return true for vercel');
});

// 4. Cloudflare Pages
withEnv({ CF_PAGES: '1' }, () => {
  const info = detectProvider();
  assert.strictEqual(info.name, 'cloudflare_pages', 'detectProvider must detect cloudflare_pages');
  assert.strictEqual(info.ci, true, 'detectProvider for cloudflare_pages must set ci to true');
  assert.strictEqual(isProvider('cloudflare_pages'), true, 'isProvider must return true for cloudflare_pages');
});

// 5. Netlify
withEnv({ NETLIFY: 'true' }, () => {
  const info = detectProvider();
  assert.strictEqual(info.name, 'netlify', 'detectProvider must detect netlify');
  assert.strictEqual(isProvider('netlify'), true, 'isProvider must return true for netlify');
});

// 6. Circle CI
withEnv({ CIRCLECI: 'true' }, () => {
  const info = detectProvider();
  assert.strictEqual(info.name, 'circle', 'detectProvider must detect circle');
  assert.strictEqual(isProvider('circle'), true, 'isProvider must return true for circle');
});

// 7. GitLab CI
withEnv({ GITLAB_CI: 'true' }, () => {
  const info = detectProvider();
  assert.strictEqual(info.name, 'gitlab', 'detectProvider must detect gitlab');
  assert.strictEqual(isProvider('gitlab'), true, 'isProvider must return true for gitlab');
});

// 8. AWS Amplify
withEnv({ AWS_APP_ID: 'd123456789' }, () => {
  const info = detectProvider();
  assert.strictEqual(info.name, 'aws_amplify', 'detectProvider must detect aws_amplify');
  assert.strictEqual(info.ci, true, 'detectProvider for aws_amplify must set ci to true');
  assert.strictEqual(isProvider('aws_amplify'), true, 'isProvider must return true for aws_amplify');
});

// 9. Railway
withEnv({ RAILWAY_PROJECT_ID: 'rw-proj-123' }, () => {
  const info = detectProvider();
  assert.strictEqual(info.name, 'railway', 'detectProvider must detect railway');
  assert.strictEqual(isProvider('railway'), true, 'isProvider must return true for railway');
});

// 10. Google Cloud Run
withEnv({ K_SERVICE: 'sample-service' }, () => {
  const info = getDetectedProvider();
  assert.strictEqual(info.name, 'google_cloudrun', 'detectProvider must detect google_cloudrun');
  assert.strictEqual(isProvider('google_cloudrun'), true, 'isProvider must return true for google_cloudrun');
});

console.log('All std-env.detectProvider contract assertions passed.');