std-env 3.0.0-alpha → 3.1.0

package/LICENCE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2021 UnJS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -1,48 +1,52 @@
 # std-env
 
-[![npm](https://img.shields.io/npm/dt/std-env.svg?style=flat-square)](http://npmjs.com/package/std-env)
+[![npm](https://img.shields.io/npm/dm/std-env.svg?style=flat-square)](http://npmjs.com/package/std-env)
 [![npm](https://img.shields.io/npm/v/std-env.svg?style=flat-square)](http://npmjs.com/package/std-env)
+[![bundlephobia](https://img.shields.io/bundlephobia/min/std-env/latest.svg?style=flat-square)](https://bundlephobia.com/result?p=std-env)
 
-Detect running environment of the current Node.js process.
+> Detect current Javascript environment
 
 ## Installation
 
-Using yarn:
-
-```
+```sh
+# Using Yarn
 yarn add std-env
-```
 
-Usin npm:
-
-```
+# Using npm
 npm i std-env
 ```
 
 ## Usage
 
 ```js
-const env = require('std-env')
-
-console.log(env)
-
-/*
-{
-  browser: false,
-  test: false,
-  dev: true,
-  production: false,
-  debug: false,
-  ci: false,
-  tty: true,
-  minimalCLI: false,
-  windows: false,
-  darwin: true,
-  linux: false
-}
-*/
+// ESM
+import { isWindows } from 'std-env'
+
+// CommonJS
+const { isCI } = require('std-env')
 ```
 
+Available exports:
+
+- `hasTTY`
+- `hasWindow`
+- `isCI`
+- `isDebug`
+- `isDevelopment`
+- `isLinux`
+- `isMacOS`
+- `isMinimal`
+- `isProduction`
+- `isTest`
+- `isWindows`
+- `platform`
+- `provider`
+
+You can read more about how each flag works from [./src/index.ts](./src/index.ts).
+
+List of well known providers can be found from [./src/providers.ts](./src/providers.ts).
+
+
 ## License
 
 MIT

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+declare type ProviderName = '' | 'appveyor' | 'azure_pipelines' | 'azure_static' | 'appcircle' | 'bamboo' | 'bitbucket' | 'bitrise' | 'buddy' | 'buildkite' | 'circle' | 'cirrus' | 'codebuild' | 'codefresh' | 'drone' | 'drone' | 'dsari' | 'github_actions' | 'gitlab' | 'gitlab' | 'gocd' | 'layerci' | 'hudson' | 'jenkins' | 'magnum' | 'netlify' | 'netlify' | 'nevercode' | 'render' | 'sail' | 'semaphore' | 'screwdriver' | 'shippable' | 'solano' | 'strider' | 'teamcity' | 'travis' | 'vercel' | 'appcenter' | 'codesandbox' | 'stackblitz' | 'stormkit';
+declare type ProviderInfo = {
+    name: ProviderName;
+    [meta: string]: any;
+};
+
+/** Value of process.platform */
+declare const platform: NodeJS.Platform;
+/** Current provider name */
+declare const provider: ProviderName;
+/** Detect if `CI` environment variable is set or a provider CI detected */
+declare const isCI: boolean;
+/** Detect if stdout.TTY is available */
+declare const hasTTY: boolean;
+/** Detect if global `window` object is available */
+declare const hasWindow: boolean;
+/** Detect if `DEBUG` environment variable is set */
+declare const isDebug: boolean;
+/** Detect if `NODE_ENV` environment variable is `test` */
+declare const isTest: boolean;
+/** Detect if `NODE_ENV` environment variable is `production` */
+declare const isProduction: boolean;
+/** Detect if `NODE_ENV` environment variable is `dev` or `development` */
+declare const isDevelopment: boolean;
+/** Detect if MINIMAL environment variable is set, running in CI or test or TTY is unavailable */
+declare const isMinimal: boolean;
+/** Detect if process.platform is Windows */
+declare const isWindows: boolean;
+/** Detect if process.platform is Linux */
+declare const isLinux: boolean;
+/** Detect if process.platform is macOS (darwin kernel) */
+declare const isMacOS: boolean;
+
+export { ProviderInfo, ProviderName, hasTTY, hasWindow, isCI, isDebug, isDevelopment, isLinux, isMacOS, isMinimal, isProduction, isTest, isWindows, platform, provider };

package/dist/index.mjs

@@ -0,0 +1,87 @@
+const providers = [
+  ["APPVEYOR"],
+  ["AZURE_PIPELINES", "SYSTEM_TEAMFOUNDATIONCOLLECTIONURI"],
+  ["AZURE_STATIC", "INPUT_AZURE_STATIC_WEB_APPS_API_TOKEN"],
+  ["APPCIRCLE", "AC_APPCIRCLE"],
+  ["BAMBOO", "bamboo_planKey"],
+  ["BITBUCKET", "BITBUCKET_COMMIT"],
+  ["BITRISE", "BITRISE_IO"],
+  ["BUDDY", "BUDDY_WORKSPACE_ID"],
+  ["BUILDKITE"],
+  ["CIRCLE", "CIRCLECI"],
+  ["CIRRUS", "CIRRUS_CI"],
+  ["CODEBUILD", "CODEBUILD_BUILD_ARN"],
+  ["CODEFRESH", "CF_BUILD_ID"],
+  ["DRONE"],
+  ["DRONE", "DRONE_BUILD_EVENT"],
+  ["DSARI"],
+  ["GITHUB_ACTIONS"],
+  ["GITLAB", "GITLAB_CI"],
+  ["GITLAB", "CI_MERGE_REQUEST_ID"],
+  ["GOCD", "GO_PIPELINE_LABEL"],
+  ["LAYERCI"],
+  ["HUDSON", "HUDSON_URL"],
+  ["JENKINS", "JENKINS_URL"],
+  ["MAGNUM"],
+  ["NETLIFY"],
+  ["NETLIFY", "NETLIFY_LOCAL", { ci: false }],
+  ["NEVERCODE"],
+  ["RENDER"],
+  ["SAIL", "SAILCI"],
+  ["SEMAPHORE"],
+  ["SCREWDRIVER"],
+  ["SHIPPABLE"],
+  ["SOLANO", "TDDIUM"],
+  ["STRIDER"],
+  ["TEAMCITY", "TEAMCITY_VERSION"],
+  ["TRAVIS"],
+  ["VERCEL", "NOW_BUILDER"],
+  ["APPCENTER", "APPCENTER_BUILD_ID"],
+  ["CODESANDBOX", "CODESANDBOX_SSE", { ci: false }],
+  ["STACKBLITZ"],
+  ["STORMKIT"]
+];
+function detectProvider(env) {
+  for (const provider of providers) {
+    const envName = provider[1] || provider[0];
+    if (env[envName]) {
+      return {
+        name: provider[0].toLowerCase(),
+        ...provider[2]
+      };
+    }
+  }
+  if (env.SHELL && env.SHELL === "/bin/jsh") {
+    return {
+      name: "stackblitz",
+      ci: false
+    };
+  }
+  return {
+    name: "",
+    ci: false
+  };
+}
+
+const processShim = typeof process !== "undefined" ? process : {};
+const envShim = processShim.env || {};
+const providerInfo = detectProvider(envShim);
+const nodeENV = envShim.NODE_ENV || "";
+const platform = processShim.platform;
+const provider = providerInfo.name;
+const isCI = toBoolean(envShim.CI) || providerInfo.ci !== false;
+const hasTTY = toBoolean(processShim.stdout && processShim.stdout.isTTY);
+const hasWindow = typeof window !== "undefined";
+const isDebug = toBoolean(envShim.DEBUG);
+const isTest = toBoolean(envShim.TEST);
+const isProduction = nodeENV === "production";
+const isDevelopment = nodeENV === "dev" || nodeENV === "development";
+const isMinimal = toBoolean(envShim.MINIMAL) || isCI || isTest || !hasTTY;
+const isWindows = /^win/i.test(platform);
+const isLinux = /^linux/i.test(platform);
+const isMacOS = /^darwin/i.test(platform);
+function toBoolean(val) {
+  return val ? val !== "false" : false;
+}
+
+export { hasTTY, hasWindow, isCI, isDebug, isDevelopment, isLinux, isMacOS, isMinimal, isProduction, isTest, isWindows, platform, provider };

package/package.json

@@ -1,19 +1,35 @@
 {
   "name": "std-env",
-  "version": "3.0.0-alpha",
-  "description": "Detect running environment of the current Node.js process",
+  "version": "3.1.0",
+  "description": "Detect current Javascript environment",
+  "repository": "unjs/std-env",
   "license": "MIT",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "repository": "nuxt-contrib/std-env",
-  "contributors": [
-    "Pooya Parsa <pooya@pi0.ir>"
-  ],
-  "dependencies": {
-    "ci-info": "^2.0.0"
+  "sideEffects": false,
+  "exports": {
+    "import": "./dist/index.mjs",
+    "require": "./dist/index.cjs"
   },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
   "files": [
-    "index.js",
-    "index.d.ts"
-  ]
-}
+    "dist"
+  ],
+  "devDependencies": {
+    "@nuxtjs/eslint-config-typescript": "^9.0.0",
+    "c8": "^7.11.0",
+    "eslint": "^8.13.0",
+    "jiti": "^1.13.0",
+    "standard-version": "^9.3.2",
+    "unbuild": "^0.7.4",
+    "vitest": "^0.9.3"
+  },
+  "packageManager": "pnpm@6.32.7",
+  "scripts": {
+    "build": "unbuild",
+    "dev": "vitest",
+    "lint": "eslint --ext .ts .",
+    "release": "pnpm test && standard-version && git push --follow-tags && pnpm publish",
+    "test": "pnpm lint && vitest run"
+  },
+  "readme": "# std-env\n\n[![npm](https://img.shields.io/npm/dm/std-env.svg?style=flat-square)](http://npmjs.com/package/std-env)\n[![npm](https://img.shields.io/npm/v/std-env.svg?style=flat-square)](http://npmjs.com/package/std-env)\n[![bundlephobia](https://img.shields.io/bundlephobia/min/std-env/latest.svg?style=flat-square)](https://bundlephobia.com/result?p=std-env)\n\n> Detect current Javascript environment\n\n## Installation\n\n```sh\n# Using Yarn\nyarn add std-env\n\n# Using npm\nnpm i std-env\n```\n\n## Usage\n\n```js\n// ESM\nimport { isWindows } from 'std-env'\n\n// CommonJS\nconst { isCI } = require('std-env')\n```\n\nAvailable exports:\n\n- `hasTTY`\n- `hasWindow`\n- `isCI`\n- `isDebug`\n- `isDevelopment`\n- `isLinux`\n- `isMacOS`\n- `isMinimal`\n- `isProduction`\n- `isTest`\n- `isWindows`\n- `platform`\n- `provider`\n\nYou can read more about how each flag works from [./src/index.ts](./src/index.ts).\n\nList of well known providers can be found from [./src/providers.ts](./src/providers.ts).\n\n\n## License\n\nMIT\n"
+}

package/index.d.ts

@@ -1,20 +0,0 @@
-declare const env: {
-    readonly browser: boolean
-
-    readonly test: boolean
-    readonly dev: boolean
-    readonly production: boolean
-    readonly debug: boolean
-
-    readonly ci: boolean
-    readonly tty: boolean
-
-    readonly minimal: boolean
-    readonly minimalCLI: boolean
-
-    readonly windows: boolean
-    readonly darwin: boolean
-    readonly linux: boolean
-};
-
-export default env;

package/index.js

@@ -1,70 +0,0 @@
-// Gather initial information
-var isCI = false
-var debug = false
-var tty = false
-var nodeENV = 'development'
-var browser = typeof window !== 'undefined'
-var platform = ''
-var minimal = false
-
-// Boolean helper
-function toBoolean(val) {
-  return (!val || val === 'false') ? false : true
-}
-
-// Process dependent
-if (typeof process !== 'undefined') {
-  // Platform
-  if (process.platform) {
-    platform = String(process.platform)
-  }
-
-  // TTY
-  if (process.stdout) {
-    tty = toBoolean(process.stdout.isTTY)
-  }
-
-  // Is CI
-  isCI = Boolean(require('ci-info').isCI)
-
-  // Env dependent
-  if (process.env) {
-    // NODE_ENV
-    if (process.env.NODE_ENV) {
-      nodeENV = process.env.NODE_ENV
-    }
-
-    // DEBUG
-    debug = toBoolean(process.env.DEBUG)
-
-    // MINIMAL
-    minimal = toBoolean(process.env.MINIMAL)
-  }
-}
-
-// Construct env object
-var env = {
-  browser: browser,
-
-  test: nodeENV === 'test',
-  dev: nodeENV === 'development' || nodeENV === 'dev',
-  production: nodeENV === 'production',
-  debug: debug,
-
-  ci: isCI,
-  tty: tty,
-
-  minimal: undefined,
-  minimalCLI: undefined,
-
-  windows: /^win/i.test(platform),
-  darwin: /^darwin/i.test(platform),
-  linux: /^linux/i.test(platform),
-}
-
-// Compute minimal
-env.minimal = minimal || env.ci || env.test || !env.tty
-env.minimalCLI = env.minimal
-
-// Export env
-module.exports = Object.freeze(env)