@willbooster/shared-lib-node 6.0.4 → 6.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/env.cjs.map +1 -1
- package/dist/env.js.map +1 -1
- package/dist/spawn.cjs.map +1 -1
- package/dist/spawn.d.ts +32 -1
- package/dist/spawn.js.map +1 -1
- package/package.json +10 -10
package/dist/env.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"env.cjs","sources":["../src/env.ts"],"sourcesContent":["import fs from 'node:fs';\nimport path from 'node:path';\n\nimport { config } from 'dotenv';\nimport type { ArgumentsCamelCase, InferredOptionTypes } from 'yargs';\n\nexport const yargsOptionsBuilderForEnv = {\n env: {\n description: '.env files to be loaded.',\n type: 'array',\n },\n 'cascade-env': {\n description:\n 'Environment to load cascading .env files (e.g., `.env`, `.env.<environment>`, `.env.local` and `.env.<environment>.local`). Preferred over `cascade-node-env` and `auto-cascade-env`.',\n type: 'string',\n },\n 'cascade-node-env': {\n description: 'Same with --cascade-env=<NODE_ENV || \"development\">. Preferred over `auto-cascade-env`.',\n type: 'boolean',\n },\n 'auto-cascade-env': {\n description: 'Same with --cascade-env=<WB_ENV || NODE_ENV || \"development\">.',\n type: 'boolean',\n default: true,\n },\n 'include-root-env': {\n description: 'Include .env files in root directory if the project is in a monorepo and --env option is not used.',\n type: 'boolean',\n default: true,\n },\n 'check-env': {\n description: 'Check whether the keys of the loaded .env files are same with the given .env file.',\n type: 'string',\n default: '.env.example',\n },\n verbose: {\n description: 'Whether to show verbose information',\n type: 'boolean',\n alias: 'v',\n },\n} as const;\n\nexport type EnvReaderOptions = Partial<ArgumentsCamelCase<InferredOptionTypes<typeof yargsOptionsBuilderForEnv>>>;\n\n/**\n * This function reads environment variables from `.env` files.\n * Note it does not assign them in `process.env`.\n * @return [envVars, [envPaths, envVarCount][]]\n * */\nexport function readEnvironmentVariables(\n argv: EnvReaderOptions,\n cwd: string\n): [Record<string, string>, [string, number][]] {\n let envPaths = (argv.env ?? []).map((envPath) => path.resolve(cwd, envPath.toString()));\n const cascade =\n argv.cascadeEnv ??\n (argv.cascadeNodeEnv\n ? process.env.NODE_ENV || 'development'\n : argv.autoCascadeEnv\n ? process.env.WB_ENV || process.env.NODE_ENV || 'development'\n : undefined);\n if (typeof cascade === 'string') {\n if (envPaths.length === 0) {\n envPaths.push(path.join(cwd, '.env'));\n if (argv.includeRootEnv) {\n const rootPath = path.resolve(cwd, '..', '..');\n if (fs.existsSync(path.join(rootPath, 'package.json'))) {\n envPaths.push(path.join(rootPath, '.env'));\n }\n }\n }\n envPaths = envPaths.flatMap((envPath) =>\n cascade\n ? [`${envPath}.${cascade}.local`, `${envPath}.local`, `${envPath}.${cascade}`, envPath]\n : [`${envPath}.local`, envPath]\n );\n }\n envPaths = envPaths.filter((envPath) => fs.existsSync(envPath)).map((envPath) => path.relative(cwd, envPath));\n if (argv.verbose) {\n console.info(`WB_ENV: ${process.env.WB_ENV}, NODE_ENV: ${process.env.NODE_ENV}`);\n console.info('Reading env files:', envPaths.join(', '));\n }\n\n const envPathAndEnvVarCountPairs: [string, number][] = [];\n const envVars: Record<string, string> = {};\n for (const envPath of envPaths) {\n let count = 0;\n for (const [key, value] of Object.entries(readEnvFile(path.join(cwd, envPath)))) {\n if (!(key in envVars)) {\n envVars[key] = value;\n count++;\n }\n }\n envPathAndEnvVarCountPairs.push([envPath, count]);\n if (argv.verbose && count > 0) {\n console.info(`Read ${count} environment variables from ${envPath}`);\n }\n }\n\n if (argv.checkEnv) {\n const exampleKeys = Object.keys(readEnvFile(path.join(cwd, argv.checkEnv)) || {});\n const missingKeys = exampleKeys.filter((key) => !(key in envVars));\n if (missingKeys.length > 0) {\n throw new Error(`Missing environment variables in [${envPaths.join(', ')}]: [${missingKeys.join(', ')}]`);\n }\n }\n return [envVars, envPathAndEnvVarCountPairs];\n}\n\n/**\n * This function read environment variables from `.env` files and assign them in `process.env`.\n * */\nexport function readAndApplyEnvironmentVariables(\n argv: EnvReaderOptions,\n cwd: string\n): Record<string, string | undefined> {\n const [envVars] = readEnvironmentVariables(argv, cwd);\n Object.assign(process.env, envVars);\n return envVars;\n}\n\nconst cachedEnvVars = new Map<string, Record<string, string>>();\n\nfunction readEnvFile(filePath: string): Record<string, string> {\n const cached = cachedEnvVars.get(filePath);\n if (cached) return cached;\n\n const parsed = config({ path: path.resolve(filePath), processEnv: {} }).parsed ?? {};\n cachedEnvVars.set(filePath, parsed);\n return parsed;\n}\n\n/**\n * This function removes environment variables related to npm and yarn from the given environment variables.\n * */\nexport function removeNpmAndYarnEnvironmentVariables(envVars: Record<string, string | undefined>): void {\n // Remove npm & yarn environment variables from process.env\n if (envVars.PATH && envVars.BERRY_BIN_FOLDER) {\n envVars.PATH = envVars.PATH.replace(`${envVars.BERRY_BIN_FOLDER}:`, '')\n // Temporary directory in macOS\n .replaceAll(/\\/private\\/var\\/folders\\/[^:]+:/g, '')\n // Temporary directories in Linux\n .replaceAll(/\\/var\\/tmp\\/[^:]+:/g, '')\n .replaceAll(/\\/tmp\\/[^:]+:/g, '');\n }\n for (const key of Object.keys(envVars)) {\n const upperKey = key.toUpperCase();\n if (\n upperKey.startsWith('NPM_') ||\n upperKey.startsWith('YARN_') ||\n upperKey.startsWith('BERRY_') ||\n upperKey === 'PROJECT_CWD' ||\n upperKey === 'INIT_CWD'\n ) {\n delete envVars[key];\n }\n }\n}\n"],"names":["readEnvironmentVariables","argv","cwd","envPaths","env","map","envPath","path","resolve","toString","cascade","cascadeEnv","cascadeNodeEnv","process","NODE_ENV","autoCascadeEnv","WB_ENV","undefined","length","push","join","includeRootEnv","rootPath","fs","existsSync","flatMap","filter","relative","verbose","console","info","envPathAndEnvVarCountPairs","envVars","count","key","value","Object","entries","readEnvFile","checkEnv","missingKeys","keys","Error","cachedEnvVars","Map","filePath","cached","get","parsed","config","processEnv","set","assign","PATH","BERRY_BIN_FOLDER","replace","replaceAll","upperKey","toUpperCase","startsWith","description","type","default","alias"],"mappings":"iFAiDO,SAASA,EACdC,EACAC,GAEA,IAAIC,GAAYF,EAAKG,KAAO,IAAIC,KAAKC,GAAYC,EAAKC,QAAQN,EAAKI,EAAQG,cAC3E,MAAMC,EACJT,EAAKU,aACJV,EAAKW,eACFC,QAAQT,IAAIU,UAAY,cACxBb,EAAKc,eACHF,QAAQT,IAAIY,QAAUH,QAAQT,IAAIU,UAAY,mBAC9CG,GACR,GAAuB,iBAAZP,EAAsB,CAC/B,GAAwB,IAApBP,EAASe,SACXf,EAASgB,KAAKZ,EAAKa,KAAKlB,EAAK,SACzBD,EAAKoB,gBAAgB,CACvB,MAAMC,EAAWf,EAAKC,QAAQN,EAAK,KAAM,MACrCqB,EAAGC,WAAWjB,EAAKa,KAAKE,EAAU,kBACpCnB,EAASgB,KAAKZ,EAAKa,KAAKE,EAAU,QAEtC,CAEFnB,EAAWA,EAASsB,SAASnB,GAC3BI,EACI,CAAC,GAAGJ,KAAWI,UAAiB,GAAGJ,UAAiB,GAAGA,KAAWI,IAAWJ,GAC7E,CAAC,GAAGA,UAAiBA,IAE7B,CACAH,EAAWA,EAASuB,QAAQpB,GAAYiB,EAAGC,WAAWlB,KAAUD,KAAKC,GAAYC,EAAKoB,SAASzB,EAAKI,KAChGL,EAAK2B,UACPC,QAAQC,KAAK,WAAWjB,QAAQT,IAAIY,qBAAqBH,QAAQT,IAAIU,YACrEe,QAAQC,KAAK,qBAAsB3B,EAASiB,KAAK,QAGnD,MAAMW,EAAiD,GACjDC,EAAkC,
|
|
1
|
+
{"version":3,"file":"env.cjs","sources":["../src/env.ts"],"sourcesContent":["import fs from 'node:fs';\nimport path from 'node:path';\n\nimport { config } from 'dotenv';\nimport type { ArgumentsCamelCase, InferredOptionTypes } from 'yargs';\n\nexport const yargsOptionsBuilderForEnv = {\n env: {\n description: '.env files to be loaded.',\n type: 'array',\n },\n 'cascade-env': {\n description:\n 'Environment to load cascading .env files (e.g., `.env`, `.env.<environment>`, `.env.local` and `.env.<environment>.local`). Preferred over `cascade-node-env` and `auto-cascade-env`.',\n type: 'string',\n },\n 'cascade-node-env': {\n description: 'Same with --cascade-env=<NODE_ENV || \"development\">. Preferred over `auto-cascade-env`.',\n type: 'boolean',\n },\n 'auto-cascade-env': {\n description: 'Same with --cascade-env=<WB_ENV || NODE_ENV || \"development\">.',\n type: 'boolean',\n default: true,\n },\n 'include-root-env': {\n description: 'Include .env files in root directory if the project is in a monorepo and --env option is not used.',\n type: 'boolean',\n default: true,\n },\n 'check-env': {\n description: 'Check whether the keys of the loaded .env files are same with the given .env file.',\n type: 'string',\n default: '.env.example',\n },\n verbose: {\n description: 'Whether to show verbose information',\n type: 'boolean',\n alias: 'v',\n },\n} as const;\n\nexport type EnvReaderOptions = Partial<ArgumentsCamelCase<InferredOptionTypes<typeof yargsOptionsBuilderForEnv>>>;\n\n/**\n * This function reads environment variables from `.env` files.\n * Note it does not assign them in `process.env`.\n * @return [envVars, [envPaths, envVarCount][]]\n * */\nexport function readEnvironmentVariables(\n argv: EnvReaderOptions,\n cwd: string\n): [Record<string, string>, [string, number][]] {\n let envPaths = (argv.env ?? []).map((envPath) => path.resolve(cwd, envPath.toString()));\n const cascade =\n argv.cascadeEnv ??\n (argv.cascadeNodeEnv\n ? process.env.NODE_ENV || 'development'\n : argv.autoCascadeEnv\n ? process.env.WB_ENV || process.env.NODE_ENV || 'development'\n : undefined);\n if (typeof cascade === 'string') {\n if (envPaths.length === 0) {\n envPaths.push(path.join(cwd, '.env'));\n if (argv.includeRootEnv) {\n const rootPath = path.resolve(cwd, '..', '..');\n if (fs.existsSync(path.join(rootPath, 'package.json'))) {\n envPaths.push(path.join(rootPath, '.env'));\n }\n }\n }\n envPaths = envPaths.flatMap((envPath) =>\n cascade\n ? [`${envPath}.${cascade}.local`, `${envPath}.local`, `${envPath}.${cascade}`, envPath]\n : [`${envPath}.local`, envPath]\n );\n }\n envPaths = envPaths.filter((envPath) => fs.existsSync(envPath)).map((envPath) => path.relative(cwd, envPath));\n if (argv.verbose) {\n console.info(`WB_ENV: ${process.env.WB_ENV}, NODE_ENV: ${process.env.NODE_ENV}`);\n console.info('Reading env files:', envPaths.join(', '));\n }\n\n const envPathAndEnvVarCountPairs: [string, number][] = [];\n const envVars: Record<string, string> = {};\n for (const envPath of envPaths) {\n let count = 0;\n for (const [key, value] of Object.entries(readEnvFile(path.join(cwd, envPath)))) {\n if (!(key in envVars)) {\n envVars[key] = value;\n count++;\n }\n }\n envPathAndEnvVarCountPairs.push([envPath, count]);\n if (argv.verbose && count > 0) {\n console.info(`Read ${count} environment variables from ${envPath}`);\n }\n }\n\n if (argv.checkEnv) {\n const exampleKeys = Object.keys(readEnvFile(path.join(cwd, argv.checkEnv)) || {});\n const missingKeys = exampleKeys.filter((key) => !(key in envVars));\n if (missingKeys.length > 0) {\n throw new Error(`Missing environment variables in [${envPaths.join(', ')}]: [${missingKeys.join(', ')}]`);\n }\n }\n return [envVars, envPathAndEnvVarCountPairs];\n}\n\n/**\n * This function read environment variables from `.env` files and assign them in `process.env`.\n * */\nexport function readAndApplyEnvironmentVariables(\n argv: EnvReaderOptions,\n cwd: string\n): Record<string, string | undefined> {\n const [envVars] = readEnvironmentVariables(argv, cwd);\n Object.assign(process.env, envVars);\n return envVars;\n}\n\nconst cachedEnvVars = new Map<string, Record<string, string>>();\n\nfunction readEnvFile(filePath: string): Record<string, string> {\n const cached = cachedEnvVars.get(filePath);\n if (cached) return cached;\n\n const parsed = config({ path: path.resolve(filePath), processEnv: {} }).parsed ?? {};\n cachedEnvVars.set(filePath, parsed);\n return parsed;\n}\n\n/**\n * This function removes environment variables related to npm and yarn from the given environment variables.\n * */\nexport function removeNpmAndYarnEnvironmentVariables(envVars: Record<string, string | undefined>): void {\n // Remove npm & yarn environment variables from process.env\n if (envVars.PATH && envVars.BERRY_BIN_FOLDER) {\n envVars.PATH = envVars.PATH.replace(`${envVars.BERRY_BIN_FOLDER}:`, '')\n // Temporary directory in macOS\n .replaceAll(/\\/private\\/var\\/folders\\/[^:]+:/g, '')\n // Temporary directories in Linux\n .replaceAll(/\\/var\\/tmp\\/[^:]+:/g, '')\n .replaceAll(/\\/tmp\\/[^:]+:/g, '');\n }\n for (const key of Object.keys(envVars)) {\n const upperKey = key.toUpperCase();\n if (\n upperKey.startsWith('NPM_') ||\n upperKey.startsWith('YARN_') ||\n upperKey.startsWith('BERRY_') ||\n upperKey === 'PROJECT_CWD' ||\n upperKey === 'INIT_CWD'\n ) {\n delete envVars[key];\n }\n }\n}\n"],"names":["readEnvironmentVariables","argv","cwd","envPaths","env","map","envPath","path","resolve","toString","cascade","cascadeEnv","cascadeNodeEnv","process","NODE_ENV","autoCascadeEnv","WB_ENV","undefined","length","push","join","includeRootEnv","rootPath","fs","existsSync","flatMap","filter","relative","verbose","console","info","envPathAndEnvVarCountPairs","envVars","count","key","value","Object","entries","readEnvFile","checkEnv","missingKeys","keys","Error","cachedEnvVars","Map","filePath","cached","get","parsed","config","processEnv","set","assign","PATH","BERRY_BIN_FOLDER","replace","replaceAll","upperKey","toUpperCase","startsWith","description","type","default","alias"],"mappings":"iFAiDO,SAASA,EACdC,EACAC,GAEA,IAAIC,GAAYF,EAAKG,KAAO,IAAIC,KAAKC,GAAYC,EAAKC,QAAQN,EAAKI,EAAQG,cAC3E,MAAMC,EACJT,EAAKU,aACJV,EAAKW,eACFC,QAAQT,IAAIU,UAAY,cACxBb,EAAKc,eACHF,QAAQT,IAAIY,QAAUH,QAAQT,IAAIU,UAAY,mBAC9CG,GACR,GAAuB,iBAAZP,EAAsB,CAC/B,GAAwB,IAApBP,EAASe,SACXf,EAASgB,KAAKZ,EAAKa,KAAKlB,EAAK,SACzBD,EAAKoB,gBAAgB,CACvB,MAAMC,EAAWf,EAAKC,QAAQN,EAAK,KAAM,MACrCqB,EAAGC,WAAWjB,EAAKa,KAAKE,EAAU,kBACpCnB,EAASgB,KAAKZ,EAAKa,KAAKE,EAAU,QAEtC,CAEFnB,EAAWA,EAASsB,SAASnB,GAC3BI,EACI,CAAC,GAAGJ,KAAWI,UAAiB,GAAGJ,UAAiB,GAAGA,KAAWI,IAAWJ,GAC7E,CAAC,GAAGA,UAAiBA,IAE7B,CACAH,EAAWA,EAASuB,QAAQpB,GAAYiB,EAAGC,WAAWlB,KAAUD,KAAKC,GAAYC,EAAKoB,SAASzB,EAAKI,KAChGL,EAAK2B,UACPC,QAAQC,KAAK,WAAWjB,QAAQT,IAAIY,qBAAqBH,QAAQT,IAAIU,YACrEe,QAAQC,KAAK,qBAAsB3B,EAASiB,KAAK,QAGnD,MAAMW,EAAiD,GACjDC,EAAkC,CAAE,EAC1C,IAAK,MAAM1B,KAAWH,EAAU,CAC9B,IAAI8B,EAAQ,EACZ,IAAK,MAAOC,EAAKC,KAAUC,OAAOC,QAAQC,EAAY/B,EAAKa,KAAKlB,EAAKI,KAC7D4B,KAAOF,IACXA,EAAQE,GAAOC,EACfF,KAGJF,EAA2BZ,KAAK,CAACb,EAAS2B,IACtChC,EAAK2B,SAAWK,EAAQ,GAC1BJ,QAAQC,KAAK,QAAQG,gCAAoC3B,IAE7D,CAEA,GAAIL,EAAKsC,SAAU,CACjB,MACMC,EADcJ,OAAOK,KAAKH,EAAY/B,EAAKa,KAAKlB,EAAKD,EAAKsC,YAAc,CAAA,GAC9Cb,QAAQQ,KAAUA,KAAOF,KACzD,GAAIQ,EAAYtB,OAAS,EACvB,MAAM,IAAIwB,MAAM,qCAAqCvC,EAASiB,KAAK,YAAYoB,EAAYpB,KAAK,SAEpG,CACA,MAAO,CAACY,EAASD,EACnB,CAcA,MAAMY,EAAgB,IAAIC,IAE1B,SAASN,EAAYO,GACnB,MAAMC,EAASH,EAAcI,IAAIF,GACjC,GAAIC,EAAQ,OAAOA,EAEnB,MAAME,EAASC,EAAAA,OAAO,CAAE1C,KAAMA,EAAKC,QAAQqC,GAAWK,WAAY,CAAA,IAAMF,QAAU,CAAE,EAEpF,OADAL,EAAcQ,IAAIN,EAAUG,GACrBA,CACT,0CAlBO,SACL/C,EACAC,GAEA,MAAO8B,GAAWhC,EAAyBC,EAAMC,GAEjD,OADAkC,OAAOgB,OAAOvC,QAAQT,IAAK4B,GACpBA,CACT,kFAgBO,SAA8CA,GAE/CA,EAAQqB,MAAQrB,EAAQsB,mBAC1BtB,EAAQqB,KAAOrB,EAAQqB,KAAKE,QAAQ,GAAGvB,EAAQsB,oBAAqB,IAEjEE,WAAW,mCAAoC,IAE/CA,WAAW,sBAAuB,IAClCA,WAAW,iBAAkB,KAElC,IAAK,MAAMtB,KAAOE,OAAOK,KAAKT,GAAU,CACtC,MAAMyB,EAAWvB,EAAIwB,eAEnBD,EAASE,WAAW,SACpBF,EAASE,WAAW,UACpBF,EAASE,WAAW,WACP,gBAAbF,GACa,aAAbA,WAEOzB,EAAQE,EAEnB,CACF,oCAvJyC,CACvC9B,IAAK,CACHwD,YAAa,2BACbC,KAAM,SAER,cAAe,CACbD,YACE,wLACFC,KAAM,UAER,mBAAoB,CAClBD,YAAa,0FACbC,KAAM,WAER,mBAAoB,CAClBD,YAAa,iEACbC,KAAM,UACNC,SAAS,GAEX,mBAAoB,CAClBF,YAAa,qGACbC,KAAM,UACNC,SAAS,GAEX,YAAa,CACXF,YAAa,qFACbC,KAAM,SACNC,QAAS,gBAEXlC,QAAS,CACPgC,YAAa,sCACbC,KAAM,UACNE,MAAO"}
|
package/dist/env.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"env.js","sources":["../src/env.ts"],"sourcesContent":["import fs from 'node:fs';\nimport path from 'node:path';\n\nimport { config } from 'dotenv';\nimport type { ArgumentsCamelCase, InferredOptionTypes } from 'yargs';\n\nexport const yargsOptionsBuilderForEnv = {\n env: {\n description: '.env files to be loaded.',\n type: 'array',\n },\n 'cascade-env': {\n description:\n 'Environment to load cascading .env files (e.g., `.env`, `.env.<environment>`, `.env.local` and `.env.<environment>.local`). Preferred over `cascade-node-env` and `auto-cascade-env`.',\n type: 'string',\n },\n 'cascade-node-env': {\n description: 'Same with --cascade-env=<NODE_ENV || \"development\">. Preferred over `auto-cascade-env`.',\n type: 'boolean',\n },\n 'auto-cascade-env': {\n description: 'Same with --cascade-env=<WB_ENV || NODE_ENV || \"development\">.',\n type: 'boolean',\n default: true,\n },\n 'include-root-env': {\n description: 'Include .env files in root directory if the project is in a monorepo and --env option is not used.',\n type: 'boolean',\n default: true,\n },\n 'check-env': {\n description: 'Check whether the keys of the loaded .env files are same with the given .env file.',\n type: 'string',\n default: '.env.example',\n },\n verbose: {\n description: 'Whether to show verbose information',\n type: 'boolean',\n alias: 'v',\n },\n} as const;\n\nexport type EnvReaderOptions = Partial<ArgumentsCamelCase<InferredOptionTypes<typeof yargsOptionsBuilderForEnv>>>;\n\n/**\n * This function reads environment variables from `.env` files.\n * Note it does not assign them in `process.env`.\n * @return [envVars, [envPaths, envVarCount][]]\n * */\nexport function readEnvironmentVariables(\n argv: EnvReaderOptions,\n cwd: string\n): [Record<string, string>, [string, number][]] {\n let envPaths = (argv.env ?? []).map((envPath) => path.resolve(cwd, envPath.toString()));\n const cascade =\n argv.cascadeEnv ??\n (argv.cascadeNodeEnv\n ? process.env.NODE_ENV || 'development'\n : argv.autoCascadeEnv\n ? process.env.WB_ENV || process.env.NODE_ENV || 'development'\n : undefined);\n if (typeof cascade === 'string') {\n if (envPaths.length === 0) {\n envPaths.push(path.join(cwd, '.env'));\n if (argv.includeRootEnv) {\n const rootPath = path.resolve(cwd, '..', '..');\n if (fs.existsSync(path.join(rootPath, 'package.json'))) {\n envPaths.push(path.join(rootPath, '.env'));\n }\n }\n }\n envPaths = envPaths.flatMap((envPath) =>\n cascade\n ? [`${envPath}.${cascade}.local`, `${envPath}.local`, `${envPath}.${cascade}`, envPath]\n : [`${envPath}.local`, envPath]\n );\n }\n envPaths = envPaths.filter((envPath) => fs.existsSync(envPath)).map((envPath) => path.relative(cwd, envPath));\n if (argv.verbose) {\n console.info(`WB_ENV: ${process.env.WB_ENV}, NODE_ENV: ${process.env.NODE_ENV}`);\n console.info('Reading env files:', envPaths.join(', '));\n }\n\n const envPathAndEnvVarCountPairs: [string, number][] = [];\n const envVars: Record<string, string> = {};\n for (const envPath of envPaths) {\n let count = 0;\n for (const [key, value] of Object.entries(readEnvFile(path.join(cwd, envPath)))) {\n if (!(key in envVars)) {\n envVars[key] = value;\n count++;\n }\n }\n envPathAndEnvVarCountPairs.push([envPath, count]);\n if (argv.verbose && count > 0) {\n console.info(`Read ${count} environment variables from ${envPath}`);\n }\n }\n\n if (argv.checkEnv) {\n const exampleKeys = Object.keys(readEnvFile(path.join(cwd, argv.checkEnv)) || {});\n const missingKeys = exampleKeys.filter((key) => !(key in envVars));\n if (missingKeys.length > 0) {\n throw new Error(`Missing environment variables in [${envPaths.join(', ')}]: [${missingKeys.join(', ')}]`);\n }\n }\n return [envVars, envPathAndEnvVarCountPairs];\n}\n\n/**\n * This function read environment variables from `.env` files and assign them in `process.env`.\n * */\nexport function readAndApplyEnvironmentVariables(\n argv: EnvReaderOptions,\n cwd: string\n): Record<string, string | undefined> {\n const [envVars] = readEnvironmentVariables(argv, cwd);\n Object.assign(process.env, envVars);\n return envVars;\n}\n\nconst cachedEnvVars = new Map<string, Record<string, string>>();\n\nfunction readEnvFile(filePath: string): Record<string, string> {\n const cached = cachedEnvVars.get(filePath);\n if (cached) return cached;\n\n const parsed = config({ path: path.resolve(filePath), processEnv: {} }).parsed ?? {};\n cachedEnvVars.set(filePath, parsed);\n return parsed;\n}\n\n/**\n * This function removes environment variables related to npm and yarn from the given environment variables.\n * */\nexport function removeNpmAndYarnEnvironmentVariables(envVars: Record<string, string | undefined>): void {\n // Remove npm & yarn environment variables from process.env\n if (envVars.PATH && envVars.BERRY_BIN_FOLDER) {\n envVars.PATH = envVars.PATH.replace(`${envVars.BERRY_BIN_FOLDER}:`, '')\n // Temporary directory in macOS\n .replaceAll(/\\/private\\/var\\/folders\\/[^:]+:/g, '')\n // Temporary directories in Linux\n .replaceAll(/\\/var\\/tmp\\/[^:]+:/g, '')\n .replaceAll(/\\/tmp\\/[^:]+:/g, '');\n }\n for (const key of Object.keys(envVars)) {\n const upperKey = key.toUpperCase();\n if (\n upperKey.startsWith('NPM_') ||\n upperKey.startsWith('YARN_') ||\n upperKey.startsWith('BERRY_') ||\n upperKey === 'PROJECT_CWD' ||\n upperKey === 'INIT_CWD'\n ) {\n delete envVars[key];\n }\n }\n}\n"],"names":["yargsOptionsBuilderForEnv","env","description","type","default","verbose","alias","readEnvironmentVariables","argv","cwd","envPaths","map","envPath","path","resolve","toString","cascade","cascadeEnv","cascadeNodeEnv","process","NODE_ENV","autoCascadeEnv","WB_ENV","undefined","length","push","join","includeRootEnv","rootPath","fs","existsSync","flatMap","filter","relative","console","info","envPathAndEnvVarCountPairs","envVars","count","key","value","Object","entries","readEnvFile","checkEnv","missingKeys","keys","Error","readAndApplyEnvironmentVariables","assign","cachedEnvVars","Map","filePath","cached","get","parsed","config","processEnv","set","removeNpmAndYarnEnvironmentVariables","PATH","BERRY_BIN_FOLDER","replace","replaceAll","upperKey","toUpperCase","startsWith"],"mappings":"gFAMO,MAAMA,EAA4B,CACvCC,IAAK,CACHC,YAAa,2BACbC,KAAM,SAER,cAAe,CACbD,YACE,wLACFC,KAAM,UAER,mBAAoB,CAClBD,YAAa,0FACbC,KAAM,WAER,mBAAoB,CAClBD,YAAa,iEACbC,KAAM,UACNC,SAAS,GAEX,mBAAoB,CAClBF,YAAa,qGACbC,KAAM,UACNC,SAAS,GAEX,YAAa,CACXF,YAAa,qFACbC,KAAM,SACNC,QAAS,gBAEXC,QAAS,CACPH,YAAa,sCACbC,KAAM,UACNG,MAAO,MAWJ,SAASC,EACdC,EACAC,GAEA,IAAIC,GAAYF,EAAKP,KAAO,IAAIU,KAAKC,GAAYC,EAAKC,QAAQL,EAAKG,EAAQG,cAC3E,MAAMC,EACJR,EAAKS,aACJT,EAAKU,eACFC,QAAQlB,IAAImB,UAAY,cACxBZ,EAAKa,eACHF,QAAQlB,IAAIqB,QAAUH,QAAQlB,IAAImB,UAAY,mBAC9CG,GACR,GAAuB,iBAAZP,EAAsB,CAC/B,GAAwB,IAApBN,EAASc,SACXd,EAASe,KAAKZ,EAAKa,KAAKjB,EAAK,SACzBD,EAAKmB,gBAAgB,CACvB,MAAMC,EAAWf,EAAKC,QAAQL,EAAK,KAAM,MACrCoB,EAAGC,WAAWjB,EAAKa,KAAKE,EAAU,kBACpClB,EAASe,KAAKZ,EAAKa,KAAKE,EAAU,QAEtC,CAEFlB,EAAWA,EAASqB,SAASnB,GAC3BI,EACI,CAAC,GAAGJ,KAAWI,UAAiB,GAAGJ,UAAiB,GAAGA,KAAWI,IAAWJ,GAC7E,CAAC,GAAGA,UAAiBA,IAE7B,CACAF,EAAWA,EAASsB,QAAQpB,GAAYiB,EAAGC,WAAWlB,KAAUD,KAAKC,GAAYC,EAAKoB,SAASxB,EAAKG,KAChGJ,EAAKH,UACP6B,QAAQC,KAAK,WAAWhB,QAAQlB,IAAIqB,qBAAqBH,QAAQlB,IAAImB,YACrEc,QAAQC,KAAK,qBAAsBzB,EAASgB,KAAK,QAGnD,MAAMU,EAAiD,GACjDC,EAAkC,
|
|
1
|
+
{"version":3,"file":"env.js","sources":["../src/env.ts"],"sourcesContent":["import fs from 'node:fs';\nimport path from 'node:path';\n\nimport { config } from 'dotenv';\nimport type { ArgumentsCamelCase, InferredOptionTypes } from 'yargs';\n\nexport const yargsOptionsBuilderForEnv = {\n env: {\n description: '.env files to be loaded.',\n type: 'array',\n },\n 'cascade-env': {\n description:\n 'Environment to load cascading .env files (e.g., `.env`, `.env.<environment>`, `.env.local` and `.env.<environment>.local`). Preferred over `cascade-node-env` and `auto-cascade-env`.',\n type: 'string',\n },\n 'cascade-node-env': {\n description: 'Same with --cascade-env=<NODE_ENV || \"development\">. Preferred over `auto-cascade-env`.',\n type: 'boolean',\n },\n 'auto-cascade-env': {\n description: 'Same with --cascade-env=<WB_ENV || NODE_ENV || \"development\">.',\n type: 'boolean',\n default: true,\n },\n 'include-root-env': {\n description: 'Include .env files in root directory if the project is in a monorepo and --env option is not used.',\n type: 'boolean',\n default: true,\n },\n 'check-env': {\n description: 'Check whether the keys of the loaded .env files are same with the given .env file.',\n type: 'string',\n default: '.env.example',\n },\n verbose: {\n description: 'Whether to show verbose information',\n type: 'boolean',\n alias: 'v',\n },\n} as const;\n\nexport type EnvReaderOptions = Partial<ArgumentsCamelCase<InferredOptionTypes<typeof yargsOptionsBuilderForEnv>>>;\n\n/**\n * This function reads environment variables from `.env` files.\n * Note it does not assign them in `process.env`.\n * @return [envVars, [envPaths, envVarCount][]]\n * */\nexport function readEnvironmentVariables(\n argv: EnvReaderOptions,\n cwd: string\n): [Record<string, string>, [string, number][]] {\n let envPaths = (argv.env ?? []).map((envPath) => path.resolve(cwd, envPath.toString()));\n const cascade =\n argv.cascadeEnv ??\n (argv.cascadeNodeEnv\n ? process.env.NODE_ENV || 'development'\n : argv.autoCascadeEnv\n ? process.env.WB_ENV || process.env.NODE_ENV || 'development'\n : undefined);\n if (typeof cascade === 'string') {\n if (envPaths.length === 0) {\n envPaths.push(path.join(cwd, '.env'));\n if (argv.includeRootEnv) {\n const rootPath = path.resolve(cwd, '..', '..');\n if (fs.existsSync(path.join(rootPath, 'package.json'))) {\n envPaths.push(path.join(rootPath, '.env'));\n }\n }\n }\n envPaths = envPaths.flatMap((envPath) =>\n cascade\n ? [`${envPath}.${cascade}.local`, `${envPath}.local`, `${envPath}.${cascade}`, envPath]\n : [`${envPath}.local`, envPath]\n );\n }\n envPaths = envPaths.filter((envPath) => fs.existsSync(envPath)).map((envPath) => path.relative(cwd, envPath));\n if (argv.verbose) {\n console.info(`WB_ENV: ${process.env.WB_ENV}, NODE_ENV: ${process.env.NODE_ENV}`);\n console.info('Reading env files:', envPaths.join(', '));\n }\n\n const envPathAndEnvVarCountPairs: [string, number][] = [];\n const envVars: Record<string, string> = {};\n for (const envPath of envPaths) {\n let count = 0;\n for (const [key, value] of Object.entries(readEnvFile(path.join(cwd, envPath)))) {\n if (!(key in envVars)) {\n envVars[key] = value;\n count++;\n }\n }\n envPathAndEnvVarCountPairs.push([envPath, count]);\n if (argv.verbose && count > 0) {\n console.info(`Read ${count} environment variables from ${envPath}`);\n }\n }\n\n if (argv.checkEnv) {\n const exampleKeys = Object.keys(readEnvFile(path.join(cwd, argv.checkEnv)) || {});\n const missingKeys = exampleKeys.filter((key) => !(key in envVars));\n if (missingKeys.length > 0) {\n throw new Error(`Missing environment variables in [${envPaths.join(', ')}]: [${missingKeys.join(', ')}]`);\n }\n }\n return [envVars, envPathAndEnvVarCountPairs];\n}\n\n/**\n * This function read environment variables from `.env` files and assign them in `process.env`.\n * */\nexport function readAndApplyEnvironmentVariables(\n argv: EnvReaderOptions,\n cwd: string\n): Record<string, string | undefined> {\n const [envVars] = readEnvironmentVariables(argv, cwd);\n Object.assign(process.env, envVars);\n return envVars;\n}\n\nconst cachedEnvVars = new Map<string, Record<string, string>>();\n\nfunction readEnvFile(filePath: string): Record<string, string> {\n const cached = cachedEnvVars.get(filePath);\n if (cached) return cached;\n\n const parsed = config({ path: path.resolve(filePath), processEnv: {} }).parsed ?? {};\n cachedEnvVars.set(filePath, parsed);\n return parsed;\n}\n\n/**\n * This function removes environment variables related to npm and yarn from the given environment variables.\n * */\nexport function removeNpmAndYarnEnvironmentVariables(envVars: Record<string, string | undefined>): void {\n // Remove npm & yarn environment variables from process.env\n if (envVars.PATH && envVars.BERRY_BIN_FOLDER) {\n envVars.PATH = envVars.PATH.replace(`${envVars.BERRY_BIN_FOLDER}:`, '')\n // Temporary directory in macOS\n .replaceAll(/\\/private\\/var\\/folders\\/[^:]+:/g, '')\n // Temporary directories in Linux\n .replaceAll(/\\/var\\/tmp\\/[^:]+:/g, '')\n .replaceAll(/\\/tmp\\/[^:]+:/g, '');\n }\n for (const key of Object.keys(envVars)) {\n const upperKey = key.toUpperCase();\n if (\n upperKey.startsWith('NPM_') ||\n upperKey.startsWith('YARN_') ||\n upperKey.startsWith('BERRY_') ||\n upperKey === 'PROJECT_CWD' ||\n upperKey === 'INIT_CWD'\n ) {\n delete envVars[key];\n }\n }\n}\n"],"names":["yargsOptionsBuilderForEnv","env","description","type","default","verbose","alias","readEnvironmentVariables","argv","cwd","envPaths","map","envPath","path","resolve","toString","cascade","cascadeEnv","cascadeNodeEnv","process","NODE_ENV","autoCascadeEnv","WB_ENV","undefined","length","push","join","includeRootEnv","rootPath","fs","existsSync","flatMap","filter","relative","console","info","envPathAndEnvVarCountPairs","envVars","count","key","value","Object","entries","readEnvFile","checkEnv","missingKeys","keys","Error","readAndApplyEnvironmentVariables","assign","cachedEnvVars","Map","filePath","cached","get","parsed","config","processEnv","set","removeNpmAndYarnEnvironmentVariables","PATH","BERRY_BIN_FOLDER","replace","replaceAll","upperKey","toUpperCase","startsWith"],"mappings":"gFAMO,MAAMA,EAA4B,CACvCC,IAAK,CACHC,YAAa,2BACbC,KAAM,SAER,cAAe,CACbD,YACE,wLACFC,KAAM,UAER,mBAAoB,CAClBD,YAAa,0FACbC,KAAM,WAER,mBAAoB,CAClBD,YAAa,iEACbC,KAAM,UACNC,SAAS,GAEX,mBAAoB,CAClBF,YAAa,qGACbC,KAAM,UACNC,SAAS,GAEX,YAAa,CACXF,YAAa,qFACbC,KAAM,SACNC,QAAS,gBAEXC,QAAS,CACPH,YAAa,sCACbC,KAAM,UACNG,MAAO,MAWJ,SAASC,EACdC,EACAC,GAEA,IAAIC,GAAYF,EAAKP,KAAO,IAAIU,KAAKC,GAAYC,EAAKC,QAAQL,EAAKG,EAAQG,cAC3E,MAAMC,EACJR,EAAKS,aACJT,EAAKU,eACFC,QAAQlB,IAAImB,UAAY,cACxBZ,EAAKa,eACHF,QAAQlB,IAAIqB,QAAUH,QAAQlB,IAAImB,UAAY,mBAC9CG,GACR,GAAuB,iBAAZP,EAAsB,CAC/B,GAAwB,IAApBN,EAASc,SACXd,EAASe,KAAKZ,EAAKa,KAAKjB,EAAK,SACzBD,EAAKmB,gBAAgB,CACvB,MAAMC,EAAWf,EAAKC,QAAQL,EAAK,KAAM,MACrCoB,EAAGC,WAAWjB,EAAKa,KAAKE,EAAU,kBACpClB,EAASe,KAAKZ,EAAKa,KAAKE,EAAU,QAEtC,CAEFlB,EAAWA,EAASqB,SAASnB,GAC3BI,EACI,CAAC,GAAGJ,KAAWI,UAAiB,GAAGJ,UAAiB,GAAGA,KAAWI,IAAWJ,GAC7E,CAAC,GAAGA,UAAiBA,IAE7B,CACAF,EAAWA,EAASsB,QAAQpB,GAAYiB,EAAGC,WAAWlB,KAAUD,KAAKC,GAAYC,EAAKoB,SAASxB,EAAKG,KAChGJ,EAAKH,UACP6B,QAAQC,KAAK,WAAWhB,QAAQlB,IAAIqB,qBAAqBH,QAAQlB,IAAImB,YACrEc,QAAQC,KAAK,qBAAsBzB,EAASgB,KAAK,QAGnD,MAAMU,EAAiD,GACjDC,EAAkC,CAAE,EAC1C,IAAK,MAAMzB,KAAWF,EAAU,CAC9B,IAAI4B,EAAQ,EACZ,IAAK,MAAOC,EAAKC,KAAUC,OAAOC,QAAQC,EAAY9B,EAAKa,KAAKjB,EAAKG,KAC7D2B,KAAOF,IACXA,EAAQE,GAAOC,EACfF,KAGJF,EAA2BX,KAAK,CAACb,EAAS0B,IACtC9B,EAAKH,SAAWiC,EAAQ,GAC1BJ,QAAQC,KAAK,QAAQG,gCAAoC1B,IAE7D,CAEA,GAAIJ,EAAKoC,SAAU,CACjB,MACMC,EADcJ,OAAOK,KAAKH,EAAY9B,EAAKa,KAAKjB,EAAKD,EAAKoC,YAAc,CAAA,GAC9CZ,QAAQO,KAAUA,KAAOF,KACzD,GAAIQ,EAAYrB,OAAS,EACvB,MAAM,IAAIuB,MAAM,qCAAqCrC,EAASgB,KAAK,YAAYmB,EAAYnB,KAAK,SAEpG,CACA,MAAO,CAACW,EAASD,EACnB,CAKO,SAASY,EACdxC,EACAC,GAEA,MAAO4B,GAAW9B,EAAyBC,EAAMC,GAEjD,OADAgC,OAAOQ,OAAO9B,QAAQlB,IAAKoC,GACpBA,CACT,CAEA,MAAMa,EAAgB,IAAIC,IAE1B,SAASR,EAAYS,GACnB,MAAMC,EAASH,EAAcI,IAAIF,GACjC,GAAIC,EAAQ,OAAOA,EAEnB,MAAME,EAASC,EAAO,CAAE3C,KAAMA,EAAKC,QAAQsC,GAAWK,WAAY,CAAA,IAAMF,QAAU,CAAE,EAEpF,OADAL,EAAcQ,IAAIN,EAAUG,GACrBA,CACT,CAKO,SAASI,EAAqCtB,GAE/CA,EAAQuB,MAAQvB,EAAQwB,mBAC1BxB,EAAQuB,KAAOvB,EAAQuB,KAAKE,QAAQ,GAAGzB,EAAQwB,oBAAqB,IAEjEE,WAAW,mCAAoC,IAE/CA,WAAW,sBAAuB,IAClCA,WAAW,iBAAkB,KAElC,IAAK,MAAMxB,KAAOE,OAAOK,KAAKT,GAAU,CACtC,MAAM2B,EAAWzB,EAAI0B,eAEnBD,EAASE,WAAW,SACpBF,EAASE,WAAW,UACpBF,EAASE,WAAW,WACP,gBAAbF,GACa,aAAbA,WAEO3B,EAAQE,EAEnB,CACF"}
|
package/dist/spawn.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"spawn.cjs","sources":["../src/spawn.ts"],"sourcesContent":["import type {\n SpawnOptions,\n SpawnOptionsWithoutStdio,\n SpawnOptionsWithStdioTuple,\n SpawnSyncReturns,\n StdioNull,\n StdioPipe,\n} from 'node:child_process';\nimport { spawn } from 'node:child_process';\n\nimport treeKill from 'tree-kill';\n\nexport type SpawnAsyncReturns = Omit<SpawnSyncReturns<string>, 'output' | 'error'>;\n\nexport type SpawnAsyncOptions = (\n | SpawnOptionsWithoutStdio\n | SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioPipe>\n | SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioNull>\n | SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioPipe>\n | SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioPipe>\n | SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioNull>\n | SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioNull>\n | SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioPipe>\n | SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioNull>\n | SpawnOptions\n) & {\n input?: string;\n mergeOutAndError?: boolean;\n killOnExit?: boolean;\n verbose?: boolean;\n};\n\nexport async function spawnAsync(\n command: string,\n args?: ReadonlyArray<string>,\n options?: SpawnAsyncOptions\n): Promise<SpawnAsyncReturns> {\n return new Promise((resolve, reject) => {\n try {\n const proc = spawn(command, args ?? [], options ?? {});\n // `setEncoding` is undefined in Bun\n proc.stdout?.setEncoding?.('utf8');\n proc.stderr?.setEncoding?.('utf8');\n\n let stdout = '';\n let stderr = '';\n proc.stdout?.on('data', (data) => {\n stdout += data;\n });\n proc.stderr?.on('data', (data) => {\n if (options?.mergeOutAndError) {\n stdout += data;\n } else {\n stderr += data;\n }\n });\n\n let stopped = false;\n const stopProcess = (): void => {\n if (stopped || !proc.pid) return;\n\n stopped = true;\n if (options?.verbose) {\n console.info(`treeKill(${proc.pid})`);\n }\n treeKill(proc.pid);\n };\n if (options?.killOnExit) {\n process.on('beforeExit', stopProcess);\n process.on('SIGINT', stopProcess);\n }\n\n proc.on('error', (error) => {\n process.removeListener('beforeExit', stopProcess);\n process.removeListener('SIGINT', stopProcess);\n proc.removeAllListeners('close');\n reject(error);\n });\n proc.on('close', (code: number | null, signal: NodeJS.Signals | null) => {\n process.removeListener('beforeExit', stopProcess);\n process.removeListener('SIGINT', stopProcess);\n if (proc.pid === undefined) {\n reject(new Error('Process has no pid.'));\n } else {\n resolve({\n pid: proc.pid,\n stdout,\n stderr,\n status: code,\n signal,\n });\n }\n });\n\n if (options?.input) {\n proc.stdin?.write(options.input);\n proc.stdin?.end();\n }\n } catch (error) {\n reject(error);\n }\n });\n}\n"],"names":["async","command","args","options","Promise","resolve","reject","proc","spawn","stdout","setEncoding","stderr","on","data","mergeOutAndError","stopped","stopProcess","pid","verbose","console","info","treeKill","killOnExit","process","error","removeListener","removeAllListeners","code","signal","undefined","Error","status","input","stdin","write","end"],"mappings":"
|
|
1
|
+
{"version":3,"file":"spawn.cjs","sources":["../src/spawn.ts"],"sourcesContent":["import type {\n SpawnOptions,\n SpawnOptionsWithoutStdio,\n SpawnOptionsWithStdioTuple,\n SpawnSyncReturns,\n StdioNull,\n StdioPipe,\n} from 'node:child_process';\nimport { spawn } from 'node:child_process';\n\nimport treeKill from 'tree-kill';\n\n/**\n * Return type for spawnAsync function, based on SpawnSyncReturns but without output and error properties\n */\nexport type SpawnAsyncReturns = Omit<SpawnSyncReturns<string>, 'output' | 'error'>;\n\n/**\n * Options for spawnAsync function, extending various Node.js spawn options with additional functionality\n */\nexport type SpawnAsyncOptions = (\n | SpawnOptionsWithoutStdio\n | SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioPipe>\n | SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioNull>\n | SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioPipe>\n | SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioPipe>\n | SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioNull>\n | SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioNull>\n | SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioPipe>\n | SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioNull>\n | SpawnOptions\n) & {\n /** Input string to write to the spawned process's stdin */\n input?: string;\n /** If true, stderr output will be merged into stdout */\n mergeOutAndError?: boolean;\n /** If true, the spawned process will be killed when the parent process exits */\n killOnExit?: boolean;\n /** If true, enables verbose logging of process operations */\n verbose?: boolean;\n};\n\n/**\n * Spawns a child process asynchronously and returns a promise that resolves with the process results\n *\n * This function provides a Promise-based wrapper around Node.js's spawn function with additional features:\n * - Automatic encoding of stdout/stderr as UTF-8\n * - Option to merge stderr into stdout\n * - Option to automatically kill the process on parent exit\n * - Option to provide input via stdin\n * - Verbose logging capability\n *\n * @param command - The command to run\n * @param args - List of string arguments\n * @param options - Configuration options for the spawned process\n * @returns Promise that resolves with the process results including pid, stdout, stderr, status, and signal\n * @throws Will reject the promise if the process fails to spawn or encounters an error\n *\n * @example\n * ```typescript\n * const result = await spawnAsync('ls', ['-la'], { verbose: true });\n * console.log(result.stdout);\n * ```\n */\nexport async function spawnAsync(\n command: string,\n args?: ReadonlyArray<string>,\n options?: SpawnAsyncOptions\n): Promise<SpawnAsyncReturns> {\n return new Promise((resolve, reject) => {\n try {\n const proc = spawn(command, args ?? [], options ?? {});\n // `setEncoding` is undefined in Bun\n proc.stdout?.setEncoding?.('utf8');\n proc.stderr?.setEncoding?.('utf8');\n\n let stdout = '';\n let stderr = '';\n proc.stdout?.on('data', (data) => {\n stdout += data;\n });\n proc.stderr?.on('data', (data) => {\n if (options?.mergeOutAndError) {\n stdout += data;\n } else {\n stderr += data;\n }\n });\n\n let stopped = false;\n const stopProcess = (): void => {\n if (stopped || !proc.pid) return;\n\n stopped = true;\n if (options?.verbose) {\n console.info(`treeKill(${proc.pid})`);\n }\n treeKill(proc.pid);\n };\n if (options?.killOnExit) {\n process.on('beforeExit', stopProcess);\n process.on('SIGINT', stopProcess);\n }\n\n proc.on('error', (error) => {\n process.removeListener('beforeExit', stopProcess);\n process.removeListener('SIGINT', stopProcess);\n proc.removeAllListeners('close');\n reject(error);\n });\n proc.on('close', (code: number | null, signal: NodeJS.Signals | null) => {\n process.removeListener('beforeExit', stopProcess);\n process.removeListener('SIGINT', stopProcess);\n if (proc.pid === undefined) {\n reject(new Error('Process has no pid.'));\n } else {\n resolve({\n pid: proc.pid,\n stdout,\n stderr,\n status: code,\n signal,\n });\n }\n });\n\n if (options?.input) {\n proc.stdin?.write(options.input);\n proc.stdin?.end();\n }\n } catch (error) {\n reject(error);\n }\n });\n}\n"],"names":["async","command","args","options","Promise","resolve","reject","proc","spawn","stdout","setEncoding","stderr","on","data","mergeOutAndError","stopped","stopProcess","pid","verbose","console","info","treeKill","killOnExit","process","error","removeListener","removeAllListeners","code","signal","undefined","Error","status","input","stdin","write","end"],"mappings":"2FAgEOA,eACLC,EACAC,EACAC,GAEA,OAAO,IAAIC,SAAQ,CAACC,EAASC,KAC3B,IACE,MAAMC,EAAOC,EAAAA,MAAMP,EAASC,GAAQ,GAAIC,GAAW,IAEnDI,EAAKE,QAAQC,cAAc,QAC3BH,EAAKI,QAAQD,cAAc,QAE3B,IAAID,EAAS,GACTE,EAAS,GACbJ,EAAKE,QAAQG,GAAG,QAASC,IACvBJ,GAAUI,CAAI,IAEhBN,EAAKI,QAAQC,GAAG,QAASC,IACnBV,GAASW,iBACXL,GAAUI,EAEVF,GAAUE,CACZ,IAGF,IAAIE,GAAU,EACd,MAAMC,EAAcA,MACdD,GAAYR,EAAKU,MAErBF,GAAU,EACNZ,GAASe,SACXC,QAAQC,KAAK,YAAYb,EAAKU,QAEhCI,EAASd,EAAKU,KAAI,EAEhBd,GAASmB,aACXC,QAAQX,GAAG,aAAcI,GACzBO,QAAQX,GAAG,SAAUI,IAGvBT,EAAKK,GAAG,SAAUY,IAChBD,QAAQE,eAAe,aAAcT,GACrCO,QAAQE,eAAe,SAAUT,GACjCT,EAAKmB,mBAAmB,SACxBpB,EAAOkB,EAAM,IAEfjB,EAAKK,GAAG,SAAS,CAACe,EAAqBC,KACrCL,QAAQE,eAAe,aAAcT,GACrCO,QAAQE,eAAe,SAAUT,QAChBa,IAAbtB,EAAKU,IACPX,EAAO,IAAIwB,MAAM,wBAEjBzB,EAAQ,CACNY,IAAKV,EAAKU,IACVR,SACAE,SACAoB,OAAQJ,EACRC,UAEJ,IAGEzB,GAAS6B,QACXzB,EAAK0B,OAAOC,MAAM/B,EAAQ6B,OAC1BzB,EAAK0B,OAAOE,MAEf,CAAC,MAAOX,GACPlB,EAAOkB,EACT,IAEJ"}
|
package/dist/spawn.d.ts
CHANGED
|
@@ -1,10 +1,41 @@
|
|
|
1
|
-
/// <reference types="node" resolution-mode="require"/>
|
|
2
1
|
import type { SpawnOptions, SpawnOptionsWithoutStdio, SpawnOptionsWithStdioTuple, SpawnSyncReturns, StdioNull, StdioPipe } from 'node:child_process';
|
|
2
|
+
/**
|
|
3
|
+
* Return type for spawnAsync function, based on SpawnSyncReturns but without output and error properties
|
|
4
|
+
*/
|
|
3
5
|
export type SpawnAsyncReturns = Omit<SpawnSyncReturns<string>, 'output' | 'error'>;
|
|
6
|
+
/**
|
|
7
|
+
* Options for spawnAsync function, extending various Node.js spawn options with additional functionality
|
|
8
|
+
*/
|
|
4
9
|
export type SpawnAsyncOptions = (SpawnOptionsWithoutStdio | SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioPipe> | SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioNull> | SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioPipe> | SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioPipe> | SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioNull> | SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioNull> | SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioPipe> | SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioNull> | SpawnOptions) & {
|
|
10
|
+
/** Input string to write to the spawned process's stdin */
|
|
5
11
|
input?: string;
|
|
12
|
+
/** If true, stderr output will be merged into stdout */
|
|
6
13
|
mergeOutAndError?: boolean;
|
|
14
|
+
/** If true, the spawned process will be killed when the parent process exits */
|
|
7
15
|
killOnExit?: boolean;
|
|
16
|
+
/** If true, enables verbose logging of process operations */
|
|
8
17
|
verbose?: boolean;
|
|
9
18
|
};
|
|
19
|
+
/**
|
|
20
|
+
* Spawns a child process asynchronously and returns a promise that resolves with the process results
|
|
21
|
+
*
|
|
22
|
+
* This function provides a Promise-based wrapper around Node.js's spawn function with additional features:
|
|
23
|
+
* - Automatic encoding of stdout/stderr as UTF-8
|
|
24
|
+
* - Option to merge stderr into stdout
|
|
25
|
+
* - Option to automatically kill the process on parent exit
|
|
26
|
+
* - Option to provide input via stdin
|
|
27
|
+
* - Verbose logging capability
|
|
28
|
+
*
|
|
29
|
+
* @param command - The command to run
|
|
30
|
+
* @param args - List of string arguments
|
|
31
|
+
* @param options - Configuration options for the spawned process
|
|
32
|
+
* @returns Promise that resolves with the process results including pid, stdout, stderr, status, and signal
|
|
33
|
+
* @throws Will reject the promise if the process fails to spawn or encounters an error
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```typescript
|
|
37
|
+
* const result = await spawnAsync('ls', ['-la'], { verbose: true });
|
|
38
|
+
* console.log(result.stdout);
|
|
39
|
+
* ```
|
|
40
|
+
*/
|
|
10
41
|
export declare function spawnAsync(command: string, args?: ReadonlyArray<string>, options?: SpawnAsyncOptions): Promise<SpawnAsyncReturns>;
|
package/dist/spawn.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"spawn.js","sources":["../src/spawn.ts"],"sourcesContent":["import type {\n SpawnOptions,\n SpawnOptionsWithoutStdio,\n SpawnOptionsWithStdioTuple,\n SpawnSyncReturns,\n StdioNull,\n StdioPipe,\n} from 'node:child_process';\nimport { spawn } from 'node:child_process';\n\nimport treeKill from 'tree-kill';\n\nexport type SpawnAsyncReturns = Omit<SpawnSyncReturns<string>, 'output' | 'error'>;\n\nexport type SpawnAsyncOptions = (\n | SpawnOptionsWithoutStdio\n | SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioPipe>\n | SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioNull>\n | SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioPipe>\n | SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioPipe>\n | SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioNull>\n | SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioNull>\n | SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioPipe>\n | SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioNull>\n | SpawnOptions\n) & {\n input?: string;\n mergeOutAndError?: boolean;\n killOnExit?: boolean;\n verbose?: boolean;\n};\n\nexport async function spawnAsync(\n command: string,\n args?: ReadonlyArray<string>,\n options?: SpawnAsyncOptions\n): Promise<SpawnAsyncReturns> {\n return new Promise((resolve, reject) => {\n try {\n const proc = spawn(command, args ?? [], options ?? {});\n // `setEncoding` is undefined in Bun\n proc.stdout?.setEncoding?.('utf8');\n proc.stderr?.setEncoding?.('utf8');\n\n let stdout = '';\n let stderr = '';\n proc.stdout?.on('data', (data) => {\n stdout += data;\n });\n proc.stderr?.on('data', (data) => {\n if (options?.mergeOutAndError) {\n stdout += data;\n } else {\n stderr += data;\n }\n });\n\n let stopped = false;\n const stopProcess = (): void => {\n if (stopped || !proc.pid) return;\n\n stopped = true;\n if (options?.verbose) {\n console.info(`treeKill(${proc.pid})`);\n }\n treeKill(proc.pid);\n };\n if (options?.killOnExit) {\n process.on('beforeExit', stopProcess);\n process.on('SIGINT', stopProcess);\n }\n\n proc.on('error', (error) => {\n process.removeListener('beforeExit', stopProcess);\n process.removeListener('SIGINT', stopProcess);\n proc.removeAllListeners('close');\n reject(error);\n });\n proc.on('close', (code: number | null, signal: NodeJS.Signals | null) => {\n process.removeListener('beforeExit', stopProcess);\n process.removeListener('SIGINT', stopProcess);\n if (proc.pid === undefined) {\n reject(new Error('Process has no pid.'));\n } else {\n resolve({\n pid: proc.pid,\n stdout,\n stderr,\n status: code,\n signal,\n });\n }\n });\n\n if (options?.input) {\n proc.stdin?.write(options.input);\n proc.stdin?.end();\n }\n } catch (error) {\n reject(error);\n }\n });\n}\n"],"names":["async","spawnAsync","command","args","options","Promise","resolve","reject","proc","spawn","stdout","setEncoding","stderr","on","data","mergeOutAndError","stopped","stopProcess","pid","verbose","console","info","treeKill","killOnExit","process","error","removeListener","removeAllListeners","code","signal","undefined","Error","status","input","stdin","write","end"],"mappings":"
|
|
1
|
+
{"version":3,"file":"spawn.js","sources":["../src/spawn.ts"],"sourcesContent":["import type {\n SpawnOptions,\n SpawnOptionsWithoutStdio,\n SpawnOptionsWithStdioTuple,\n SpawnSyncReturns,\n StdioNull,\n StdioPipe,\n} from 'node:child_process';\nimport { spawn } from 'node:child_process';\n\nimport treeKill from 'tree-kill';\n\n/**\n * Return type for spawnAsync function, based on SpawnSyncReturns but without output and error properties\n */\nexport type SpawnAsyncReturns = Omit<SpawnSyncReturns<string>, 'output' | 'error'>;\n\n/**\n * Options for spawnAsync function, extending various Node.js spawn options with additional functionality\n */\nexport type SpawnAsyncOptions = (\n | SpawnOptionsWithoutStdio\n | SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioPipe>\n | SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioNull>\n | SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioPipe>\n | SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioPipe>\n | SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioNull>\n | SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioNull>\n | SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioPipe>\n | SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioNull>\n | SpawnOptions\n) & {\n /** Input string to write to the spawned process's stdin */\n input?: string;\n /** If true, stderr output will be merged into stdout */\n mergeOutAndError?: boolean;\n /** If true, the spawned process will be killed when the parent process exits */\n killOnExit?: boolean;\n /** If true, enables verbose logging of process operations */\n verbose?: boolean;\n};\n\n/**\n * Spawns a child process asynchronously and returns a promise that resolves with the process results\n *\n * This function provides a Promise-based wrapper around Node.js's spawn function with additional features:\n * - Automatic encoding of stdout/stderr as UTF-8\n * - Option to merge stderr into stdout\n * - Option to automatically kill the process on parent exit\n * - Option to provide input via stdin\n * - Verbose logging capability\n *\n * @param command - The command to run\n * @param args - List of string arguments\n * @param options - Configuration options for the spawned process\n * @returns Promise that resolves with the process results including pid, stdout, stderr, status, and signal\n * @throws Will reject the promise if the process fails to spawn or encounters an error\n *\n * @example\n * ```typescript\n * const result = await spawnAsync('ls', ['-la'], { verbose: true });\n * console.log(result.stdout);\n * ```\n */\nexport async function spawnAsync(\n command: string,\n args?: ReadonlyArray<string>,\n options?: SpawnAsyncOptions\n): Promise<SpawnAsyncReturns> {\n return new Promise((resolve, reject) => {\n try {\n const proc = spawn(command, args ?? [], options ?? {});\n // `setEncoding` is undefined in Bun\n proc.stdout?.setEncoding?.('utf8');\n proc.stderr?.setEncoding?.('utf8');\n\n let stdout = '';\n let stderr = '';\n proc.stdout?.on('data', (data) => {\n stdout += data;\n });\n proc.stderr?.on('data', (data) => {\n if (options?.mergeOutAndError) {\n stdout += data;\n } else {\n stderr += data;\n }\n });\n\n let stopped = false;\n const stopProcess = (): void => {\n if (stopped || !proc.pid) return;\n\n stopped = true;\n if (options?.verbose) {\n console.info(`treeKill(${proc.pid})`);\n }\n treeKill(proc.pid);\n };\n if (options?.killOnExit) {\n process.on('beforeExit', stopProcess);\n process.on('SIGINT', stopProcess);\n }\n\n proc.on('error', (error) => {\n process.removeListener('beforeExit', stopProcess);\n process.removeListener('SIGINT', stopProcess);\n proc.removeAllListeners('close');\n reject(error);\n });\n proc.on('close', (code: number | null, signal: NodeJS.Signals | null) => {\n process.removeListener('beforeExit', stopProcess);\n process.removeListener('SIGINT', stopProcess);\n if (proc.pid === undefined) {\n reject(new Error('Process has no pid.'));\n } else {\n resolve({\n pid: proc.pid,\n stdout,\n stderr,\n status: code,\n signal,\n });\n }\n });\n\n if (options?.input) {\n proc.stdin?.write(options.input);\n proc.stdin?.end();\n }\n } catch (error) {\n reject(error);\n }\n });\n}\n"],"names":["async","spawnAsync","command","args","options","Promise","resolve","reject","proc","spawn","stdout","setEncoding","stderr","on","data","mergeOutAndError","stopped","stopProcess","pid","verbose","console","info","treeKill","killOnExit","process","error","removeListener","removeAllListeners","code","signal","undefined","Error","status","input","stdin","write","end"],"mappings":"oEAgEOA,eAAeC,EACpBC,EACAC,EACAC,GAEA,OAAO,IAAIC,SAAQ,CAACC,EAASC,KAC3B,IACE,MAAMC,EAAOC,EAAMP,EAASC,GAAQ,GAAIC,GAAW,IAEnDI,EAAKE,QAAQC,cAAc,QAC3BH,EAAKI,QAAQD,cAAc,QAE3B,IAAID,EAAS,GACTE,EAAS,GACbJ,EAAKE,QAAQG,GAAG,QAASC,IACvBJ,GAAUI,CAAI,IAEhBN,EAAKI,QAAQC,GAAG,QAASC,IACnBV,GAASW,iBACXL,GAAUI,EAEVF,GAAUE,CACZ,IAGF,IAAIE,GAAU,EACd,MAAMC,EAAcA,MACdD,GAAYR,EAAKU,MAErBF,GAAU,EACNZ,GAASe,SACXC,QAAQC,KAAK,YAAYb,EAAKU,QAEhCI,EAASd,EAAKU,KAAI,EAEhBd,GAASmB,aACXC,QAAQX,GAAG,aAAcI,GACzBO,QAAQX,GAAG,SAAUI,IAGvBT,EAAKK,GAAG,SAAUY,IAChBD,QAAQE,eAAe,aAAcT,GACrCO,QAAQE,eAAe,SAAUT,GACjCT,EAAKmB,mBAAmB,SACxBpB,EAAOkB,EAAM,IAEfjB,EAAKK,GAAG,SAAS,CAACe,EAAqBC,KACrCL,QAAQE,eAAe,aAAcT,GACrCO,QAAQE,eAAe,SAAUT,QAChBa,IAAbtB,EAAKU,IACPX,EAAO,IAAIwB,MAAM,wBAEjBzB,EAAQ,CACNY,IAAKV,EAAKU,IACVR,SACAE,SACAoB,OAAQJ,EACRC,UAEJ,IAGEzB,GAAS6B,QACXzB,EAAK0B,OAAOC,MAAM/B,EAAQ6B,OAC1BzB,EAAK0B,OAAOE,MAEf,CAAC,MAAOX,GACPlB,EAAOkB,EACT,IAEJ"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@willbooster/shared-lib-node",
|
|
3
|
-
"version": "6.0.
|
|
3
|
+
"version": "6.0.6",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"author": "WillBooster Inc.",
|
|
6
6
|
"sideEffects": false,
|
|
@@ -42,25 +42,25 @@
|
|
|
42
42
|
"devDependencies": {
|
|
43
43
|
"@types/eslint": "8.56.10",
|
|
44
44
|
"@types/micromatch": "4.0.9",
|
|
45
|
-
"@types/node": "22.10.
|
|
46
|
-
"@typescript-eslint/eslint-plugin": "8.
|
|
47
|
-
"@typescript-eslint/parser": "8.
|
|
45
|
+
"@types/node": "22.10.7",
|
|
46
|
+
"@typescript-eslint/eslint-plugin": "8.20.0",
|
|
47
|
+
"@typescript-eslint/parser": "8.20.0",
|
|
48
48
|
"@willbooster/eslint-config-ts": "10.6.1",
|
|
49
49
|
"@willbooster/prettier-config": "9.1.3",
|
|
50
|
-
"build-ts": "13.1.
|
|
50
|
+
"build-ts": "13.1.11",
|
|
51
51
|
"eslint": "8.57.0",
|
|
52
|
-
"eslint-config-prettier": "
|
|
52
|
+
"eslint-config-prettier": "10.0.1",
|
|
53
53
|
"eslint-import-resolver-typescript": "3.7.0",
|
|
54
54
|
"eslint-plugin-import": "2.31.0",
|
|
55
55
|
"eslint-plugin-sort-class-members": "1.21.0",
|
|
56
56
|
"eslint-plugin-sort-destructure-keys": "2.0.0",
|
|
57
57
|
"eslint-plugin-unicorn": "56.0.1",
|
|
58
|
-
"lint-staged": "15.
|
|
58
|
+
"lint-staged": "15.4.1",
|
|
59
59
|
"micromatch": "4.0.8",
|
|
60
60
|
"prettier": "3.4.2",
|
|
61
|
-
"sort-package-json": "2.
|
|
62
|
-
"typescript": "5.7.
|
|
63
|
-
"vitest": "
|
|
61
|
+
"sort-package-json": "2.14.0",
|
|
62
|
+
"typescript": "5.7.3",
|
|
63
|
+
"vitest": "3.0.2"
|
|
64
64
|
},
|
|
65
65
|
"publishConfig": {
|
|
66
66
|
"access": "public"
|