@stryke/env 0.20.49 → 0.20.50

package/dist/fs/src/read-file.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"read-file.mjs","names":["readFile","readFileFs"],"sources":["../../../../fs/src/read-file.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { existsSync, readFileSync as readFileSyncFs } from \"node:fs\";\nimport { readFile as readFileFs } from \"node:fs/promises\";\n\n/**\n * Read the given content to the given file path\n *\n * @param filePath - The file path to write to\n */\nexport const readFileSync = (filePath: string): string => {\n  if (!filePath) {\n    throw new Error(\"No file path provided to read data\");\n  }\n\n  return readFileSyncFs(filePath, { encoding: \"utf8\" });\n};\n\n/**\n * Read the given content to the given file path\n *\n * @param filePath - The file path to read to\n */\nexport const readFile = async (filePath: string): Promise<string> => {\n  if (!filePath) {\n    throw new Error(\"No file path provided to read data\");\n  }\n\n  return readFileFs(filePath, { encoding: \"utf8\" });\n};\n\n/**\n * Reads a file if it exists, otherwise returns an empty string.\n *\n * @param path - The path to the file to read.\n * @returns The content of the file if it exists, otherwise an empty string.\n */\nexport function readFileIfExistingSync(path: string) {\n  return existsSync(path) ? readFileSync(path) : \"\";\n}\n\n/**\n * Reads a file if it exists, otherwise returns an empty string.\n *\n * @param path - The path to the file to read.\n * @returns The content of the file if it exists, otherwise an empty string.\n */\nexport async function readFileIfExisting(path: string) {\n  return existsSync(path) ? readFile(path) : \"\";\n}\n"],"mappings":"iFAuCA,MAAaA,EAAW,KAAO,IAAsC,CACnE,GAAI,CAAC,EACH,MAAU,MAAM,qCAAqC,CAGvD,OAAOC,EAAW,EAAU,CAAE,SAAU,OAAQ,CAAC"}
+{"version":3,"file":"read-file.mjs","names":["readFile","readFileFs"],"sources":["../../../../fs/src/read-file.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { existsSync, readFileSync as readFileSyncFs } from \"node:fs\";\nimport { readFile as readFileFs } from \"node:fs/promises\";\n\n/**\n * Read the given content to the given file path\n *\n * @param filePath - The file path to write to\n */\nexport const readFileSync = (filePath: string): string => {\n  if (!filePath) {\n    throw new Error(\"No file path provided to read data\");\n  }\n\n  return readFileSyncFs(filePath, { encoding: \"utf8\" });\n};\n\n/**\n * Read the given content to the given file path\n *\n * @param filePath - The file path to read to\n */\nexport const readFile = async (filePath: string): Promise<string> => {\n  if (!filePath) {\n    throw new Error(\"No file path provided to read data\");\n  }\n\n  return readFileFs(filePath, { encoding: \"utf8\" });\n};\n\n/**\n * Reads a file if it exists, otherwise returns an empty string.\n *\n * @param path - The path to the file to read.\n * @returns The content of the file if it exists, otherwise an empty string.\n */\nexport function readFileIfExistingSync(path: string) {\n  return existsSync(path) ? readFileSync(path) : \"\";\n}\n\n/**\n * Reads a file if it exists, otherwise returns an empty string.\n *\n * @param path - The path to the file to read.\n * @returns The content of the file if it exists, otherwise an empty string.\n */\nexport async function readFileIfExisting(path: string) {\n  return existsSync(path) ? readFile(path) : \"\";\n}\n"],"mappings":";;;;;;;;;AAuCA,MAAaA,aAAW,OAAO,aAAsC;AACnE,KAAI,CAAC,SACH,OAAM,IAAI,MAAM,qCAAqC;AAGvD,QAAOC,SAAW,UAAU,EAAE,UAAU,QAAQ,CAAC"}

package/dist/get-env-paths.cjs

@@ -1 +1,87 @@
-const e=require(`./_virtual/rolldown_runtime.cjs`),t=require(`./path/src/join-paths.cjs`),n=require(`./string-format/src/title-case.cjs`);let r=require(`node:os`);r=e.__toESM(r);let i=require(`node:path`);i=e.__toESM(i);const a=r.default.homedir(),o=r.default.tmpdir(),s=e=>{let n=t.joinPaths(a,`Library`);return{data:t.joinPaths(n,`Application Support`,e),config:t.joinPaths(n,`Preferences`,e),cache:t.joinPaths(n,`Caches`,e),log:t.joinPaths(n,`Logs`,e),temp:t.joinPaths(o,e)}},c=e=>{let r=process.env.APPDATA||t.joinPaths(a,`AppData`,`Roaming`),i=process.env.LOCALAPPDATA||t.joinPaths(a,`AppData`,`Local`),s=n.titleCase(e).trim().replace(/\s+/g,``);return{data:t.joinPaths(i,s,`Data`),config:t.joinPaths(r,s,`Config`),cache:t.joinPaths(i,`Cache`,e),log:t.joinPaths(i,s,`Log`),temp:t.joinPaths(o,e)}},l=e=>{let n=i.default.basename(a);return{data:t.joinPaths(process.env.XDG_DATA_HOME||t.joinPaths(a,`.local`,`share`),e),config:t.joinPaths(process.env.XDG_CONFIG_HOME||t.joinPaths(a,`.config`),e),cache:t.joinPaths(process.env.XDG_CACHE_HOME||t.joinPaths(a,`.cache`),e),log:t.joinPaths(process.env.XDG_STATE_HOME||t.joinPaths(a,`.local`,`state`),e),temp:process.env.DEVENV_RUNTIME||process.env.XDG_RUNTIME_DIR?t.joinPaths(process.env.DEVENV_RUNTIME||process.env.XDG_RUNTIME_DIR,e):t.joinPaths(o,n,e)}};function u(e={}){let n=e.orgId||`storm-software`;if(!n)throw Error("You need to provide an orgId to the `getEnvPaths` function");e.suffix&&(n+=`-${typeof e.suffix==`string`?e.suffix:`nodejs`}`);let r={};return r=process.platform===`darwin`?s(n):process.platform===`win32`?c(n):l(n),process.env.STORM_DATA_DIR?r.data=process.env.STORM_DATA_DIR:process.env.STORM_CONFIG_DIR?r.config=process.env.STORM_CONFIG_DIR:process.env.STORM_CACHE_DIR?r.cache=process.env.STORM_CACHE_DIR:process.env.STORM_LOG_DIR?r.log=process.env.STORM_LOG_DIR:process.env.STORM_TEMP_DIR&&(r.temp=process.env.STORM_TEMP_DIR),e.workspaceRoot&&(r.cache??=t.joinPaths(e.workspaceRoot,`node_modules`,`.cache`,n),r.temp??=t.joinPaths(e.workspaceRoot,`tmp`,n),r.log??=t.joinPaths(r.temp,`logs`),r.config??=t.joinPaths(e.workspaceRoot,`.config`,n)),Object.keys(r).reduce((n,i)=>{if(r[i]){let a=r[i];n[i]=e.appId&&e.appId!==e.orgId&&e.appId!==e.nestedDir?t.joinPaths(a,e.appId):a,e.nestedDir&&e.nestedDir!==e.orgId&&e.nestedDir!==e.appId&&(n[i]=t.joinPaths(n[i],e.nestedDir))}return n},{})}exports.getEnvPaths=u;
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+const require_join_paths = require('./path/src/join-paths.cjs');
+const require_title_case = require('./string-format/src/title-case.cjs');
+let node_os = require("node:os");
+node_os = require_rolldown_runtime.__toESM(node_os);
+let node_path = require("node:path");
+node_path = require_rolldown_runtime.__toESM(node_path);
+
+//#region src/get-env-paths.ts
+const homedir = node_os.default.homedir();
+const tmpdir = node_os.default.tmpdir();
+const macos = (orgId) => {
+	const library = require_join_paths.joinPaths(homedir, "Library");
+	return {
+		data: require_join_paths.joinPaths(library, "Application Support", orgId),
+		config: require_join_paths.joinPaths(library, "Preferences", orgId),
+		cache: require_join_paths.joinPaths(library, "Caches", orgId),
+		log: require_join_paths.joinPaths(library, "Logs", orgId),
+		temp: require_join_paths.joinPaths(tmpdir, orgId)
+	};
+};
+const windows = (orgId) => {
+	const appData = process.env.APPDATA || require_join_paths.joinPaths(homedir, "AppData", "Roaming");
+	const localAppData = process.env.LOCALAPPDATA || require_join_paths.joinPaths(homedir, "AppData", "Local");
+	const windowsFormattedOrgId = require_title_case.titleCase(orgId).trim().replace(/\s+/g, "");
+	return {
+		data: require_join_paths.joinPaths(localAppData, windowsFormattedOrgId, "Data"),
+		config: require_join_paths.joinPaths(appData, windowsFormattedOrgId, "Config"),
+		cache: require_join_paths.joinPaths(localAppData, "Cache", orgId),
+		log: require_join_paths.joinPaths(localAppData, windowsFormattedOrgId, "Log"),
+		temp: require_join_paths.joinPaths(tmpdir, orgId)
+	};
+};
+const linux = (orgId) => {
+	const username = node_path.default.basename(homedir);
+	return {
+		data: require_join_paths.joinPaths(process.env.XDG_DATA_HOME || require_join_paths.joinPaths(homedir, ".local", "share"), orgId),
+		config: require_join_paths.joinPaths(process.env.XDG_CONFIG_HOME || require_join_paths.joinPaths(homedir, ".config"), orgId),
+		cache: require_join_paths.joinPaths(process.env.XDG_CACHE_HOME || require_join_paths.joinPaths(homedir, ".cache"), orgId),
+		log: require_join_paths.joinPaths(process.env.XDG_STATE_HOME || require_join_paths.joinPaths(homedir, ".local", "state"), orgId),
+		temp: process.env.DEVENV_RUNTIME || process.env.XDG_RUNTIME_DIR ? require_join_paths.joinPaths(process.env.DEVENV_RUNTIME || process.env.XDG_RUNTIME_DIR, orgId) : require_join_paths.joinPaths(tmpdir, username, orgId)
+	};
+};
+/**
+* Get paths for storing things like data, config, logs, and cache in the current runtime environment.
+*
+* @remarks
+* On macOS, directories are generally created in `~/Library/Application Support/<name>`.
+* On Windows, directories are generally created in `%AppData%/<name>`.
+* On Linux, directories are generally created in `~/.config/<name>` - this is determined via the [XDG Base Directory spec](https://specifications.freedesktop.org/basedir-spec/latest/).
+*
+* If the `STORM_DATA_DIR`, `STORM_CONFIG_DIR`, `STORM_CACHE_DIR`, `STORM_LOG_DIR`, or `STORM_TEMP_DIR` environment variables are set, they will be used instead of the default paths.
+*
+* @param options - Parameters used to determine the specific paths for the current project/runtime environment
+* @returns An object containing the various paths for the runtime environment
+*/
+function getEnvPaths(options = {}) {
+	let orgId = options.orgId || "storm-software";
+	if (!orgId) throw new Error("You need to provide an orgId to the `getEnvPaths` function");
+	if (options.suffix) orgId += `-${typeof options.suffix === "string" ? options.suffix : "nodejs"}`;
+	let result = {};
+	if (process.platform === "darwin") result = macos(orgId);
+	else if (process.platform === "win32") result = windows(orgId);
+	else result = linux(orgId);
+	if (process.env.STORM_DATA_DIR) result.data = process.env.STORM_DATA_DIR;
+	else if (process.env.STORM_CONFIG_DIR) result.config = process.env.STORM_CONFIG_DIR;
+	else if (process.env.STORM_CACHE_DIR) result.cache = process.env.STORM_CACHE_DIR;
+	else if (process.env.STORM_LOG_DIR) result.log = process.env.STORM_LOG_DIR;
+	else if (process.env.STORM_TEMP_DIR) result.temp = process.env.STORM_TEMP_DIR;
+	if (options.workspaceRoot) {
+		result.cache ??= require_join_paths.joinPaths(options.workspaceRoot, "node_modules", ".cache", orgId);
+		result.temp ??= require_join_paths.joinPaths(options.workspaceRoot, "tmp", orgId);
+		result.log ??= require_join_paths.joinPaths(result.temp, "logs");
+		result.config ??= require_join_paths.joinPaths(options.workspaceRoot, ".config", orgId);
+	}
+	return Object.keys(result).reduce((ret, key) => {
+		if (result[key]) {
+			const filePath = result[key];
+			ret[key] = options.appId && options.appId !== options.orgId && options.appId !== options.nestedDir ? require_join_paths.joinPaths(filePath, options.appId) : filePath;
+			if (options.nestedDir && options.nestedDir !== options.orgId && options.nestedDir !== options.appId) ret[key] = require_join_paths.joinPaths(ret[key], options.nestedDir);
+		}
+		return ret;
+	}, {});
+}
+
+//#endregion
+exports.getEnvPaths = getEnvPaths;

package/dist/get-env-paths.mjs

@@ -1,2 +1,85 @@
-import{joinPaths as e}from"./path/src/join-paths.mjs";import{titleCase as t}from"./string-format/src/title-case.mjs";import n from"node:os";import r from"node:path";const i=n.homedir(),a=n.tmpdir(),o=t=>{let n=e(i,`Library`);return{data:e(n,`Application Support`,t),config:e(n,`Preferences`,t),cache:e(n,`Caches`,t),log:e(n,`Logs`,t),temp:e(a,t)}},s=n=>{let r=process.env.APPDATA||e(i,`AppData`,`Roaming`),o=process.env.LOCALAPPDATA||e(i,`AppData`,`Local`),s=t(n).trim().replace(/\s+/g,``);return{data:e(o,s,`Data`),config:e(r,s,`Config`),cache:e(o,`Cache`,n),log:e(o,s,`Log`),temp:e(a,n)}},c=t=>{let n=r.basename(i);return{data:e(process.env.XDG_DATA_HOME||e(i,`.local`,`share`),t),config:e(process.env.XDG_CONFIG_HOME||e(i,`.config`),t),cache:e(process.env.XDG_CACHE_HOME||e(i,`.cache`),t),log:e(process.env.XDG_STATE_HOME||e(i,`.local`,`state`),t),temp:process.env.DEVENV_RUNTIME||process.env.XDG_RUNTIME_DIR?e(process.env.DEVENV_RUNTIME||process.env.XDG_RUNTIME_DIR,t):e(a,n,t)}};function l(t={}){let n=t.orgId||`storm-software`;if(!n)throw Error("You need to provide an orgId to the `getEnvPaths` function");t.suffix&&(n+=`-${typeof t.suffix==`string`?t.suffix:`nodejs`}`);let r={};return r=process.platform===`darwin`?o(n):process.platform===`win32`?s(n):c(n),process.env.STORM_DATA_DIR?r.data=process.env.STORM_DATA_DIR:process.env.STORM_CONFIG_DIR?r.config=process.env.STORM_CONFIG_DIR:process.env.STORM_CACHE_DIR?r.cache=process.env.STORM_CACHE_DIR:process.env.STORM_LOG_DIR?r.log=process.env.STORM_LOG_DIR:process.env.STORM_TEMP_DIR&&(r.temp=process.env.STORM_TEMP_DIR),t.workspaceRoot&&(r.cache??=e(t.workspaceRoot,`node_modules`,`.cache`,n),r.temp??=e(t.workspaceRoot,`tmp`,n),r.log??=e(r.temp,`logs`),r.config??=e(t.workspaceRoot,`.config`,n)),Object.keys(r).reduce((n,i)=>{if(r[i]){let a=r[i];n[i]=t.appId&&t.appId!==t.orgId&&t.appId!==t.nestedDir?e(a,t.appId):a,t.nestedDir&&t.nestedDir!==t.orgId&&t.nestedDir!==t.appId&&(n[i]=e(n[i],t.nestedDir))}return n},{})}export{l as getEnvPaths};
+import { joinPaths } from "./path/src/join-paths.mjs";
+import { titleCase } from "./string-format/src/title-case.mjs";
+import os from "node:os";
+import path from "node:path";
+
+//#region src/get-env-paths.ts
+const homedir = os.homedir();
+const tmpdir = os.tmpdir();
+const macos = (orgId) => {
+	const library = joinPaths(homedir, "Library");
+	return {
+		data: joinPaths(library, "Application Support", orgId),
+		config: joinPaths(library, "Preferences", orgId),
+		cache: joinPaths(library, "Caches", orgId),
+		log: joinPaths(library, "Logs", orgId),
+		temp: joinPaths(tmpdir, orgId)
+	};
+};
+const windows = (orgId) => {
+	const appData = process.env.APPDATA || joinPaths(homedir, "AppData", "Roaming");
+	const localAppData = process.env.LOCALAPPDATA || joinPaths(homedir, "AppData", "Local");
+	const windowsFormattedOrgId = titleCase(orgId).trim().replace(/\s+/g, "");
+	return {
+		data: joinPaths(localAppData, windowsFormattedOrgId, "Data"),
+		config: joinPaths(appData, windowsFormattedOrgId, "Config"),
+		cache: joinPaths(localAppData, "Cache", orgId),
+		log: joinPaths(localAppData, windowsFormattedOrgId, "Log"),
+		temp: joinPaths(tmpdir, orgId)
+	};
+};
+const linux = (orgId) => {
+	const username = path.basename(homedir);
+	return {
+		data: joinPaths(process.env.XDG_DATA_HOME || joinPaths(homedir, ".local", "share"), orgId),
+		config: joinPaths(process.env.XDG_CONFIG_HOME || joinPaths(homedir, ".config"), orgId),
+		cache: joinPaths(process.env.XDG_CACHE_HOME || joinPaths(homedir, ".cache"), orgId),
+		log: joinPaths(process.env.XDG_STATE_HOME || joinPaths(homedir, ".local", "state"), orgId),
+		temp: process.env.DEVENV_RUNTIME || process.env.XDG_RUNTIME_DIR ? joinPaths(process.env.DEVENV_RUNTIME || process.env.XDG_RUNTIME_DIR, orgId) : joinPaths(tmpdir, username, orgId)
+	};
+};
+/**
+* Get paths for storing things like data, config, logs, and cache in the current runtime environment.
+*
+* @remarks
+* On macOS, directories are generally created in `~/Library/Application Support/<name>`.
+* On Windows, directories are generally created in `%AppData%/<name>`.
+* On Linux, directories are generally created in `~/.config/<name>` - this is determined via the [XDG Base Directory spec](https://specifications.freedesktop.org/basedir-spec/latest/).
+*
+* If the `STORM_DATA_DIR`, `STORM_CONFIG_DIR`, `STORM_CACHE_DIR`, `STORM_LOG_DIR`, or `STORM_TEMP_DIR` environment variables are set, they will be used instead of the default paths.
+*
+* @param options - Parameters used to determine the specific paths for the current project/runtime environment
+* @returns An object containing the various paths for the runtime environment
+*/
+function getEnvPaths(options = {}) {
+	let orgId = options.orgId || "storm-software";
+	if (!orgId) throw new Error("You need to provide an orgId to the `getEnvPaths` function");
+	if (options.suffix) orgId += `-${typeof options.suffix === "string" ? options.suffix : "nodejs"}`;
+	let result = {};
+	if (process.platform === "darwin") result = macos(orgId);
+	else if (process.platform === "win32") result = windows(orgId);
+	else result = linux(orgId);
+	if (process.env.STORM_DATA_DIR) result.data = process.env.STORM_DATA_DIR;
+	else if (process.env.STORM_CONFIG_DIR) result.config = process.env.STORM_CONFIG_DIR;
+	else if (process.env.STORM_CACHE_DIR) result.cache = process.env.STORM_CACHE_DIR;
+	else if (process.env.STORM_LOG_DIR) result.log = process.env.STORM_LOG_DIR;
+	else if (process.env.STORM_TEMP_DIR) result.temp = process.env.STORM_TEMP_DIR;
+	if (options.workspaceRoot) {
+		result.cache ??= joinPaths(options.workspaceRoot, "node_modules", ".cache", orgId);
+		result.temp ??= joinPaths(options.workspaceRoot, "tmp", orgId);
+		result.log ??= joinPaths(result.temp, "logs");
+		result.config ??= joinPaths(options.workspaceRoot, ".config", orgId);
+	}
+	return Object.keys(result).reduce((ret, key) => {
+		if (result[key]) {
+			const filePath = result[key];
+			ret[key] = options.appId && options.appId !== options.orgId && options.appId !== options.nestedDir ? joinPaths(filePath, options.appId) : filePath;
+			if (options.nestedDir && options.nestedDir !== options.orgId && options.nestedDir !== options.appId) ret[key] = joinPaths(ret[key], options.nestedDir);
+		}
+		return ret;
+	}, {});
+}
+
+//#endregion
+export { getEnvPaths };
 //# sourceMappingURL=get-env-paths.mjs.map

package/dist/get-env-paths.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-env-paths.mjs","names":[],"sources":["../src/get-env-paths.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { joinPaths } from \"@stryke/path/join-paths\";\nimport { titleCase } from \"@stryke/string-format/title-case\";\nimport os from \"node:os\";\nimport path from \"node:path\";\n\n// Forked from https://www.npmjs.com/package/env-paths\n\nconst homedir = os.homedir();\nconst tmpdir = os.tmpdir();\n\n/**\n * Options for the `getEnvPaths` function.\n */\nexport interface GetEnvPathsOptions {\n  /**\n   * The name of the organization\n   *\n   * @defaultValue \"storm-software\"\n   */\n  orgId?: string;\n\n  /**\n   * The name of the specific application to use as a nested folder inside the organization's folder\n   *\n   * For example: `~/ ... /storm-software/Log/<appId>`\n   */\n  appId?: string;\n\n  /**\n   * The name of the specific application to use as a nested folder inside the organization's folder\n   *\n   * When a value is provided, it will use `~/ ... /storm-software/Log/<appId>/<nestedDir>`\n   *\n   * @remarks\n   * If no child is provided, it will use `~/ ... /storm-software/Log/<appId>`\n   */\n  nestedDir?: string;\n\n  /**\n   * The suffix to append to the project name.\n   *\n   * @remarks\n   * If `suffix` is `true`, the project name will be suffixed with `\"nodejs\"`.\n   *\n   * @defaultValue false\n   */\n  suffix?: string | boolean | null;\n\n  /**\n   * The root directory of the workspace that is used for determining the `cache` and `tmp` paths if they were not already set by other means.\n   */\n  workspaceRoot?: string;\n}\n\nexport interface EnvPaths {\n  data: string;\n  config: string;\n  cache: string;\n  log: string;\n  temp: string;\n}\n\nconst macos = (orgId: string): EnvPaths => {\n  const library = joinPaths(homedir, \"Library\");\n\n  return {\n    data: joinPaths(library, \"Application Support\", orgId),\n    config: joinPaths(library, \"Preferences\", orgId),\n    cache: joinPaths(library, \"Caches\", orgId),\n    log: joinPaths(library, \"Logs\", orgId),\n    temp: joinPaths(tmpdir, orgId)\n  };\n};\n\nconst windows = (orgId: string): EnvPaths => {\n  const appData =\n    process.env.APPDATA || joinPaths(homedir, \"AppData\", \"Roaming\");\n  const localAppData =\n    process.env.LOCALAPPDATA || joinPaths(homedir, \"AppData\", \"Local\");\n\n  const windowsFormattedOrgId = titleCase(orgId).trim().replace(/\\s+/g, \"\");\n\n  return {\n    // Data/config/cache/log are invented by me as Windows isn't opinionated about this\n    data: joinPaths(localAppData, windowsFormattedOrgId, \"Data\"),\n    config: joinPaths(appData, windowsFormattedOrgId, \"Config\"),\n    cache: joinPaths(localAppData, \"Cache\", orgId),\n    log: joinPaths(localAppData, windowsFormattedOrgId, \"Log\"),\n    temp: joinPaths(tmpdir, orgId)\n  };\n};\n\n// https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html\nconst linux = (orgId: string): EnvPaths => {\n  const username = path.basename(homedir);\n\n  return {\n    data: joinPaths(\n      process.env.XDG_DATA_HOME || joinPaths(homedir, \".local\", \"share\"),\n      orgId\n    ),\n    config: joinPaths(\n      process.env.XDG_CONFIG_HOME || joinPaths(homedir, \".config\"),\n      orgId\n    ),\n    cache: joinPaths(\n      process.env.XDG_CACHE_HOME || joinPaths(homedir, \".cache\"),\n      orgId\n    ),\n    // https://wiki.debian.org/XDGBaseDirectorySpecification#state\n    log: joinPaths(\n      process.env.XDG_STATE_HOME || joinPaths(homedir, \".local\", \"state\"),\n      orgId\n    ),\n    // https://devenv.sh/files-and-variables/#devenv_root\n    temp:\n      process.env.DEVENV_RUNTIME || process.env.XDG_RUNTIME_DIR\n        ? joinPaths(\n            (process.env.DEVENV_RUNTIME || process.env.XDG_RUNTIME_DIR)!,\n            orgId\n          )\n        : joinPaths(tmpdir, username, orgId)\n  };\n};\n\n/**\n * Get paths for storing things like data, config, logs, and cache in the current runtime environment.\n *\n * @remarks\n * On macOS, directories are generally created in `~/Library/Application Support/<name>`.\n * On Windows, directories are generally created in `%AppData%/<name>`.\n * On Linux, directories are generally created in `~/.config/<name>` - this is determined via the [XDG Base Directory spec](https://specifications.freedesktop.org/basedir-spec/latest/).\n *\n * If the `STORM_DATA_DIR`, `STORM_CONFIG_DIR`, `STORM_CACHE_DIR`, `STORM_LOG_DIR`, or `STORM_TEMP_DIR` environment variables are set, they will be used instead of the default paths.\n *\n * @param options - Parameters used to determine the specific paths for the current project/runtime environment\n * @returns An object containing the various paths for the runtime environment\n */\nexport function getEnvPaths(options: GetEnvPathsOptions = {}): EnvPaths {\n  let orgId = options.orgId || \"storm-software\";\n  if (!orgId) {\n    throw new Error(\n      \"You need to provide an orgId to the `getEnvPaths` function\"\n    );\n  }\n\n  if (options.suffix) {\n    // Add suffix to prevent possible conflict with native apps\n    orgId += `-${typeof options.suffix === \"string\" ? options.suffix : \"nodejs\"}`;\n  }\n\n  let result = {} as EnvPaths;\n\n  if (process.platform === \"darwin\") {\n    result = macos(orgId);\n  } else if (process.platform === \"win32\") {\n    result = windows(orgId);\n  } else {\n    result = linux(orgId);\n  }\n\n  if (process.env.STORM_DATA_DIR) {\n    result.data = process.env.STORM_DATA_DIR;\n  } else if (process.env.STORM_CONFIG_DIR) {\n    result.config = process.env.STORM_CONFIG_DIR;\n  } else if (process.env.STORM_CACHE_DIR) {\n    result.cache = process.env.STORM_CACHE_DIR;\n  } else if (process.env.STORM_LOG_DIR) {\n    result.log = process.env.STORM_LOG_DIR;\n  } else if (process.env.STORM_TEMP_DIR) {\n    result.temp = process.env.STORM_TEMP_DIR;\n  }\n\n  if (options.workspaceRoot) {\n    result.cache ??= joinPaths(\n      options.workspaceRoot,\n      \"node_modules\",\n      \".cache\",\n      orgId\n    );\n    result.temp ??= joinPaths(options.workspaceRoot, \"tmp\", orgId);\n    result.log ??= joinPaths(result.temp, \"logs\");\n    result.config ??= joinPaths(options.workspaceRoot, \".config\", orgId);\n  }\n\n  return Object.keys(result).reduce((ret, key) => {\n    if (result[key as keyof EnvPaths]) {\n      const filePath = result[key as keyof EnvPaths];\n\n      ret[key as keyof EnvPaths] =\n        options.appId &&\n        options.appId !== options.orgId &&\n        options.appId !== options.nestedDir\n          ? joinPaths(filePath, options.appId)\n          : filePath;\n\n      if (\n        options.nestedDir &&\n        options.nestedDir !== options.orgId &&\n        options.nestedDir !== options.appId\n      ) {\n        ret[key as keyof EnvPaths] = joinPaths(\n          ret[key as keyof EnvPaths],\n          options.nestedDir\n        );\n      }\n    }\n\n    return ret;\n  }, {} as EnvPaths);\n}\n"],"mappings":"qKAyBA,MAAM,EAAU,EAAG,SAAS,CACtB,EAAS,EAAG,QAAQ,CAsDpB,EAAS,GAA4B,CACzC,IAAM,EAAU,EAAU,EAAS,UAAU,CAE7C,MAAO,CACL,KAAM,EAAU,EAAS,sBAAuB,EAAM,CACtD,OAAQ,EAAU,EAAS,cAAe,EAAM,CAChD,MAAO,EAAU,EAAS,SAAU,EAAM,CAC1C,IAAK,EAAU,EAAS,OAAQ,EAAM,CACtC,KAAM,EAAU,EAAQ,EAAM,CAC/B,EAGG,EAAW,GAA4B,CAC3C,IAAM,EACJ,QAAQ,IAAI,SAAW,EAAU,EAAS,UAAW,UAAU,CAC3D,EACJ,QAAQ,IAAI,cAAgB,EAAU,EAAS,UAAW,QAAQ,CAE9D,EAAwB,EAAU,EAAM,CAAC,MAAM,CAAC,QAAQ,OAAQ,GAAG,CAEzE,MAAO,CAEL,KAAM,EAAU,EAAc,EAAuB,OAAO,CAC5D,OAAQ,EAAU,EAAS,EAAuB,SAAS,CAC3D,MAAO,EAAU,EAAc,QAAS,EAAM,CAC9C,IAAK,EAAU,EAAc,EAAuB,MAAM,CAC1D,KAAM,EAAU,EAAQ,EAAM,CAC/B,EAIG,EAAS,GAA4B,CACzC,IAAM,EAAW,EAAK,SAAS,EAAQ,CAEvC,MAAO,CACL,KAAM,EACJ,QAAQ,IAAI,eAAiB,EAAU,EAAS,SAAU,QAAQ,CAClE,EACD,CACD,OAAQ,EACN,QAAQ,IAAI,iBAAmB,EAAU,EAAS,UAAU,CAC5D,EACD,CACD,MAAO,EACL,QAAQ,IAAI,gBAAkB,EAAU,EAAS,SAAS,CAC1D,EACD,CAED,IAAK,EACH,QAAQ,IAAI,gBAAkB,EAAU,EAAS,SAAU,QAAQ,CACnE,EACD,CAED,KACE,QAAQ,IAAI,gBAAkB,QAAQ,IAAI,gBACtC,EACG,QAAQ,IAAI,gBAAkB,QAAQ,IAAI,gBAC3C,EACD,CACD,EAAU,EAAQ,EAAU,EAAM,CACzC,EAgBH,SAAgB,EAAY,EAA8B,EAAE,CAAY,CACtE,IAAI,EAAQ,EAAQ,OAAS,iBAC7B,GAAI,CAAC,EACH,MAAU,MACR,6DACD,CAGC,EAAQ,SAEV,GAAS,IAAI,OAAO,EAAQ,QAAW,SAAW,EAAQ,OAAS,YAGrE,IAAI,EAAS,EAAE,CAkCf,MAhCA,CAKE,EALE,QAAQ,WAAa,SACd,EAAM,EAAM,CACZ,QAAQ,WAAa,QACrB,EAAQ,EAAM,CAEd,EAAM,EAAM,CAGnB,QAAQ,IAAI,eACd,EAAO,KAAO,QAAQ,IAAI,eACjB,QAAQ,IAAI,iBACrB,EAAO,OAAS,QAAQ,IAAI,iBACnB,QAAQ,IAAI,gBACrB,EAAO,MAAQ,QAAQ,IAAI,gBAClB,QAAQ,IAAI,cACrB,EAAO,IAAM,QAAQ,IAAI,cAChB,QAAQ,IAAI,iBACrB,EAAO,KAAO,QAAQ,IAAI,gBAGxB,EAAQ,gBACV,EAAO,QAAU,EACf,EAAQ,cACR,eACA,SACA,EACD,CACD,EAAO,OAAS,EAAU,EAAQ,cAAe,MAAO,EAAM,CAC9D,EAAO,MAAQ,EAAU,EAAO,KAAM,OAAO,CAC7C,EAAO,SAAW,EAAU,EAAQ,cAAe,UAAW,EAAM,EAG/D,OAAO,KAAK,EAAO,CAAC,QAAQ,EAAK,IAAQ,CAC9C,GAAI,EAAO,GAAwB,CACjC,IAAM,EAAW,EAAO,GAExB,EAAI,GACF,EAAQ,OACR,EAAQ,QAAU,EAAQ,OAC1B,EAAQ,QAAU,EAAQ,UACtB,EAAU,EAAU,EAAQ,MAAM,CAClC,EAGJ,EAAQ,WACR,EAAQ,YAAc,EAAQ,OAC9B,EAAQ,YAAc,EAAQ,QAE9B,EAAI,GAAyB,EAC3B,EAAI,GACJ,EAAQ,UACT,EAIL,OAAO,GACN,EAAE,CAAa"}
+{"version":3,"file":"get-env-paths.mjs","names":[],"sources":["../src/get-env-paths.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { joinPaths } from \"@stryke/path/join-paths\";\nimport { titleCase } from \"@stryke/string-format/title-case\";\nimport os from \"node:os\";\nimport path from \"node:path\";\n\n// Forked from https://www.npmjs.com/package/env-paths\n\nconst homedir = os.homedir();\nconst tmpdir = os.tmpdir();\n\n/**\n * Options for the `getEnvPaths` function.\n */\nexport interface GetEnvPathsOptions {\n  /**\n   * The name of the organization\n   *\n   * @defaultValue \"storm-software\"\n   */\n  orgId?: string;\n\n  /**\n   * The name of the specific application to use as a nested folder inside the organization's folder\n   *\n   * For example: `~/ ... /storm-software/Log/<appId>`\n   */\n  appId?: string;\n\n  /**\n   * The name of the specific application to use as a nested folder inside the organization's folder\n   *\n   * When a value is provided, it will use `~/ ... /storm-software/Log/<appId>/<nestedDir>`\n   *\n   * @remarks\n   * If no child is provided, it will use `~/ ... /storm-software/Log/<appId>`\n   */\n  nestedDir?: string;\n\n  /**\n   * The suffix to append to the project name.\n   *\n   * @remarks\n   * If `suffix` is `true`, the project name will be suffixed with `\"nodejs\"`.\n   *\n   * @defaultValue false\n   */\n  suffix?: string | boolean | null;\n\n  /**\n   * The root directory of the workspace that is used for determining the `cache` and `tmp` paths if they were not already set by other means.\n   */\n  workspaceRoot?: string;\n}\n\nexport interface EnvPaths {\n  data: string;\n  config: string;\n  cache: string;\n  log: string;\n  temp: string;\n}\n\nconst macos = (orgId: string): EnvPaths => {\n  const library = joinPaths(homedir, \"Library\");\n\n  return {\n    data: joinPaths(library, \"Application Support\", orgId),\n    config: joinPaths(library, \"Preferences\", orgId),\n    cache: joinPaths(library, \"Caches\", orgId),\n    log: joinPaths(library, \"Logs\", orgId),\n    temp: joinPaths(tmpdir, orgId)\n  };\n};\n\nconst windows = (orgId: string): EnvPaths => {\n  const appData =\n    process.env.APPDATA || joinPaths(homedir, \"AppData\", \"Roaming\");\n  const localAppData =\n    process.env.LOCALAPPDATA || joinPaths(homedir, \"AppData\", \"Local\");\n\n  const windowsFormattedOrgId = titleCase(orgId).trim().replace(/\\s+/g, \"\");\n\n  return {\n    // Data/config/cache/log are invented by me as Windows isn't opinionated about this\n    data: joinPaths(localAppData, windowsFormattedOrgId, \"Data\"),\n    config: joinPaths(appData, windowsFormattedOrgId, \"Config\"),\n    cache: joinPaths(localAppData, \"Cache\", orgId),\n    log: joinPaths(localAppData, windowsFormattedOrgId, \"Log\"),\n    temp: joinPaths(tmpdir, orgId)\n  };\n};\n\n// https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html\nconst linux = (orgId: string): EnvPaths => {\n  const username = path.basename(homedir);\n\n  return {\n    data: joinPaths(\n      process.env.XDG_DATA_HOME || joinPaths(homedir, \".local\", \"share\"),\n      orgId\n    ),\n    config: joinPaths(\n      process.env.XDG_CONFIG_HOME || joinPaths(homedir, \".config\"),\n      orgId\n    ),\n    cache: joinPaths(\n      process.env.XDG_CACHE_HOME || joinPaths(homedir, \".cache\"),\n      orgId\n    ),\n    // https://wiki.debian.org/XDGBaseDirectorySpecification#state\n    log: joinPaths(\n      process.env.XDG_STATE_HOME || joinPaths(homedir, \".local\", \"state\"),\n      orgId\n    ),\n    // https://devenv.sh/files-and-variables/#devenv_root\n    temp:\n      process.env.DEVENV_RUNTIME || process.env.XDG_RUNTIME_DIR\n        ? joinPaths(\n            (process.env.DEVENV_RUNTIME || process.env.XDG_RUNTIME_DIR)!,\n            orgId\n          )\n        : joinPaths(tmpdir, username, orgId)\n  };\n};\n\n/**\n * Get paths for storing things like data, config, logs, and cache in the current runtime environment.\n *\n * @remarks\n * On macOS, directories are generally created in `~/Library/Application Support/<name>`.\n * On Windows, directories are generally created in `%AppData%/<name>`.\n * On Linux, directories are generally created in `~/.config/<name>` - this is determined via the [XDG Base Directory spec](https://specifications.freedesktop.org/basedir-spec/latest/).\n *\n * If the `STORM_DATA_DIR`, `STORM_CONFIG_DIR`, `STORM_CACHE_DIR`, `STORM_LOG_DIR`, or `STORM_TEMP_DIR` environment variables are set, they will be used instead of the default paths.\n *\n * @param options - Parameters used to determine the specific paths for the current project/runtime environment\n * @returns An object containing the various paths for the runtime environment\n */\nexport function getEnvPaths(options: GetEnvPathsOptions = {}): EnvPaths {\n  let orgId = options.orgId || \"storm-software\";\n  if (!orgId) {\n    throw new Error(\n      \"You need to provide an orgId to the `getEnvPaths` function\"\n    );\n  }\n\n  if (options.suffix) {\n    // Add suffix to prevent possible conflict with native apps\n    orgId += `-${typeof options.suffix === \"string\" ? options.suffix : \"nodejs\"}`;\n  }\n\n  let result = {} as EnvPaths;\n\n  if (process.platform === \"darwin\") {\n    result = macos(orgId);\n  } else if (process.platform === \"win32\") {\n    result = windows(orgId);\n  } else {\n    result = linux(orgId);\n  }\n\n  if (process.env.STORM_DATA_DIR) {\n    result.data = process.env.STORM_DATA_DIR;\n  } else if (process.env.STORM_CONFIG_DIR) {\n    result.config = process.env.STORM_CONFIG_DIR;\n  } else if (process.env.STORM_CACHE_DIR) {\n    result.cache = process.env.STORM_CACHE_DIR;\n  } else if (process.env.STORM_LOG_DIR) {\n    result.log = process.env.STORM_LOG_DIR;\n  } else if (process.env.STORM_TEMP_DIR) {\n    result.temp = process.env.STORM_TEMP_DIR;\n  }\n\n  if (options.workspaceRoot) {\n    result.cache ??= joinPaths(\n      options.workspaceRoot,\n      \"node_modules\",\n      \".cache\",\n      orgId\n    );\n    result.temp ??= joinPaths(options.workspaceRoot, \"tmp\", orgId);\n    result.log ??= joinPaths(result.temp, \"logs\");\n    result.config ??= joinPaths(options.workspaceRoot, \".config\", orgId);\n  }\n\n  return Object.keys(result).reduce((ret, key) => {\n    if (result[key as keyof EnvPaths]) {\n      const filePath = result[key as keyof EnvPaths];\n\n      ret[key as keyof EnvPaths] =\n        options.appId &&\n        options.appId !== options.orgId &&\n        options.appId !== options.nestedDir\n          ? joinPaths(filePath, options.appId)\n          : filePath;\n\n      if (\n        options.nestedDir &&\n        options.nestedDir !== options.orgId &&\n        options.nestedDir !== options.appId\n      ) {\n        ret[key as keyof EnvPaths] = joinPaths(\n          ret[key as keyof EnvPaths],\n          options.nestedDir\n        );\n      }\n    }\n\n    return ret;\n  }, {} as EnvPaths);\n}\n"],"mappings":";;;;;;AAyBA,MAAM,UAAU,GAAG,SAAS;AAC5B,MAAM,SAAS,GAAG,QAAQ;AAsD1B,MAAM,SAAS,UAA4B;CACzC,MAAM,UAAU,UAAU,SAAS,UAAU;AAE7C,QAAO;EACL,MAAM,UAAU,SAAS,uBAAuB,MAAM;EACtD,QAAQ,UAAU,SAAS,eAAe,MAAM;EAChD,OAAO,UAAU,SAAS,UAAU,MAAM;EAC1C,KAAK,UAAU,SAAS,QAAQ,MAAM;EACtC,MAAM,UAAU,QAAQ,MAAM;EAC/B;;AAGH,MAAM,WAAW,UAA4B;CAC3C,MAAM,UACJ,QAAQ,IAAI,WAAW,UAAU,SAAS,WAAW,UAAU;CACjE,MAAM,eACJ,QAAQ,IAAI,gBAAgB,UAAU,SAAS,WAAW,QAAQ;CAEpE,MAAM,wBAAwB,UAAU,MAAM,CAAC,MAAM,CAAC,QAAQ,QAAQ,GAAG;AAEzE,QAAO;EAEL,MAAM,UAAU,cAAc,uBAAuB,OAAO;EAC5D,QAAQ,UAAU,SAAS,uBAAuB,SAAS;EAC3D,OAAO,UAAU,cAAc,SAAS,MAAM;EAC9C,KAAK,UAAU,cAAc,uBAAuB,MAAM;EAC1D,MAAM,UAAU,QAAQ,MAAM;EAC/B;;AAIH,MAAM,SAAS,UAA4B;CACzC,MAAM,WAAW,KAAK,SAAS,QAAQ;AAEvC,QAAO;EACL,MAAM,UACJ,QAAQ,IAAI,iBAAiB,UAAU,SAAS,UAAU,QAAQ,EAClE,MACD;EACD,QAAQ,UACN,QAAQ,IAAI,mBAAmB,UAAU,SAAS,UAAU,EAC5D,MACD;EACD,OAAO,UACL,QAAQ,IAAI,kBAAkB,UAAU,SAAS,SAAS,EAC1D,MACD;EAED,KAAK,UACH,QAAQ,IAAI,kBAAkB,UAAU,SAAS,UAAU,QAAQ,EACnE,MACD;EAED,MACE,QAAQ,IAAI,kBAAkB,QAAQ,IAAI,kBACtC,UACG,QAAQ,IAAI,kBAAkB,QAAQ,IAAI,iBAC3C,MACD,GACD,UAAU,QAAQ,UAAU,MAAM;EACzC;;;;;;;;;;;;;;;AAgBH,SAAgB,YAAY,UAA8B,EAAE,EAAY;CACtE,IAAI,QAAQ,QAAQ,SAAS;AAC7B,KAAI,CAAC,MACH,OAAM,IAAI,MACR,6DACD;AAGH,KAAI,QAAQ,OAEV,UAAS,IAAI,OAAO,QAAQ,WAAW,WAAW,QAAQ,SAAS;CAGrE,IAAI,SAAS,EAAE;AAEf,KAAI,QAAQ,aAAa,SACvB,UAAS,MAAM,MAAM;UACZ,QAAQ,aAAa,QAC9B,UAAS,QAAQ,MAAM;KAEvB,UAAS,MAAM,MAAM;AAGvB,KAAI,QAAQ,IAAI,eACd,QAAO,OAAO,QAAQ,IAAI;UACjB,QAAQ,IAAI,iBACrB,QAAO,SAAS,QAAQ,IAAI;UACnB,QAAQ,IAAI,gBACrB,QAAO,QAAQ,QAAQ,IAAI;UAClB,QAAQ,IAAI,cACrB,QAAO,MAAM,QAAQ,IAAI;UAChB,QAAQ,IAAI,eACrB,QAAO,OAAO,QAAQ,IAAI;AAG5B,KAAI,QAAQ,eAAe;AACzB,SAAO,UAAU,UACf,QAAQ,eACR,gBACA,UACA,MACD;AACD,SAAO,SAAS,UAAU,QAAQ,eAAe,OAAO,MAAM;AAC9D,SAAO,QAAQ,UAAU,OAAO,MAAM,OAAO;AAC7C,SAAO,WAAW,UAAU,QAAQ,eAAe,WAAW,MAAM;;AAGtE,QAAO,OAAO,KAAK,OAAO,CAAC,QAAQ,KAAK,QAAQ;AAC9C,MAAI,OAAO,MAAwB;GACjC,MAAM,WAAW,OAAO;AAExB,OAAI,OACF,QAAQ,SACR,QAAQ,UAAU,QAAQ,SAC1B,QAAQ,UAAU,QAAQ,YACtB,UAAU,UAAU,QAAQ,MAAM,GAClC;AAEN,OACE,QAAQ,aACR,QAAQ,cAAc,QAAQ,SAC9B,QAAQ,cAAc,QAAQ,MAE9B,KAAI,OAAyB,UAC3B,IAAI,MACJ,QAAQ,UACT;;AAIL,SAAO;IACN,EAAE,CAAa"}

package/dist/index.cjs

@@ -1 +1,48 @@
-const e=require(`./ci-checks.cjs`),t=require(`./environment-checks.cjs`),n=require(`./get-env-paths.cjs`),r=require(`./types.cjs`),i=require(`./load-env.cjs`),a=require(`./providers.cjs`),o=require(`./runtime-checks.cjs`);exports.ENV_PREFIXES=r.ENV_PREFIXES,exports.getEnvFilesForMode=i.getEnvFilesForMode,exports.getEnvPaths=n.getEnvPaths,exports.hasTTY=t.hasTTY,exports.isBun=o.isBun,exports.isCI=e.isCI,exports.isColorSupported=t.isColorSupported,exports.isDebug=t.isDebug,exports.isDeno=o.isDeno,exports.isDevelopment=t.isDevelopment,exports.isDevelopmentMode=t.isDevelopmentMode,exports.isEdgeLight=o.isEdgeLight,exports.isFastly=o.isFastly,exports.isHyperlinkSupported=t.isHyperlinkSupported,exports.isInteractive=e.isInteractive,exports.isLinux=t.isLinux,exports.isMacOS=t.isMacOS,exports.isMinimal=t.isMinimal,exports.isNetlify=o.isNetlify,exports.isNode=o.isNode,exports.isProduction=t.isProduction,exports.isProductionMode=t.isProductionMode,exports.isRuntimeClient=o.isRuntimeClient,exports.isRuntimeServer=o.isRuntimeServer,exports.isStaging=t.isStaging,exports.isTest=t.isTest,exports.isTestMode=t.isTestMode,exports.isWindows=t.isWindows,exports.isWorkerd=o.isWorkerd,exports.loadClientEnv=i.loadClientEnv,exports.loadEnv=i.loadEnv,exports.loadEnvFile=i.loadEnvFile,exports.loadServerEnv=i.loadServerEnv,exports.nodeMajorVersion=t.nodeMajorVersion,exports.nodeVersion=t.nodeVersion,exports.platform=t.platform,exports.provider=a.provider,exports.providerInfo=a.providerInfo,exports.runtime=o.runtime,exports.runtimeInfo=o.runtimeInfo;
+const require_ci_checks = require('./ci-checks.cjs');
+const require_environment_checks = require('./environment-checks.cjs');
+const require_get_env_paths = require('./get-env-paths.cjs');
+const require_types = require('./types.cjs');
+const require_load_env = require('./load-env.cjs');
+const require_providers = require('./providers.cjs');
+const require_runtime_checks = require('./runtime-checks.cjs');
+
+exports.ENV_PREFIXES = require_types.ENV_PREFIXES;
+exports.getEnvFilesForMode = require_load_env.getEnvFilesForMode;
+exports.getEnvPaths = require_get_env_paths.getEnvPaths;
+exports.hasTTY = require_environment_checks.hasTTY;
+exports.isBun = require_runtime_checks.isBun;
+exports.isCI = require_ci_checks.isCI;
+exports.isColorSupported = require_environment_checks.isColorSupported;
+exports.isDebug = require_environment_checks.isDebug;
+exports.isDeno = require_runtime_checks.isDeno;
+exports.isDevelopment = require_environment_checks.isDevelopment;
+exports.isDevelopmentMode = require_environment_checks.isDevelopmentMode;
+exports.isEdgeLight = require_runtime_checks.isEdgeLight;
+exports.isFastly = require_runtime_checks.isFastly;
+exports.isHyperlinkSupported = require_environment_checks.isHyperlinkSupported;
+exports.isInteractive = require_ci_checks.isInteractive;
+exports.isLinux = require_environment_checks.isLinux;
+exports.isMacOS = require_environment_checks.isMacOS;
+exports.isMinimal = require_environment_checks.isMinimal;
+exports.isNetlify = require_runtime_checks.isNetlify;
+exports.isNode = require_runtime_checks.isNode;
+exports.isProduction = require_environment_checks.isProduction;
+exports.isProductionMode = require_environment_checks.isProductionMode;
+exports.isRuntimeClient = require_runtime_checks.isRuntimeClient;
+exports.isRuntimeServer = require_runtime_checks.isRuntimeServer;
+exports.isStaging = require_environment_checks.isStaging;
+exports.isTest = require_environment_checks.isTest;
+exports.isTestMode = require_environment_checks.isTestMode;
+exports.isWindows = require_environment_checks.isWindows;
+exports.isWorkerd = require_runtime_checks.isWorkerd;
+exports.loadClientEnv = require_load_env.loadClientEnv;
+exports.loadEnv = require_load_env.loadEnv;
+exports.loadEnvFile = require_load_env.loadEnvFile;
+exports.loadServerEnv = require_load_env.loadServerEnv;
+exports.nodeMajorVersion = require_environment_checks.nodeMajorVersion;
+exports.nodeVersion = require_environment_checks.nodeVersion;
+exports.platform = require_environment_checks.platform;
+exports.provider = require_providers.provider;
+exports.providerInfo = require_providers.providerInfo;
+exports.runtime = require_runtime_checks.runtime;
+exports.runtimeInfo = require_runtime_checks.runtimeInfo;

package/dist/index.mjs

@@ -1 +1,9 @@
-import{isCI as e,isInteractive as t}from"./ci-checks.mjs";import{hasTTY as n,isColorSupported as r,isDebug as i,isDevelopment as a,isDevelopmentMode as o,isHyperlinkSupported as s,isLinux as c,isMacOS as l,isMinimal as u,isProduction as d,isProductionMode as f,isStaging as p,isTest as m,isTestMode as h,isWindows as g,nodeMajorVersion as _,nodeVersion as v,platform as y}from"./environment-checks.mjs";import{getEnvPaths as b}from"./get-env-paths.mjs";import{ENV_PREFIXES as x}from"./types.mjs";import{getEnvFilesForMode as S,loadClientEnv as C,loadEnv as w,loadEnvFile as T,loadServerEnv as E}from"./load-env.mjs";import{provider as D,providerInfo as O}from"./providers.mjs";import{isBun as k,isDeno as A,isEdgeLight as j,isFastly as M,isNetlify as N,isNode as P,isRuntimeClient as F,isRuntimeServer as I,isWorkerd as L,runtime as R,runtimeInfo as z}from"./runtime-checks.mjs";export{x as ENV_PREFIXES,S as getEnvFilesForMode,b as getEnvPaths,n as hasTTY,k as isBun,e as isCI,r as isColorSupported,i as isDebug,A as isDeno,a as isDevelopment,o as isDevelopmentMode,j as isEdgeLight,M as isFastly,s as isHyperlinkSupported,t as isInteractive,c as isLinux,l as isMacOS,u as isMinimal,N as isNetlify,P as isNode,d as isProduction,f as isProductionMode,F as isRuntimeClient,I as isRuntimeServer,p as isStaging,m as isTest,h as isTestMode,g as isWindows,L as isWorkerd,C as loadClientEnv,w as loadEnv,T as loadEnvFile,E as loadServerEnv,_ as nodeMajorVersion,v as nodeVersion,y as platform,D as provider,O as providerInfo,R as runtime,z as runtimeInfo};
+import { isCI, isInteractive } from "./ci-checks.mjs";
+import { hasTTY, isColorSupported, isDebug, isDevelopment, isDevelopmentMode, isHyperlinkSupported, isLinux, isMacOS, isMinimal, isProduction, isProductionMode, isStaging, isTest, isTestMode, isWindows, nodeMajorVersion, nodeVersion, platform } from "./environment-checks.mjs";
+import { getEnvPaths } from "./get-env-paths.mjs";
+import { ENV_PREFIXES } from "./types.mjs";
+import { getEnvFilesForMode, loadClientEnv, loadEnv, loadEnvFile, loadServerEnv } from "./load-env.mjs";
+import { provider, providerInfo } from "./providers.mjs";
+import { isBun, isDeno, isEdgeLight, isFastly, isNetlify, isNode, isRuntimeClient, isRuntimeServer, isWorkerd, runtime, runtimeInfo } from "./runtime-checks.mjs";
+
+export { ENV_PREFIXES, getEnvFilesForMode, getEnvPaths, hasTTY, isBun, isCI, isColorSupported, isDebug, isDeno, isDevelopment, isDevelopmentMode, isEdgeLight, isFastly, isHyperlinkSupported, isInteractive, isLinux, isMacOS, isMinimal, isNetlify, isNode, isProduction, isProductionMode, isRuntimeClient, isRuntimeServer, isStaging, isTest, isTestMode, isWindows, isWorkerd, loadClientEnv, loadEnv, loadEnvFile, loadServerEnv, nodeMajorVersion, nodeVersion, platform, provider, providerInfo, runtime, runtimeInfo };

package/dist/load-env.cjs

@@ -1 +1,124 @@
-const e=require(`./_virtual/rolldown_runtime.cjs`),t=require(`./path/src/join-paths.cjs`),n=require(`./convert/src/to-array.cjs`),r=require(`./fs/src/exists.cjs`),i=require(`./fs/src/read-file.cjs`),a=require(`./types.cjs`);let o=require(`@dotenvx/dotenvx`),s=require(`defu`);s=e.__toESM(s);function c(e,n=`production`){return[`.env`,`.env.local`,`.env.${n}`,`.env.${n}.local`,`.env.local.${n}`].map(n=>t.joinPaths(e,n))}async function l(e,n=[]){let a=Array.isArray(n)?n:[n];return(await Promise.all((n.length>0?a.map(n=>t.joinPaths(n,e)):[e]).map(async e=>{if(r.existsSync(e))return i.readFile(e)}))).reduce((e,t)=>t?(0,s.default)((0,o.parse)(t,{processEnv:{...process.env},privateKey:process.env.DOTENV_PRIVATE_KEY||process.env.STORM_PRIVATE_KEY}),e):e,{})}async function u(e,t,r){if(t===`local`)throw Error(`"local" cannot be used as a mode name because it conflicts with the .local postfix for .env files.`);let i=n.toArray(r).reduce((e,t)=>t?(e.includes(t.endsWith(`_`)?t:`${t}_`)||e.push(t.endsWith(`_`)?t:`${t}_`),e.includes(`${t.endsWith(`_`)?t:`${t}_`}PUBLIC_`)||e.push(`${t.endsWith(`_`)?t:`${t}_`}PUBLIC_`),e):e,[]),a=Array.isArray(e)?e:[e],o={},u=a.reduce((e,n)=>(e.push(...c(n,t).filter(t=>!e.includes(t))),e),[]),d=(await Promise.all(u.map(async e=>l(e)))).reduce((e,t)=>(0,s.default)(t,e),{});if(d.NODE_ENV&&process.env.VITE_USER_NODE_ENV===void 0&&(process.env.VITE_USER_NODE_ENV=JSON.stringify(d.NODE_ENV)),d.BROWSER&&process.env.BROWSER===void 0&&(process.env.BROWSER=JSON.stringify(d.BROWSER)),d.BROWSER_ARGS&&process.env.BROWSER_ARGS===void 0&&(process.env.BROWSER_ARGS=JSON.stringify(d.BROWSER_ARGS)),d=(0,s.default)({...process.env},d),i.length===0)return d;for(let[e,t]of Object.entries(d))i.some(t=>e.startsWith(t))&&(o[e]=String(t));for(let e in process.env)i.some(t=>e.startsWith(t))&&(o[e]=process.env[e]);return o}async function d(e,t,n=a.ENV_PREFIXES){return u(e,t,n)}async function f(e,t){return u(e,t)}exports.getEnvFilesForMode=c,exports.loadClientEnv=d,exports.loadEnv=u,exports.loadEnvFile=l,exports.loadServerEnv=f;
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+const require_join_paths = require('./path/src/join-paths.cjs');
+const require_to_array = require('./convert/src/to-array.cjs');
+const require_exists = require('./fs/src/exists.cjs');
+const require_read_file = require('./fs/src/read-file.cjs');
+const require_types = require('./types.cjs');
+let __dotenvx_dotenvx = require("@dotenvx/dotenvx");
+let defu = require("defu");
+defu = require_rolldown_runtime.__toESM(defu);
+
+//#region src/load-env.ts
+function getEnvFilesForMode(envDir, mode = "production") {
+	return [
+		".env",
+		".env.local",
+		`.env.${mode}`,
+		`.env.${mode}.local`,
+		`.env.local.${mode}`
+	].map((file) => require_join_paths.joinPaths(envDir, file));
+}
+/**
+* Load environment variables from a .env file.
+*
+* @param envFile - The path to the .env file.
+* @returns The environment variables.
+*/
+async function loadEnvFile(envFile, envDir = []) {
+	const envDirs = Array.isArray(envDir) ? envDir : [envDir];
+	return (await Promise.all((envDir.length > 0 ? envDirs.map((envDir$1) => require_join_paths.joinPaths(envDir$1, envFile)) : [envFile]).map(async (envFilePath) => {
+		if (!require_exists.existsSync(envFilePath)) return;
+		return require_read_file.readFile(envFilePath);
+	}))).reduce((ret, envFileContent) => {
+		if (!envFileContent) return ret;
+		return (0, defu.default)((0, __dotenvx_dotenvx.parse)(envFileContent, {
+			processEnv: { ...process.env },
+			privateKey: process.env.DOTENV_PRIVATE_KEY || process.env.STORM_PRIVATE_KEY
+		}), ret);
+	}, {});
+}
+/**
+* Load environment variables from .env files.
+*
+* @remarks
+* This function loads environment variables from .env files based on the mode. For the `production` mode, it will load:
+* - `.env`
+* - `.env.local`
+* - `.env.production`
+* - `.env.production.local`
+*
+* @param envDir - The directory/directories to load the environment variables from.
+* @param mode - The mode to load the environment variables for.
+* @param prefix - The prefix or prefixes to use for the environment variables.
+* @returns The environment variables.
+*/
+async function loadEnv(envDir, mode, prefix) {
+	if (mode === "local") throw new Error("\"local\" cannot be used as a mode name because it conflicts with the .local postfix for .env files.");
+	const prefixes = require_to_array.toArray(prefix).reduce((ret, pre) => {
+		if (!pre) return ret;
+		if (!ret.includes(pre.endsWith("_") ? pre : `${pre}_`)) ret.push(pre.endsWith("_") ? pre : `${pre}_`);
+		if (!ret.includes(`${pre.endsWith("_") ? pre : `${pre}_`}PUBLIC_`)) ret.push(`${pre.endsWith("_") ? pre : `${pre}_`}PUBLIC_`);
+		return ret;
+	}, []);
+	const envDirs = Array.isArray(envDir) ? envDir : [envDir];
+	const env = {};
+	const envFiles = envDirs.reduce((ret, envFilePath) => {
+		ret.push(...getEnvFilesForMode(envFilePath, mode).filter((envFile) => !ret.includes(envFile)));
+		return ret;
+	}, []);
+	let envParsed = (await Promise.all(envFiles.map(async (filePath) => {
+		return loadEnvFile(filePath);
+	}))).reduce((ret, result) => {
+		return (0, defu.default)(result, ret);
+	}, {});
+	if (envParsed.NODE_ENV && process.env.VITE_USER_NODE_ENV === void 0) process.env.VITE_USER_NODE_ENV = JSON.stringify(envParsed.NODE_ENV);
+	if (envParsed.BROWSER && process.env.BROWSER === void 0) process.env.BROWSER = JSON.stringify(envParsed.BROWSER);
+	if (envParsed.BROWSER_ARGS && process.env.BROWSER_ARGS === void 0) process.env.BROWSER_ARGS = JSON.stringify(envParsed.BROWSER_ARGS);
+	envParsed = (0, defu.default)({ ...process.env }, envParsed);
+	if (prefixes.length === 0) return envParsed;
+	for (const [key, value] of Object.entries(envParsed)) if (prefixes.some((prefix$1) => key.startsWith(prefix$1))) env[key] = String(value);
+	for (const key in process.env) if (prefixes.some((prefix$1) => key.startsWith(prefix$1))) env[key] = process.env[key];
+	return env;
+}
+/**
+* Load environment variables from .env files for a client-side environment.
+*
+* @remarks
+* This function loads environment variables from .env files based on the mode. For the `production` mode, it will load:
+* - `.env`
+* - `.env.local`
+* - `.env.production`
+* - `.env.production.local`
+*
+* @param envDir - The directory/directories to load the environment variables from.
+* @param mode - The mode to load the environment variables for.
+* @param prefix - The prefix or prefixes to use for the environment variables.
+* @returns The environment variables.
+*/
+async function loadClientEnv(envDir, mode, prefix = require_types.ENV_PREFIXES) {
+	return loadEnv(envDir, mode, prefix);
+}
+/**
+* Load environment variables from .env files for a server-side environment.
+*
+* @remarks
+* This function loads environment variables from .env files based on the mode. For the `production` mode, it will load:
+* - `.env`
+* - `.env.local`
+* - `.env.production`
+* - `.env.production.local`
+*
+* @param envDir - The directory/directories to load the environment variables from.
+* @param mode - The mode to load the environment variables for.
+* @returns The environment variables.
+*/
+async function loadServerEnv(envDir, mode) {
+	return loadEnv(envDir, mode);
+}
+
+//#endregion
+exports.getEnvFilesForMode = getEnvFilesForMode;
+exports.loadClientEnv = loadClientEnv;
+exports.loadEnv = loadEnv;
+exports.loadEnvFile = loadEnvFile;
+exports.loadServerEnv = loadServerEnv;

package/dist/load-env.mjs

@@ -1,2 +1,119 @@
-import{joinPaths as e}from"./path/src/join-paths.mjs";import{toArray as t}from"./convert/src/to-array.mjs";import{existsSync as n}from"./fs/src/exists.mjs";import{readFile as r}from"./fs/src/read-file.mjs";import{ENV_PREFIXES as i}from"./types.mjs";import{parse as a}from"@dotenvx/dotenvx";import o from"defu";function s(t,n=`production`){return[`.env`,`.env.local`,`.env.${n}`,`.env.${n}.local`,`.env.local.${n}`].map(n=>e(t,n))}async function c(t,i=[]){let s=Array.isArray(i)?i:[i];return(await Promise.all((i.length>0?s.map(n=>e(n,t)):[t]).map(async e=>{if(n(e))return r(e)}))).reduce((e,t)=>t?o(a(t,{processEnv:{...process.env},privateKey:process.env.DOTENV_PRIVATE_KEY||process.env.STORM_PRIVATE_KEY}),e):e,{})}async function l(e,n,r){if(n===`local`)throw Error(`"local" cannot be used as a mode name because it conflicts with the .local postfix for .env files.`);let i=t(r).reduce((e,t)=>t?(e.includes(t.endsWith(`_`)?t:`${t}_`)||e.push(t.endsWith(`_`)?t:`${t}_`),e.includes(`${t.endsWith(`_`)?t:`${t}_`}PUBLIC_`)||e.push(`${t.endsWith(`_`)?t:`${t}_`}PUBLIC_`),e):e,[]),a=Array.isArray(e)?e:[e],l={},u=a.reduce((e,t)=>(e.push(...s(t,n).filter(t=>!e.includes(t))),e),[]),d=(await Promise.all(u.map(async e=>c(e)))).reduce((e,t)=>o(t,e),{});if(d.NODE_ENV&&process.env.VITE_USER_NODE_ENV===void 0&&(process.env.VITE_USER_NODE_ENV=JSON.stringify(d.NODE_ENV)),d.BROWSER&&process.env.BROWSER===void 0&&(process.env.BROWSER=JSON.stringify(d.BROWSER)),d.BROWSER_ARGS&&process.env.BROWSER_ARGS===void 0&&(process.env.BROWSER_ARGS=JSON.stringify(d.BROWSER_ARGS)),d=o({...process.env},d),i.length===0)return d;for(let[e,t]of Object.entries(d))i.some(t=>e.startsWith(t))&&(l[e]=String(t));for(let e in process.env)i.some(t=>e.startsWith(t))&&(l[e]=process.env[e]);return l}async function u(e,t,n=i){return l(e,t,n)}async function d(e,t){return l(e,t)}export{s as getEnvFilesForMode,u as loadClientEnv,l as loadEnv,c as loadEnvFile,d as loadServerEnv};
+import { joinPaths } from "./path/src/join-paths.mjs";
+import { toArray } from "./convert/src/to-array.mjs";
+import { existsSync } from "./fs/src/exists.mjs";
+import { readFile } from "./fs/src/read-file.mjs";
+import { ENV_PREFIXES } from "./types.mjs";
+import { parse } from "@dotenvx/dotenvx";
+import defu from "defu";
+
+//#region src/load-env.ts
+function getEnvFilesForMode(envDir, mode = "production") {
+	return [
+		".env",
+		".env.local",
+		`.env.${mode}`,
+		`.env.${mode}.local`,
+		`.env.local.${mode}`
+	].map((file) => joinPaths(envDir, file));
+}
+/**
+* Load environment variables from a .env file.
+*
+* @param envFile - The path to the .env file.
+* @returns The environment variables.
+*/
+async function loadEnvFile(envFile, envDir = []) {
+	const envDirs = Array.isArray(envDir) ? envDir : [envDir];
+	return (await Promise.all((envDir.length > 0 ? envDirs.map((envDir$1) => joinPaths(envDir$1, envFile)) : [envFile]).map(async (envFilePath) => {
+		if (!existsSync(envFilePath)) return;
+		return readFile(envFilePath);
+	}))).reduce((ret, envFileContent) => {
+		if (!envFileContent) return ret;
+		return defu(parse(envFileContent, {
+			processEnv: { ...process.env },
+			privateKey: process.env.DOTENV_PRIVATE_KEY || process.env.STORM_PRIVATE_KEY
+		}), ret);
+	}, {});
+}
+/**
+* Load environment variables from .env files.
+*
+* @remarks
+* This function loads environment variables from .env files based on the mode. For the `production` mode, it will load:
+* - `.env`
+* - `.env.local`
+* - `.env.production`
+* - `.env.production.local`
+*
+* @param envDir - The directory/directories to load the environment variables from.
+* @param mode - The mode to load the environment variables for.
+* @param prefix - The prefix or prefixes to use for the environment variables.
+* @returns The environment variables.
+*/
+async function loadEnv(envDir, mode, prefix) {
+	if (mode === "local") throw new Error("\"local\" cannot be used as a mode name because it conflicts with the .local postfix for .env files.");
+	const prefixes = toArray(prefix).reduce((ret, pre) => {
+		if (!pre) return ret;
+		if (!ret.includes(pre.endsWith("_") ? pre : `${pre}_`)) ret.push(pre.endsWith("_") ? pre : `${pre}_`);
+		if (!ret.includes(`${pre.endsWith("_") ? pre : `${pre}_`}PUBLIC_`)) ret.push(`${pre.endsWith("_") ? pre : `${pre}_`}PUBLIC_`);
+		return ret;
+	}, []);
+	const envDirs = Array.isArray(envDir) ? envDir : [envDir];
+	const env = {};
+	const envFiles = envDirs.reduce((ret, envFilePath) => {
+		ret.push(...getEnvFilesForMode(envFilePath, mode).filter((envFile) => !ret.includes(envFile)));
+		return ret;
+	}, []);
+	let envParsed = (await Promise.all(envFiles.map(async (filePath) => {
+		return loadEnvFile(filePath);
+	}))).reduce((ret, result) => {
+		return defu(result, ret);
+	}, {});
+	if (envParsed.NODE_ENV && process.env.VITE_USER_NODE_ENV === void 0) process.env.VITE_USER_NODE_ENV = JSON.stringify(envParsed.NODE_ENV);
+	if (envParsed.BROWSER && process.env.BROWSER === void 0) process.env.BROWSER = JSON.stringify(envParsed.BROWSER);
+	if (envParsed.BROWSER_ARGS && process.env.BROWSER_ARGS === void 0) process.env.BROWSER_ARGS = JSON.stringify(envParsed.BROWSER_ARGS);
+	envParsed = defu({ ...process.env }, envParsed);
+	if (prefixes.length === 0) return envParsed;
+	for (const [key, value] of Object.entries(envParsed)) if (prefixes.some((prefix$1) => key.startsWith(prefix$1))) env[key] = String(value);
+	for (const key in process.env) if (prefixes.some((prefix$1) => key.startsWith(prefix$1))) env[key] = process.env[key];
+	return env;
+}
+/**
+* Load environment variables from .env files for a client-side environment.
+*
+* @remarks
+* This function loads environment variables from .env files based on the mode. For the `production` mode, it will load:
+* - `.env`
+* - `.env.local`
+* - `.env.production`
+* - `.env.production.local`
+*
+* @param envDir - The directory/directories to load the environment variables from.
+* @param mode - The mode to load the environment variables for.
+* @param prefix - The prefix or prefixes to use for the environment variables.
+* @returns The environment variables.
+*/
+async function loadClientEnv(envDir, mode, prefix = ENV_PREFIXES) {
+	return loadEnv(envDir, mode, prefix);
+}
+/**
+* Load environment variables from .env files for a server-side environment.
+*
+* @remarks
+* This function loads environment variables from .env files based on the mode. For the `production` mode, it will load:
+* - `.env`
+* - `.env.local`
+* - `.env.production`
+* - `.env.production.local`
+*
+* @param envDir - The directory/directories to load the environment variables from.
+* @param mode - The mode to load the environment variables for.
+* @returns The environment variables.
+*/
+async function loadServerEnv(envDir, mode) {
+	return loadEnv(envDir, mode);
+}
+
+//#endregion
+export { getEnvFilesForMode, loadClientEnv, loadEnv, loadEnvFile, loadServerEnv };
 //# sourceMappingURL=load-env.mjs.map