archive-gh-me/env-cmd
1
0
Fork 0
mirror of https://github.com/toddbluhm/env-cmd.git synced 2025-12-08 18:23:33 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #392 from toddbluhm/update-to-recent-node-versions

Browse Source 
feat(update): Update Project to Recent Node Versions
This commit is contained in:
Todd Bluhm 2024-12-03 05:58:08 -06:00 committed by GitHub
commit bdf3ddf53c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
57 changed files with 733 additions and 551 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.mocharc.json Normal file
View File

@ -0,0 +1,8 @@
{
"$schema": "https://json.schemastore.org/mocharc.json",
"require": ["tsx/esm", "esmock"],
"extensions": ["ts"],
"spec": [
"test/**/*.ts"
]
}

2
LICENSE
View File

@ -1,6 +1,6 @@
MIT License
Copyright (c) 2019 Todd Bluhm
Copyright (c) Todd Bluhm
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

3
bin/env-cmd.js
View File

@ -1,2 +1,3 @@
#! /usr/bin/env node
require('../dist').CLI(process.argv.slice(2))
import { CLI } from '../dist/index.js'
CLI(process.argv.slice(2))

8
dist/cli.d.ts vendored Normal file
View File

@ -0,0 +1,8 @@
import type { Environment } from './types.ts';
/**
* Executes env - cmd using command line arguments
* @export
* @param {string[]} args Command line argument to pass in ['-f', './.env']
* @returns {Promise<Environment>}
*/
export declare function CLI(args: string[]): Promise<Environment>;

21
dist/cli.js vendored Normal file
View File

@ -0,0 +1,21 @@
import * as processLib from 'node:process';
import { EnvCmd } from './env-cmd.js';
import { parseArgs } from './parse-args.js';
/**
* Executes env - cmd using command line arguments
* @export
* @param {string[]} args Command line argument to pass in ['-f', './.env']
* @returns {Promise<Environment>}
*/
export async function CLI(args) {
// Parse the args from the command line
const parsedArgs = parseArgs(args);
// Run EnvCmd
try {
return await EnvCmd(parsedArgs);
}
catch (e) {
console.error(e);
return processLib.exit(1);
}
}

13
dist/env-cmd.d.ts vendored
View File

@ -1,17 +1,10 @@
import { EnvCmdOptions } from './types';
/**
* Executes env - cmd using command line arguments
* @export
* @param {string[]} args Command line argument to pass in ['-f', './.env']
* @returns {Promise<{ [key: string]: any }>}
*/
export declare function CLI(args: string[]): Promise<Record<string, any>>;
import type { EnvCmdOptions, Environment } from './types.ts';
/**
* The main env-cmd program. This will spawn a new process and run the given command using
* various environment file solutions.
*
* @export
* @param {EnvCmdOptions} { command, commandArgs, envFile, rc, options }
* @returns {Promise<{ [key: string]: any }>} Returns an object containing [environment variable name]: value
* @returns {Promise<Environment>} Returns an object containing [environment variable name]: value
*/
export declare function EnvCmd({ command, commandArgs, envFile, rc, options }: EnvCmdOptions): Promise<Record<string, any>>;
export declare function EnvCmd({ command, commandArgs, envFile, rc, options, }: EnvCmdOptions): Promise<Environment>;

55
dist/env-cmd.js vendored
View File

@ -1,70 +1,47 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const spawn_1 = require("./spawn");
const signal_termination_1 = require("./signal-termination");
const parse_args_1 = require("./parse-args");
const get_env_vars_1 = require("./get-env-vars");
const expand_envs_1 = require("./expand-envs");
/**
* Executes env - cmd using command line arguments
* @export
* @param {string[]} args Command line argument to pass in ['-f', './.env']
* @returns {Promise<{ [key: string]: any }>}
*/
async function CLI(args) {
// Parse the args from the command line
const parsedArgs = parse_args_1.parseArgs(args);
// Run EnvCmd
try {
return await exports.EnvCmd(parsedArgs);
}
catch (e) {
console.error(e);
return process.exit(1);
}
}
exports.CLI = CLI;
import { default as spawn } from 'cross-spawn';
import { TermSignals } from './signal-termination.js';
import { getEnvVars } from './get-env-vars.js';
import { expandEnvs } from './expand-envs.js';
import * as processLib from 'node:process';
/**
* The main env-cmd program. This will spawn a new process and run the given command using
* various environment file solutions.
*
* @export
* @param {EnvCmdOptions} { command, commandArgs, envFile, rc, options }
* @returns {Promise<{ [key: string]: any }>} Returns an object containing [environment variable name]: value
* @returns {Promise<Environment>} Returns an object containing [environment variable name]: value
*/
async function EnvCmd({ command, commandArgs, envFile, rc, options = {} }) {
var _a;
export async function EnvCmd({ command, commandArgs, envFile, rc, options = {}, }) {
let env = {};
try {
env = await get_env_vars_1.getEnvVars({ envFile, rc, verbose: options.verbose });
env = await getEnvVars({ envFile, rc, verbose: options.verbose });
}
catch (e) {
if (!((_a = options.silent) !== null && _a !== void 0 ? _a : false)) {
if (!(options.silent ?? false)) {
throw e;
}
}
// Override the merge order if --no-override flag set
if (options.noOverride === true) {
env = Object.assign({}, env, process.env);
env = Object.assign({}, env, processLib.env);
}
else {
// Add in the system environment variables to our environment list
env = Object.assign({}, process.env, env);
env = Object.assign({}, processLib.env, env);
}
if (options.expandEnvs === true) {
command = expand_envs_1.expandEnvs(command, env);
commandArgs = commandArgs.map(arg => expand_envs_1.expandEnvs(arg, env));
command = expandEnvs(command, env);
commandArgs = commandArgs.map(arg => expandEnvs(arg, env));
}
// Execute the command with the given environment variables
const proc = spawn_1.spawn(command, commandArgs, {
const proc = spawn(command, commandArgs, {
stdio: 'inherit',
shell: options.useShell,
env
env: env,
});
// Handle any termination signals for parent and child proceses
const signals = new signal_termination_1.TermSignals({ verbose: options.verbose });
const signals = new TermSignals({ verbose: options.verbose });
signals.handleUncaughtExceptions();
signals.handleTermSignals(proc);
return env;
}
exports.EnvCmd = EnvCmd;

5
dist/expand-envs.d.ts vendored
View File

@ -1,5 +1,6 @@
import type { Environment } from './types.ts';
/**
* expandEnvs Replaces $var in args and command with environment variables
* the environment variable doesn't exist, it leaves it as is.
* if the environment variable doesn't exist, it leaves it as is.
*/
export declare function expandEnvs(str: string, envs: Record<string, any>): string;
export declare function expandEnvs(str: string, envs: Environment): string;

12
dist/expand-envs.js vendored
View File

@ -1,13 +1,11 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
/**
* expandEnvs Replaces $var in args and command with environment variables
* the environment variable doesn't exist, it leaves it as is.
* if the environment variable doesn't exist, it leaves it as is.
*/
function expandEnvs(str, envs) {
return str.replace(/(?<!\\)\$[a-zA-Z0-9_]+/g, varName => {
export function expandEnvs(str, envs) {
return str.replace(/(?<!\\)\$[a-zA-Z0-9_]+/g, (varName) => {
const varValue = envs[varName.slice(1)];
return varValue === undefined ? varName : varValue;
// const test = 42;
return varValue === undefined ? varName : varValue.toString();
});
}
exports.expandEnvs = expandEnvs;

8
dist/get-env-vars.d.ts vendored
View File

@ -1,12 +1,12 @@
import { GetEnvVarOptions } from './types';
export declare function getEnvVars(options?: GetEnvVarOptions): Promise<Record<string, any>>;
import type { GetEnvVarOptions, Environment } from './types.ts';
export declare function getEnvVars(options?: GetEnvVarOptions): Promise<Environment>;
export declare function getEnvFile({ filePath, fallback, verbose }: {
filePath?: string;
fallback?: boolean;
verbose?: boolean;
}): Promise<Record<string, any>>;
}): Promise<Environment>;
export declare function getRCFile({ environments, filePath, verbose }: {
environments: string[];
filePath?: string;
verbose?: boolean;
}): Promise<Record<string, any>>;
}): Promise<Environment>;

70
dist/get-env-vars.js vendored
View File

@ -1,40 +1,38 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const parse_rc_file_1 = require("./parse-rc-file");
const parse_env_file_1 = require("./parse-env-file");
import { getRCFileVars } from './parse-rc-file.js';
import { getEnvFileVars } from './parse-env-file.js';
const RC_FILE_DEFAULT_LOCATIONS = ['./.env-cmdrc', './.env-cmdrc.js', './.env-cmdrc.json'];
const ENV_FILE_DEFAULT_LOCATIONS = ['./.env', './.env.js', './.env.json'];
async function getEnvVars(options = {}) {
options.envFile = options.envFile !== undefined ? options.envFile : {};
export async function getEnvVars(options = {}) {
options.envFile = options.envFile ?? {};
// Check for rc file usage
if (options.rc !== undefined) {
return await getRCFile({
environments: options.rc.environments,
filePath: options.rc.filePath,
verbose: options.verbose
verbose: options.verbose,
});
}
return await getEnvFile({
filePath: options.envFile.filePath,
fallback: options.envFile.fallback,
verbose: options.verbose
verbose: options.verbose,
});
}
exports.getEnvVars = getEnvVars;
async function getEnvFile({ filePath, fallback, verbose }) {
export async function getEnvFile({ filePath, fallback, verbose }) {
// Use env file
if (filePath !== undefined) {
try {
const env = await parse_env_file_1.getEnvFileVars(filePath);
const env = await getEnvFileVars(filePath);
if (verbose === true) {
console.info(`Found .env file at path: ${filePath}`);
}
return env;
}
catch (e) {
catch {
if (verbose === true) {
console.info(`Failed to find .env file at path: ${filePath}`);
}
// Ignore error as we are just trying this location
}
if (fallback !== true) {
throw new Error(`Failed to find .env file at path: ${filePath}`);
@ -43,13 +41,15 @@ async function getEnvFile({ filePath, fallback, verbose }) {
// Use the default env file locations
for (const path of ENV_FILE_DEFAULT_LOCATIONS) {
try {
const env = await parse_env_file_1.getEnvFileVars(path);
const env = await getEnvFileVars(path);
if (verbose === true) {
console.info(`Found .env file at default path: ${path}`);
}
return env;
}
catch (e) { }
catch {
// Ignore error because we are just trying this location
}
}
const error = `Failed to find .env file at default paths: [${ENV_FILE_DEFAULT_LOCATIONS.join(',')}]`;
if (verbose === true) {
@ -57,26 +57,27 @@ async function getEnvFile({ filePath, fallback, verbose }) {
}
throw new Error(error);
}
exports.getEnvFile = getEnvFile;
async function getRCFile({ environments, filePath, verbose }) {
export async function getRCFile({ environments, filePath, verbose }) {
// User provided an .rc file path
if (filePath !== undefined) {
try {
const env = await parse_rc_file_1.getRCFileVars({ environments, filePath });
const env = await getRCFileVars({ environments, filePath });
if (verbose === true) {
console.info(`Found environments: [${environments.join(',')}] for .rc file at path: ${filePath}`);
}
return env;
}
catch (e) {
if (e.name === 'PathError') {
if (verbose === true) {
console.info(`Failed to find .rc file at path: ${filePath}`);
if (e instanceof Error) {
if (e.name === 'PathError') {
if (verbose === true) {
console.info(`Failed to find .rc file at path: ${filePath}`);
}
}
}
if (e.name === 'EnvironmentError') {
if (verbose === true) {
console.info(`Failed to find environments: [${environments.join(',')}] for .rc file at path: ${filePath}`);
if (e.name === 'EnvironmentError') {
if (verbose === true) {
console.info(`Failed to find environments: [${environments.join(',')}] for .rc file at path: ${filePath}`);
}
}
}
throw e;
@ -85,19 +86,27 @@ async function getRCFile({ environments, filePath, verbose }) {
// Use the default .rc file locations
for (const path of RC_FILE_DEFAULT_LOCATIONS) {
try {
const env = await parse_rc_file_1.getRCFileVars({ environments, filePath: path });
const env = await getRCFileVars({ environments, filePath: path });
if (verbose === true) {
console.info(`Found environments: [${environments.join(',')}] for default .rc file at path: ${path}`);
}
return env;
}
catch (e) {
if (e.name === 'EnvironmentError') {
const errorText = `Failed to find environments: [${environments.join(',')}] for .rc file at path: ${path}`;
if (verbose === true) {
console.info(errorText);
if (e instanceof Error) {
if (e.name === 'EnvironmentError') {
const errorText = `Failed to find environments: [${environments.join(',')}] for .rc file at path: ${path}`;
if (verbose === true) {
console.info(errorText);
}
throw new Error(errorText);
}
if (e.name === 'ParseError') {
if (verbose === true) {
console.info(e.message);
}
throw new Error(e.message);
}
throw new Error(errorText);
}
}
}
@ -107,4 +116,3 @@ async function getRCFile({ environments, filePath, verbose }) {
}
throw new Error(errorText);
}
exports.getRCFile = getRCFile;

7
dist/index.d.ts vendored
View File

@ -1,4 +1,5 @@
import { getEnvVars } from './get-env-vars';
export * from './types';
export * from './env-cmd';
import { getEnvVars } from './get-env-vars.js';
export * from './types.js';
export * from './cli.js';
export * from './env-cmd.js';
export declare const GetEnvVars: typeof getEnvVars;

14
dist/index.js vendored
View File

@ -1,8 +1,6 @@
"use strict";
function __export(m) {
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
}
Object.defineProperty(exports, "__esModule", { value: true });
const get_env_vars_1 = require("./get-env-vars");
__export(require("./env-cmd"));
exports.GetEnvVars = get_env_vars_1.getEnvVars;
import { getEnvVars } from './get-env-vars.js';
// Export the core env-cmd API
export * from './types.js';
export * from './cli.js';
export * from './env-cmd.js';
export const GetEnvVars = getEnvVars;

5
dist/parse-args.d.ts vendored
View File

@ -1,7 +1,6 @@
import * as commander from 'commander';
import { EnvCmdOptions } from './types';
import type { EnvCmdOptions, CommanderOptions } from './types.ts';
/**
* Parses the arguments passed into the cli
*/
export declare function parseArgs(args: string[]): EnvCmdOptions;
export declare function parseArgsUsingCommander(args: string[]): commander.Command;
export declare function parseArgsUsingCommander(args: string[]): CommanderOptions;

29
dist/parse-args.js vendored
View File

@ -1,13 +1,10 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const commander = require("commander");
const utils_1 = require("./utils");
// Use commonjs require to prevent a weird folder hierarchy in dist
const packageJson = require('../package.json');
import * as commander from 'commander';
import { parseArgList } from './utils.js';
import { default as packageJson } from '../package.json' with { type: 'json' };
/**
* Parses the arguments passed into the cli
*/
function parseArgs(args) {
export function parseArgs(args) {
// Run the initial arguments through commander in order to determine
// which value in the args array is the `command` to execute
let program = parseArgsUsingCommander(args);
@ -39,17 +36,19 @@ function parseArgs(args) {
silent = true;
}
let rc;
if (program.environments !== undefined && program.environments.length !== 0) {
if (program.environments !== undefined
&& Array.isArray(program.environments)
&& program.environments.length !== 0) {
rc = {
environments: program.environments,
filePath: program.rcFile
filePath: program.rcFile,
};
}
let envFile;
if (program.file !== undefined) {
envFile = {
filePath: program.file,
fallback: program.fallback
fallback: program.fallback,
};
}
const options = {
@ -62,21 +61,20 @@ function parseArgs(args) {
noOverride,
silent,
useShell,
verbose
}
verbose,
},
};
if (verbose) {
console.info(`Options: ${JSON.stringify(options, null, 0)}`);
}
return options;
}
exports.parseArgs = parseArgs;
function parseArgsUsingCommander(args) {
export function parseArgsUsingCommander(args) {
const program = new commander.Command();
return program
.version(packageJson.version, '-v, --version')
.usage('[options] <command> [...args]')
.option('-e, --environments [env1,env2,...]', 'The rc file environment(s) to use', utils_1.parseArgList)
.option('-e, --environments [env1,env2,...]', 'The rc file environment(s) to use', parseArgList)
.option('-f, --file [path]', 'Custom env file path (default path: ./.env)')
.option('--fallback', 'Fallback to default env file path, if custom env file path not found')
.option('--no-override', 'Do not override existing environment variables')
@ -88,4 +86,3 @@ function parseArgsUsingCommander(args) {
.allowUnknownOption(true)
.parse(['_', '_', ...args]);
}
exports.parseArgsUsingCommander = parseArgsUsingCommander;

7
dist/parse-env-file.d.ts vendored
View File

@ -1,15 +1,16 @@
import type { Environment } from './types.ts';
/**
* Gets the environment vars from an env file
*/
export declare function getEnvFileVars(envFilePath: string): Promise<Record<string, any>>;
export declare function getEnvFileVars(envFilePath: string): Promise<Environment>;
/**
* Parse out all env vars from a given env file string and return an object
*/
export declare function parseEnvString(envFileString: string): Record<string, string>;
export declare function parseEnvString(envFileString: string): Environment;
/**
* Parse out all env vars from an env file string
*/
export declare function parseEnvVars(envString: string): Record<string, string>;
export declare function parseEnvVars(envString: string): Environment;
/**
* Strips out comments from env file string
*/

72
dist/parse-env-file.js vendored
View File

@ -1,37 +1,48 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const fs = require("fs");
const path = require("path");
const utils_1 = require("./utils");
const REQUIRE_HOOK_EXTENSIONS = ['.json', '.js', '.cjs'];
import { existsSync, readFileSync } from 'node:fs';
import { extname } from 'node:path';
import { pathToFileURL } from 'node:url';
import { resolveEnvFilePath, IMPORT_HOOK_EXTENSIONS, isPromise } from './utils.js';
/**
* Gets the environment vars from an env file
*/
async function getEnvFileVars(envFilePath) {
const absolutePath = utils_1.resolveEnvFilePath(envFilePath);
if (!fs.existsSync(absolutePath)) {
export async function getEnvFileVars(envFilePath) {
const absolutePath = resolveEnvFilePath(envFilePath);
if (!existsSync(absolutePath)) {
const pathError = new Error(`Invalid env file path (${envFilePath}).`);
pathError.name = 'PathError';
throw pathError;
}
// Get the file extension
const ext = path.extname(absolutePath).toLowerCase();
const ext = extname(absolutePath).toLowerCase();
let env = {};
if (REQUIRE_HOOK_EXTENSIONS.includes(ext)) {
const possiblePromise = require(absolutePath);
env = utils_1.isPromise(possiblePromise) ? await possiblePromise : possiblePromise;
if (IMPORT_HOOK_EXTENSIONS.includes(ext)) {
// For some reason in ES Modules, only JSON file types need to be specifically delinated when importing them
let attributeTypes = {};
if (ext === '.json') {
attributeTypes = { with: { type: 'json' } };
}
const res = await import(pathToFileURL(absolutePath).href, attributeTypes);
if ('default' in res) {
env = res.default;
}
else {
env = res;
}
// Check to see if the imported value is a promise
if (isPromise(env)) {
env = await env;
}
}
else {
const file = fs.readFileSync(absolutePath, { encoding: 'utf8' });
const file = readFileSync(absolutePath, { encoding: 'utf8' });
env = parseEnvString(file);
}
return env;
}
exports.getEnvFileVars = getEnvFileVars;
/**
* Parse out all env vars from a given env file string and return an object
*/
function parseEnvString(envFileString) {
export function parseEnvString(envFileString) {
// First thing we do is stripe out all comments
envFileString = stripComments(envFileString.toString());
// Next we stripe out all the empty lines
@ -39,30 +50,41 @@ function parseEnvString(envFileString) {
// Merge the file env vars with the current process env vars (the file vars overwrite process vars)
return parseEnvVars(envFileString);
}
exports.parseEnvString = parseEnvString;
/**
* Parse out all env vars from an env file string
*/
function parseEnvVars(envString) {
export function parseEnvVars(envString) {
const envParseRegex = /^((.+?)[=](.*))$/gim;
const matches = {};
let match;
while ((match = envParseRegex.exec(envString)) !== null) {
// Note: match[1] is the full env=var line
const key = match[2].trim();
const value = match[3].trim();
let value = match[3].trim();
// remove any surrounding quotes
matches[key] = value
value = value
.replace(/(^['"]|['"]$)/g, '')
.replace(/\\n/g, '\n');
// Convert string to JS type if appropriate
if (value !== '' && !isNaN(+value)) {
matches[key] = +value;
}
else if (value === 'true') {
matches[key] = true;
}
else if (value === 'false') {
matches[key] = false;
}
else {
matches[key] = value;
}
}
return matches;
return JSON.parse(JSON.stringify(matches));
}
exports.parseEnvVars = parseEnvVars;
/**
* Strips out comments from env file string
*/
function stripComments(envString) {
export function stripComments(envString) {
const commentsRegex = /(^#.*$)/gim;
let match = commentsRegex.exec(envString);
let newString = envString;
@ -72,12 +94,10 @@ function stripComments(envString) {
}
return newString;
}
exports.stripComments = stripComments;
/**
* Strips out newlines from env file string
*/
function stripEmptyLines(envString) {
export function stripEmptyLines(envString) {
const emptyLinesRegex = /(^\n)/gim;
return envString.replace(emptyLinesRegex, '');
}
exports.stripEmptyLines = stripEmptyLines;

3
dist/parse-rc-file.d.ts vendored
View File

@ -1,7 +1,8 @@
import type { Environment } from './types.ts';
/**
* Gets the env vars from the rc file and rc environments
*/
export declare function getRCFileVars({ environments, filePath }: {
environments: string[];
filePath: string;
}): Promise<Record<string, any>>;
}): Promise<Environment>;

66
dist/parse-rc-file.js vendored
View File

@ -1,31 +1,44 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const fs_1 = require("fs");
const util_1 = require("util");
const path_1 = require("path");
const utils_1 = require("./utils");
const statAsync = util_1.promisify(fs_1.stat);
const readFileAsync = util_1.promisify(fs_1.readFile);
import { stat, readFile } from 'node:fs';
import { promisify } from 'node:util';
import { extname } from 'node:path';
import { pathToFileURL } from 'node:url';
import { resolveEnvFilePath, IMPORT_HOOK_EXTENSIONS, isPromise } from './utils.js';
const statAsync = promisify(stat);
const readFileAsync = promisify(readFile);
/**
* Gets the env vars from the rc file and rc environments
*/
async function getRCFileVars({ environments, filePath }) {
const absolutePath = utils_1.resolveEnvFilePath(filePath);
export async function getRCFileVars({ environments, filePath }) {
const absolutePath = resolveEnvFilePath(filePath);
try {
await statAsync(absolutePath);
}
catch (e) {
catch {
const pathError = new Error(`Failed to find .rc file at path: ${absolutePath}`);
pathError.name = 'PathError';
throw pathError;
}
// Get the file extension
const ext = path_1.extname(absolutePath).toLowerCase();
let parsedData;
const ext = extname(absolutePath).toLowerCase();
let parsedData = {};
try {
if (ext === '.json' || ext === '.js' || ext === '.cjs') {
const possiblePromise = require(absolutePath);
parsedData = utils_1.isPromise(possiblePromise) ? await possiblePromise : possiblePromise;
if (IMPORT_HOOK_EXTENSIONS.includes(ext)) {
// For some reason in ES Modules, only JSON file types need to be specifically delinated when importing them
let attributeTypes = {};
if (ext === '.json') {
attributeTypes = { with: { type: 'json' } };
}
const res = await import(pathToFileURL(absolutePath).href, attributeTypes);
if ('default' in res) {
parsedData = res.default;
}
else {
parsedData = res;
}
// Check to see if the imported value is a promise
if (isPromise(parsedData)) {
parsedData = await parsedData;
}
}
else {
const file = await readFileAsync(absolutePath, { encoding: 'utf8' });
@ -33,20 +46,26 @@ async function getRCFileVars({ environments, filePath }) {
}
}
catch (e) {
const parseError = new Error(`Failed to parse .rc file at path: ${absolutePath}`);
const errorMessage = e instanceof Error ? e.message : 'Unknown error';
const parseError = new Error(`Failed to parse .rc file at path: ${absolutePath}.\n${errorMessage}`);
parseError.name = 'ParseError';
throw parseError;
}
// Parse and merge multiple rc environments together
let result = {};
let environmentFound = false;
environments.forEach((name) => {
const envVars = parsedData[name];
if (envVars !== undefined) {
environmentFound = true;
result = Object.assign(Object.assign({}, result), envVars);
for (const name of environments) {
if (name in parsedData) {
const envVars = parsedData[name];
if (envVars != null && typeof envVars === 'object') {
environmentFound = true;
result = {
...result,
...envVars,
};
}
}
});
}
if (!environmentFound) {
const environmentError = new Error(`Failed to find environments [${environments.join(',')}] at .rc file location: ${absolutePath}`);
environmentError.name = 'EnvironmentError';
@ -54,4 +73,3 @@ async function getRCFileVars({ environments, filePath }) {
}
return result;
}
exports.getRCFileVars = getRCFileVars;

4
dist/signal-termination.d.ts vendored
View File

@ -1,7 +1,7 @@
/// <reference types="node" />
import { ChildProcess } from 'child_process';
export declare class TermSignals {
private readonly terminateSpawnedProcessFuncHandlers;
private terminateSpawnedProcessFuncExitHandler?;
private readonly verbose;
_exitCalled: boolean;
constructor(options?: {
@ -15,7 +15,7 @@ export declare class TermSignals {
/**
* Terminate parent process helper
*/
_terminateProcess(code?: number, signal?: NodeJS.Signals): void;
_terminateProcess(signal?: NodeJS.Signals | number): void;
/**
* Exit event listener clean up helper
*/

111
dist/signal-termination.js vendored
View File

@ -1,73 +1,73 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const SIGNALS_TO_HANDLE = [
'SIGINT', 'SIGTERM', 'SIGHUP'
'SIGINT', 'SIGTERM', 'SIGHUP',
];
class TermSignals {
export class TermSignals {
terminateSpawnedProcessFuncHandlers = {};
terminateSpawnedProcessFuncExitHandler;
verbose = false;
_exitCalled = false;
constructor(options = {}) {
this.terminateSpawnedProcessFuncHandlers = {};
this.verbose = false;
this._exitCalled = false;
this.verbose = options.verbose === true;
}
handleTermSignals(proc) {
// Terminate child process if parent process receives termination events
SIGNALS_TO_HANDLE.forEach((signal) => {
this.terminateSpawnedProcessFuncHandlers[signal] =
(signal, code) => {
this._removeProcessListeners();
if (!this._exitCalled) {
if (this.verbose) {
console.info('Parent process exited with signal: ' +
signal.toString() +
'. Terminating child process...');
}
// Mark shared state so we do not run into a signal/exit loop
this._exitCalled = true;
// Use the signal code if it is an error code
let correctSignal;
if (typeof signal === 'number') {
if (signal > (code !== null && code !== void 0 ? code : 0)) {
code = signal;
correctSignal = 'SIGINT';
}
}
else {
correctSignal = signal;
}
// Kill the child process
proc.kill(correctSignal !== null && correctSignal !== void 0 ? correctSignal : code);
// Terminate the parent process
this._terminateProcess(code, correctSignal);
const terminationFunc = (signal) => {
this._removeProcessListeners();
if (!this._exitCalled) {
if (this.verbose) {
console.info('Parent process exited with signal: '
+ signal.toString()
+ '. Terminating child process...');
}
// Mark shared state so we do not run into a signal/exit loop
this._exitCalled = true;
// Use the signal code if it is an error code
// let correctSignal: NodeJS.Signals | undefined
if (typeof signal === 'number') {
if (signal > 0) {
// code = signal
signal = 'SIGINT';
}
};
}
// else {
// correctSignal = signal
// }
// Kill the child process
proc.kill(signal);
// Terminate the parent process
this._terminateProcess(signal);
}
};
for (const signal of SIGNALS_TO_HANDLE) {
this.terminateSpawnedProcessFuncHandlers[signal] = terminationFunc;
process.once(signal, this.terminateSpawnedProcessFuncHandlers[signal]);
});
process.once('exit', this.terminateSpawnedProcessFuncHandlers.SIGTERM);
}
this.terminateSpawnedProcessFuncExitHandler = terminationFunc;
process.once('exit', this.terminateSpawnedProcessFuncExitHandler);
// Terminate parent process if child process receives termination events
proc.on('exit', (code, signal) => {
this._removeProcessListeners();
if (!this._exitCalled) {
if (this.verbose) {
console.info(`Child process exited with code: ${(code !== null && code !== void 0 ? code : '').toString()} and signal:` +
(signal !== null && signal !== void 0 ? signal : '').toString() +
'. Terminating parent process...');
console.info(`Child process exited with code: ${(code ?? '').toString()} and signal:`
+ (signal ?? '').toString()
+ '. Terminating parent process...');
}
// Mark shared state so we do not run into a signal/exit loop
this._exitCalled = true;
// Use the signal code if it is an error code
let correctSignal;
if (typeof signal === 'number') {
if (signal > (code !== null && code !== void 0 ? code : 0)) {
if (signal > (code ?? 0)) {
code = signal;
correctSignal = 'SIGINT';
}
}
else {
correctSignal = signal !== null && signal !== void 0 ? signal : undefined;
correctSignal = signal ?? undefined;
}
// Terminate the parent process
this._terminateProcess(code, correctSignal);
this._terminateProcess(correctSignal ?? code);
}
});
}
@ -75,17 +75,23 @@ class TermSignals {
* Enables catching of unhandled exceptions
*/
handleUncaughtExceptions() {
process.on('uncaughtException', (e) => this._uncaughtExceptionHandler(e));
process.on('uncaughtException', (e) => {
this._uncaughtExceptionHandler(e);
});
}
/**
* Terminate parent process helper
*/
_terminateProcess(code, signal) {
if (signal !== undefined) {
return process.kill(process.pid, signal);
}
if (code !== undefined) {
return process.exit(code);
_terminateProcess(signal) {
if (signal != null) {
if (typeof signal === 'string') {
process.kill(process.pid, signal);
return;
}
if (typeof signal === 'number') {
process.exit(signal);
return;
}
}
throw new Error('Unable to terminate parent process successfully');
}
@ -96,7 +102,9 @@ class TermSignals {
SIGNALS_TO_HANDLE.forEach((signal) => {
process.removeListener(signal, this.terminateSpawnedProcessFuncHandlers[signal]);
});
process.removeListener('exit', this.terminateSpawnedProcessFuncHandlers.SIGTERM);
if (this.terminateSpawnedProcessFuncExitHandler != null) {
process.removeListener('exit', this.terminateSpawnedProcessFuncExitHandler);
}
}
/**
* General exception handler
@ -106,4 +114,3 @@ class TermSignals {
process.exit(1);
}
}
exports.TermSignals = TermSignals;

2
dist/spawn.d.ts vendored
View File

@ -1,2 +0,0 @@
import * as spawn from 'cross-spawn';
export { spawn };

4
dist/spawn.js vendored
View File

@ -1,4 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const spawn = require("cross-spawn");
exports.spawn = spawn;

34
dist/types.d.ts vendored
View File

@ -1,15 +1,31 @@
import { Command } from 'commander';
export type Environment = Partial<Record<string, string | number | boolean>>;
export type RCEnvironment = Partial<Record<string, Environment>>;
export interface CommanderOptions extends Command {
override?: boolean;
useShell?: boolean;
expandEnvs?: boolean;
verbose?: boolean;
silent?: boolean;
fallback?: boolean;
environments?: string[];
rcFile?: string;
file?: string;
}
export interface RCFileOptions {
environments: string[];
filePath?: string;
}
export interface EnvFileOptions {
filePath?: string;
fallback?: boolean;
}
export interface GetEnvVarOptions {
envFile?: {
filePath?: string;
fallback?: boolean;
};
rc?: {
environments: string[];
filePath?: string;
};
envFile?: EnvFileOptions;
rc?: RCFileOptions;
verbose?: boolean;
}
export interface EnvCmdOptions extends Pick<GetEnvVarOptions, 'envFile' | 'rc'> {
export interface EnvCmdOptions extends GetEnvVarOptions {
command: string;
commandArgs: string[];
options?: {

3
dist/types.js vendored
View File

@ -1,2 +1 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
export {};

5
dist/utils.d.ts vendored
View File

@ -1,3 +1,4 @@
export declare const IMPORT_HOOK_EXTENSIONS: string[];
/**
* A simple function for resolving the path the user entered
*/
@ -7,6 +8,6 @@ export declare function resolveEnvFilePath(userPath: string): string;
*/
export declare function parseArgList(list: string): string[];
/**
* A simple function to test if the value is a promise
* A simple function to test if the value is a promise/thenable
*/
export declare function isPromise(value: any | PromiseLike<object>): value is Promise<any>;
export declare function isPromise<T>(value?: T | PromiseLike<T>): value is PromiseLike<T>;

31
dist/utils.js vendored
View File

@ -1,30 +1,31 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const path = require("path");
const os = require("os");
import { resolve } from 'node:path';
import { homedir } from 'node:os';
import { cwd } from 'node:process';
// Special file extensions that node can natively import
export const IMPORT_HOOK_EXTENSIONS = ['.json', '.js', '.cjs', '.mjs'];
/**
* A simple function for resolving the path the user entered
*/
function resolveEnvFilePath(userPath) {
export function resolveEnvFilePath(userPath) {
// Make sure a home directory exist
const home = os.homedir();
if (home !== undefined) {
const home = homedir();
if (home != null) {
userPath = userPath.replace(/^~($|\/|\\)/, `${home}$1`);
}
return path.resolve(process.cwd(), userPath);
return resolve(cwd(), userPath);
}
exports.resolveEnvFilePath = resolveEnvFilePath;
/**
* A simple function that parses a comma separated string into an array of strings
*/
function parseArgList(list) {
export function parseArgList(list) {
return list.split(',');
}
exports.parseArgList = parseArgList;
/**
* A simple function to test if the value is a promise
* A simple function to test if the value is a promise/thenable
*/
function isPromise(value) {
return value != null && typeof value.then === 'function';
export function isPromise(value) {
return value != null
&& typeof value === 'object'
&& 'then' in value
&& typeof value.then === 'function';
}
exports.isPromise = isPromise;

47
eslint.config.js
View File

@ -1,43 +1,38 @@
const eslint = require('@eslint/js')
const tseslint = require('typescript-eslint')
const globals = require('globals')
const stylistic = require('@stylistic/eslint-plugin')
import { default as tseslint } from 'typescript-eslint'
import { default as globals } from 'globals'
import { default as eslint } from '@eslint/js'
module.exports = tseslint.config(
export default tseslint.config(
{
ignores: ['dist/*', 'bin/*'],
rules: {
'@typescript-eslint/no-require-imports': 'off',
},
// Ignore build folder
ignores: ['dist/*'],
},
eslint.configs.recommended,
tseslint.configs.strictTypeChecked,
tseslint.configs.stylisticTypeChecked,
{
// Enable Type generation
languageOptions: {
globals: {
...globals.node,
},
parserOptions: {
projectService: {
allowDefaultProject: ['test/*.ts'],
},
project: ['./tsconfig.json', './test/tsconfig.json'],
},
},
extends: [
eslint.configs.recommended,
stylistic.configs['recommended-flat'],
tseslint.configs.strictTypeChecked,
tseslint.configs.stylisticTypeChecked,
],
},
// Disable Type Checking JS files
{
files: ['**/*.js'],
extends: [tseslint.configs.disableTypeChecked],
}
},
{
// For test files ignore some rules
files: ['test/*.ts'],
files: ['test/**/*'],
rules: {
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/no-unsafe-member-access': 'off',
'@typescript-eslint/no-unsafe-assignment': 'off',
'@typescript-eslint/no-unsafe-assignment': 'off'
},
},
// Disable Type Checking JS/CJS/MJS files
{
files: ['**/*.js', '**/*.cjs', '**/*.mjs'],
extends: [tseslint.configs.disableTypeChecked],
},
)

26
eslint.config.js.test
View File

@ -1,26 +0,0 @@
module.exports = (async function config() {
const { default: love } = await import('eslint-config-love')
return [
love,
{
files: [
'src/**/*.[j|t]s',
// 'src/**/*.ts',
'test/**/*.[j|t]s',
// 'test/**/*.ts'
],
languageOptions: {
parserOptions: {
projectService: {
allowDefaultProject: ['eslint.config.js', 'bin/env-cmd.js'],
defaultProject: './tsconfig.json',
},
},
},
},
{
ignores: ['dist/'],
}
]
})()

64
package.json
View File

@ -4,16 +4,17 @@
"description": "Executes a command using the environment variables in an env file",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"type": "module",
"engines": {
"node": ">=8.0.0"
"node": ">=18.0.0"
},
"bin": {
"env-cmd": "bin/env-cmd.js"
},
"scripts": {
"prepare": "husky",
"test": "mocha -r ts-node/register ./test/**/*.ts",
"test-cover": "nyc npm test",
"test": "mocha",
"test-cover": "c8 npm test",
"coveralls": "coveralls < coverage/lcov.info",
"lint": "npx eslint .",
"build": "tsc",
@ -54,58 +55,33 @@
"devDependencies": {
"@commitlint/cli": "^19.6.0",
"@commitlint/config-conventional": "^19.6.0",
"@eslint/js": "^9.15.0",
"@stylistic/eslint-plugin": "^2.11.0",
"@types/chai": "^4.0.0",
"@types/cross-spawn": "^6.0.0",
"@types/mocha": "^7.0.0",
"@types/node": "^12.0.0",
"@eslint/js": "^9.16.0",
"@types/chai": "^5.0.1",
"@types/cross-spawn": "^6.0.6",
"@types/mocha": "^10.0.10",
"@types/node": "^22.10.1",
"@types/sinon": "^17.0.3",
"chai": "^4.0.0",
"c8": "^10.1.2",
"chai": "^5.1.2",
"coveralls": "^3.0.0",
"esmock": "^2.6.9",
"globals": "^15.12.0",
"husky": "^9.1.7",
"mocha": "^10.8.2",
"nyc": "^17.1.0",
"mocha": "^11.0.0",
"sinon": "^19.0.2",
"ts-node": "^8.0.0",
"tsx": "^4.19.2",
"typescript": "^5.7.2",
"typescript-eslint": "^8.15.0"
},
"nyc": {
"include": [
"src/**/*.ts"
],
"extension": [
".ts"
],
"require": [
"ts-node/register"
],
"reporter": [
"text",
"lcov"
],
"sourceMap": true,
"instrument": true
},
"greenkeeper": {
"ignore": [
"@types/node"
],
"commitMessages": {
"initialBadge": "docs: add greenkeeper badge",
"initialDependencies": "chore: update dependencies",
"initialBranches": "chore: whitelist greenkeeper branches",
"dependencyUpdate": "chore: update dependency ${dependency}",
"devDependencyUpdate": "chore: update devDependecy ${dependency}",
"dependencyPin": "fix: pin dependency ${dependency}",
"devDependencyPin": "fix: pin devDependecy ${dependency}"
}
},
"commitlint": {
"extends": [
"@commitlint/config-conventional"
]
},
"c8": {
"reporter": [
"text",
"lcov"
]
}
}

25
src/cli.ts Normal file
View File

@ -0,0 +1,25 @@
import * as processLib from 'node:process'
import type { Environment } from './types.ts'
import { EnvCmd } from './env-cmd.js'
import { parseArgs } from './parse-args.js'
/**
* Executes env - cmd using command line arguments
* @export
* @param {string[]} args Command line argument to pass in ['-f', './.env']
* @returns {Promise<Environment>}
*/
export async function CLI(args: string[]): Promise<Environment> {
// Parse the args from the command line
const parsedArgs = parseArgs(args)
// Run EnvCmd
try {
return await EnvCmd(parsedArgs)
}
catch (e) {
console.error(e)
return processLib.exit(1)
}
}

36
src/env-cmd.ts
View File

@ -1,29 +1,9 @@
import { spawn } from './spawn'
import { EnvCmdOptions, Environment } from './types'
import { TermSignals } from './signal-termination'
import { parseArgs } from './parse-args'
import { getEnvVars } from './get-env-vars'
import { expandEnvs } from './expand-envs'
/**
* Executes env - cmd using command line arguments
* @export
* @param {string[]} args Command line argument to pass in ['-f', './.env']
* @returns {Promise<Environment>}
*/
export async function CLI(args: string[]): Promise<Environment> {
// Parse the args from the command line
const parsedArgs = parseArgs(args)
// Run EnvCmd
try {
return await (exports as { EnvCmd: typeof EnvCmd }).EnvCmd(parsedArgs)
}
catch (e) {
console.error(e)
return process.exit(1)
}
}
import { default as spawn } from 'cross-spawn'
import type { EnvCmdOptions, Environment } from './types.ts'
import { TermSignals } from './signal-termination.js'
import { getEnvVars } from './get-env-vars.js'
import { expandEnvs } from './expand-envs.js'
import * as processLib from 'node:process'
/**
* The main env-cmd program. This will spawn a new process and run the given command using
@ -53,11 +33,11 @@ export async function EnvCmd(
}
// Override the merge order if --no-override flag set
if (options.noOverride === true) {
env = Object.assign({}, env, process.env)
env = Object.assign({}, env, processLib.env)
}
else {
// Add in the system environment variables to our environment list
env = Object.assign({}, process.env, env)
env = Object.assign({}, processLib.env, env)
}
if (options.expandEnvs === true) {

2
src/expand-envs.ts
View File

@ -1,4 +1,4 @@
import { Environment } from './types'
import type { Environment } from './types.ts'
/**
* expandEnvs Replaces $var in args and command with environment variables

6
src/get-env-vars.ts
View File

@ -1,6 +1,6 @@
import { GetEnvVarOptions, Environment } from './types'
import { getRCFileVars } from './parse-rc-file'
import { getEnvFileVars } from './parse-env-file'
import type { GetEnvVarOptions, Environment } from './types.ts'
import { getRCFileVars } from './parse-rc-file.js'
import { getEnvFileVars } from './parse-env-file.js'
const RC_FILE_DEFAULT_LOCATIONS = ['./.env-cmdrc', './.env-cmdrc.js', './.env-cmdrc.json']
const ENV_FILE_DEFAULT_LOCATIONS = ['./.env', './.env.js', './.env.json']

7
src/index.ts
View File

@ -1,6 +1,7 @@
import { getEnvVars } from './get-env-vars'
import { getEnvVars } from './get-env-vars.js'
// Export the core env-cmd API
export * from './types'
export * from './env-cmd'
export * from './types.js'
export * from './cli.js'
export * from './env-cmd.js'
export const GetEnvVars = getEnvVars

8
src/parse-args.ts
View File

@ -1,9 +1,7 @@
import * as commander from 'commander'
import { EnvCmdOptions, CommanderOptions, EnvFileOptions, RCFileOptions } from './types'
import { parseArgList } from './utils'
// Use commonjs require to prevent a weird folder hierarchy in dist
const packageJson: { version: string } = require('../package.json') /* eslint-disable-line */
import type { EnvCmdOptions, CommanderOptions, EnvFileOptions, RCFileOptions } from './types.ts'
import { parseArgList } from './utils.js'
import { default as packageJson } from '../package.json' with { type: 'json' };
/**
* Parses the arguments passed into the cli

36
src/parse-env-file.ts
View File

@ -1,30 +1,42 @@
import * as fs from 'fs'
import * as path from 'path'
import { resolveEnvFilePath, isPromise } from './utils'
import { Environment } from './types'
const REQUIRE_HOOK_EXTENSIONS = ['.json', '.js', '.cjs']
import { existsSync, readFileSync } from 'node:fs'
import { extname } from 'node:path'
import { pathToFileURL } from 'node:url'
import { resolveEnvFilePath, IMPORT_HOOK_EXTENSIONS, isPromise } from './utils.js'
import type { Environment } from './types.ts'
/**
* Gets the environment vars from an env file
*/
export async function getEnvFileVars(envFilePath: string): Promise<Environment> {
const absolutePath = resolveEnvFilePath(envFilePath)
if (!fs.existsSync(absolutePath)) {
if (!existsSync(absolutePath)) {
const pathError = new Error(`Invalid env file path (${envFilePath}).`)
pathError.name = 'PathError'
throw pathError
}
// Get the file extension
const ext = path.extname(absolutePath).toLowerCase()
const ext = extname(absolutePath).toLowerCase()
let env: Environment = {}
if (REQUIRE_HOOK_EXTENSIONS.includes(ext)) {
const possiblePromise: Environment | Promise<Environment> = require(absolutePath) /* eslint-disable-line */
env = isPromise(possiblePromise) ? await possiblePromise : possiblePromise
if (IMPORT_HOOK_EXTENSIONS.includes(ext)) {
// For some reason in ES Modules, only JSON file types need to be specifically delinated when importing them
let attributeTypes = {}
if (ext === '.json') {
attributeTypes = { with: { type: 'json' } }
}
const res = await import(pathToFileURL(absolutePath).href, attributeTypes) as Environment | { default: Environment }
if ('default' in res) {
env = res.default as Environment
} else {
env = res
}
// Check to see if the imported value is a promise
if (isPromise(env)) {
env = await env
}
}
else {
const file = fs.readFileSync(absolutePath, { encoding: 'utf8' })
const file = readFileSync(absolutePath, { encoding: 'utf8' })
env = parseEnvString(file)
}
return env

32
src/parse-rc-file.ts
View File

@ -1,8 +1,9 @@
import { stat, readFile } from 'fs'
import { promisify } from 'util'
import { extname } from 'path'
import { resolveEnvFilePath, isPromise } from './utils'
import { Environment, RCEnvironment } from './types'
import { stat, readFile } from 'node:fs'
import { promisify } from 'node:util'
import { extname } from 'node:path'
import { pathToFileURL } from 'node:url'
import { resolveEnvFilePath, IMPORT_HOOK_EXTENSIONS, isPromise } from './utils.js'
import type { Environment, RCEnvironment } from './types.ts'
const statAsync = promisify(stat)
const readFileAsync = promisify(readFile)
@ -26,11 +27,24 @@ export async function getRCFileVars(
// Get the file extension
const ext = extname(absolutePath).toLowerCase()
let parsedData: Partial<RCEnvironment>
let parsedData: Partial<RCEnvironment> = {}
try {
if (ext === '.json' || ext === '.js' || ext === '.cjs') {
const possiblePromise = require(absolutePath) as PromiseLike<RCEnvironment> | RCEnvironment
parsedData = isPromise(possiblePromise) ? await possiblePromise : possiblePromise
if (IMPORT_HOOK_EXTENSIONS.includes(ext)) {
// For some reason in ES Modules, only JSON file types need to be specifically delinated when importing them
let attributeTypes = {}
if (ext === '.json') {
attributeTypes = { with: { type: 'json' } }
}
const res = await import(pathToFileURL(absolutePath).href, attributeTypes) as RCEnvironment | { default: RCEnvironment }
if ('default' in res) {
parsedData = res.default as RCEnvironment
} else {
parsedData = res
}
// Check to see if the imported value is a promise
if (isPromise(parsedData)) {
parsedData = await parsedData
}
}
else {
const file = await readFileAsync(absolutePath, { encoding: 'utf8' })

4
src/spawn.ts
View File

@ -1,4 +0,0 @@
import * as spawn from 'cross-spawn'
export {
spawn,
}

12
src/utils.ts
View File

@ -1,16 +1,20 @@
import * as path from 'path'
import * as os from 'os'
import { resolve } from 'node:path'
import { homedir } from 'node:os'
import { cwd } from 'node:process'
// Special file extensions that node can natively import
export const IMPORT_HOOK_EXTENSIONS = ['.json', '.js', '.cjs', '.mjs']
/**
* A simple function for resolving the path the user entered
*/
export function resolveEnvFilePath(userPath: string): string {
// Make sure a home directory exist
const home = os.homedir() as string | undefined
const home = homedir() as string | undefined
if (home != null) {
userPath = userPath.replace(/^~($|\/|\\)/, `${home}$1`)
}
return path.resolve(process.cwd(), userPath)
return resolve(cwd(), userPath)
}
/**
* A simple function that parses a comma separated string into an array of strings

57
test/cli.spec.ts Normal file
View File

@ -0,0 +1,57 @@
import { default as sinon } from 'sinon'
import { assert } from 'chai'
import { default as esmock } from 'esmock'
import type { CLI } from '../src/cli.ts'
describe('CLI', (): void => {
let sandbox: sinon.SinonSandbox
let parseArgsStub: sinon.SinonStub<any>
let envCmdStub: sinon.SinonStub<any>
let processExitStub: sinon.SinonStub<any>
let cliLib: { CLI: typeof CLI }
before(async (): Promise<void> => {
sandbox = sinon.createSandbox()
envCmdStub = sandbox.stub()
parseArgsStub = sandbox.stub()
processExitStub = sandbox.stub()
cliLib = await esmock('../src/cli.ts', {
'../src/env-cmd': {
EnvCmd: envCmdStub,
},
'../src/parse-args': {
parseArgs: parseArgsStub,
},
'node:process': {
exit: processExitStub,
},
})
})
after((): void => {
sandbox.restore()
})
afterEach((): void => {
sandbox.resetHistory()
sandbox.resetBehavior()
})
it('should parse the provided args and execute the EnvCmd', async (): Promise<void> => {
parseArgsStub.returns({})
await cliLib.CLI(['node', './env-cmd', '-v'])
assert.equal(parseArgsStub.callCount, 1)
assert.equal(envCmdStub.callCount, 1)
assert.equal(processExitStub.callCount, 0)
})
it('should catch exception if EnvCmd throws an exception', async (): Promise<void> => {
parseArgsStub.returns({})
envCmdStub.throwsException('Error')
await cliLib.CLI(['node', './env-cmd', '-v'])
assert.equal(parseArgsStub.callCount, 1)
assert.equal(envCmdStub.callCount, 1)
assert.equal(processExitStub.callCount, 1)
assert.equal(processExitStub.args[0][0], 1)
})
})

84
test/env-cmd.spec.ts
View File

@ -1,68 +1,44 @@
import * as sinon from 'sinon'
import { default as sinon } from 'sinon'
import { assert } from 'chai'
import * as signalTermLib from '../src/signal-termination'
import * as parseArgsLib from '../src/parse-args'
import * as getEnvVarsLib from '../src/get-env-vars'
import * as expandEnvsLib from '../src/expand-envs'
import * as spawnLib from '../src/spawn'
import * as envCmdLib from '../src/env-cmd'
import { default as esmock } from 'esmock'
import { expandEnvs } from '../src/expand-envs.js'
import type { EnvCmd } from '../src/env-cmd.ts'
describe('CLI', (): void => {
let sandbox: sinon.SinonSandbox
let parseArgsStub: sinon.SinonStub<any>
let envCmdStub: sinon.SinonStub<any>
let processExitStub: sinon.SinonStub<any>
before((): void => {
sandbox = sinon.createSandbox()
parseArgsStub = sandbox.stub(parseArgsLib, 'parseArgs')
envCmdStub = sandbox.stub(envCmdLib, 'EnvCmd')
processExitStub = sandbox.stub(process, 'exit')
})
after((): void => {
sandbox.restore()
})
afterEach((): void => {
sandbox.resetHistory()
sandbox.resetBehavior()
})
it('should parse the provided args and execute the EnvCmd', async (): Promise<void> => {
parseArgsStub.returns({})
await envCmdLib.CLI(['node', './env-cmd', '-v'])
assert.equal(parseArgsStub.callCount, 1)
assert.equal(envCmdStub.callCount, 1)
assert.equal(processExitStub.callCount, 0)
})
it('should catch exception if EnvCmd throws an exception', async (): Promise<void> => {
parseArgsStub.returns({})
envCmdStub.throwsException('Error')
await envCmdLib.CLI(['node', './env-cmd', '-v'])
assert.equal(parseArgsStub.callCount, 1)
assert.equal(envCmdStub.callCount, 1)
assert.equal(processExitStub.callCount, 1)
assert.equal(processExitStub.args[0][0], 1)
})
})
let envCmdLib: { EnvCmd: typeof EnvCmd }
describe('EnvCmd', (): void => {
let sandbox: sinon.SinonSandbox
let getEnvVarsStub: sinon.SinonStub<any>
let spawnStub: sinon.SinonStub<any>
let expandEnvsSpy: sinon.SinonSpy<any>
before((): void => {
before(async (): Promise<void> => {
sandbox = sinon.createSandbox()
getEnvVarsStub = sandbox.stub(getEnvVarsLib, 'getEnvVars')
spawnStub = sandbox.stub(spawnLib, 'spawn')
getEnvVarsStub = sandbox.stub()
spawnStub = sandbox.stub()
spawnStub.returns({
on: (): void => { /* Fake the on method */ },
kill: (): void => { /* Fake the kill method */ },
on: sinon.stub(),
kill: sinon.stub(),
})
expandEnvsSpy = sandbox.spy(expandEnvs)
const TermSignals = sandbox.stub()
TermSignals.prototype.handleTermSignals = sandbox.stub()
TermSignals.prototype.handleUncaughtExceptions = sandbox.stub()
envCmdLib = await esmock('../src/env-cmd.ts', {
'../src/get-env-vars': {
getEnvVars: getEnvVarsStub,
},
'cross-spawn': {
default: spawnStub,
},
'../src/expand-envs': {
expandEnvs: expandEnvsSpy,
},
'../src/signal-termination': {
TermSignals,
},
})
expandEnvsSpy = sandbox.spy(expandEnvsLib, 'expandEnvs')
sandbox.stub(signalTermLib.TermSignals.prototype, 'handleTermSignals')
sandbox.stub(signalTermLib.TermSignals.prototype, 'handleUncaughtExceptions')
})
after((): void => {

2
test/expand-envs.spec.ts
View File

@ -1,6 +1,6 @@
/* eslint @typescript-eslint/no-non-null-assertion: 0 */
import { assert } from 'chai'
import { expandEnvs } from '../src/expand-envs'
import { expandEnvs } from '../src/expand-envs.js'
describe('expandEnvs', (): void => {
const envs = {

71
test/get-env-vars.spec.ts
View File

@ -1,17 +1,26 @@
import * as sinon from 'sinon'
import { default as sinon } from 'sinon'
import { assert } from 'chai'
import { getEnvVars } from '../src/get-env-vars'
import * as rcFile from '../src/parse-rc-file'
import * as envFile from '../src/parse-env-file'
import { default as esmock } from 'esmock'
import type { getEnvVars } from '../src/get-env-vars.ts'
let getEnvVarsLib: { getEnvVars: typeof getEnvVars }
describe('getEnvVars', (): void => {
let getRCFileVarsStub: sinon.SinonStub<any>
let getEnvFileVarsStub: sinon.SinonStub<any>
let logInfoStub: sinon.SinonStub<any> | undefined
before((): void => {
getRCFileVarsStub = sinon.stub(rcFile, 'getRCFileVars')
getEnvFileVarsStub = sinon.stub(envFile, 'getEnvFileVars')
before(async (): Promise<void> => {
getRCFileVarsStub = sinon.stub()
getEnvFileVarsStub = sinon.stub()
getEnvVarsLib = await esmock('../src/get-env-vars.ts', {
'../src/parse-rc-file': {
getRCFileVars: getRCFileVarsStub
},
'../src/parse-env-file': {
getEnvFileVars: getEnvFileVarsStub
}
})
})
after((): void => {
@ -27,7 +36,7 @@ describe('getEnvVars', (): void => {
it('should parse the json .rc file from the default path with the given environment',
async (): Promise<void> => {
getRCFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
const envs = await getEnvVars({ rc: { environments: ['production'] } })
const envs = await getEnvVarsLib.getEnvVars({ rc: { environments: ['production'] } })
assert.isOk(envs)
assert.lengthOf(Object.keys(envs), 1)
assert.equal(envs.THANKS, 'FOR ALL THE FISH')
@ -42,7 +51,7 @@ describe('getEnvVars', (): void => {
async (): Promise<void> => {
logInfoStub = sinon.stub(console, 'info')
getRCFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
await getEnvVars({ rc: { environments: ['production'] }, verbose: true })
await getEnvVarsLib.getEnvVars({ rc: { environments: ['production'] }, verbose: true })
assert.equal(logInfoStub.callCount, 1)
},
)
@ -52,7 +61,7 @@ describe('getEnvVars', (): void => {
pathError.name = 'PathError'
getRCFileVarsStub.rejects(pathError)
getRCFileVarsStub.onThirdCall().returns({ THANKS: 'FOR ALL THE FISH' })
const envs = await getEnvVars({ rc: { environments: ['production'] } })
const envs = await getEnvVarsLib.getEnvVars({ rc: { environments: ['production'] } })
assert.isOk(envs)
assert.lengthOf(Object.keys(envs), 1)
assert.equal(envs.THANKS, 'FOR ALL THE FISH')
@ -67,7 +76,7 @@ describe('getEnvVars', (): void => {
pathError.name = 'PathError'
getRCFileVarsStub.rejects(pathError)
try {
await getEnvVars({ rc: { environments: ['production'] } })
await getEnvVarsLib.getEnvVars({ rc: { environments: ['production'] } })
assert.fail('should not get here.')
}
catch (e) {
@ -84,7 +93,7 @@ describe('getEnvVars', (): void => {
pathError.name = 'PathError'
getRCFileVarsStub.rejects(pathError)
try {
await getEnvVars({ rc: { environments: ['production'] }, verbose: true })
await getEnvVarsLib.getEnvVars({ rc: { environments: ['production'] }, verbose: true })
assert.fail('should not get here.')
}
catch {
@ -97,7 +106,7 @@ describe('getEnvVars', (): void => {
environmentError.name = 'EnvironmentError'
getRCFileVarsStub.rejects(environmentError)
try {
await getEnvVars({ rc: { environments: ['bad'] } })
await getEnvVarsLib.getEnvVars({ rc: { environments: ['bad'] } })
assert.fail('should not get here.')
}
catch (e) {
@ -113,7 +122,7 @@ describe('getEnvVars', (): void => {
environmentError.name = 'EnvironmentError'
getRCFileVarsStub.rejects(environmentError)
try {
await getEnvVars({ rc: { environments: ['bad'] }, verbose: true })
await getEnvVarsLib.getEnvVars({ rc: { environments: ['bad'] }, verbose: true })
assert.fail('should not get here.')
}
catch {
@ -123,7 +132,7 @@ describe('getEnvVars', (): void => {
it('should find .rc file at custom path path', async (): Promise<void> => {
getRCFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
const envs = await getEnvVars({
const envs = await getEnvVarsLib.getEnvVars({
rc: { environments: ['production'], filePath: '../.custom-rc' },
})
assert.isOk(envs)
@ -138,7 +147,7 @@ describe('getEnvVars', (): void => {
it('should print custom .rc file path to info for verbose', async (): Promise<void> => {
logInfoStub = sinon.stub(console, 'info')
getRCFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
await getEnvVars({
await getEnvVarsLib.getEnvVars({
rc: { environments: ['production'], filePath: '../.custom-rc' },
verbose: true,
})
@ -150,7 +159,7 @@ describe('getEnvVars', (): void => {
pathError.name = 'PathError'
getRCFileVarsStub.rejects(pathError)
try {
await getEnvVars({
await getEnvVarsLib.getEnvVars({
rc: { environments: ['production'], filePath: '../.custom-rc' },
})
assert.fail('should not get here.')
@ -168,7 +177,7 @@ describe('getEnvVars', (): void => {
pathError.name = 'PathError'
getRCFileVarsStub.rejects(pathError)
try {
await getEnvVars({
await getEnvVarsLib.getEnvVars({
rc: { environments: ['production'], filePath: '../.custom-rc' },
verbose: true,
})
@ -184,7 +193,7 @@ describe('getEnvVars', (): void => {
environmentError.name = 'EnvironmentError'
getRCFileVarsStub.rejects(environmentError)
try {
await getEnvVars({
await getEnvVarsLib.getEnvVars({
rc: { environments: ['bad'], filePath: '../.custom-rc' },
})
assert.fail('should not get here.')
@ -203,7 +212,7 @@ describe('getEnvVars', (): void => {
environmentError.name = 'EnvironmentError'
getRCFileVarsStub.rejects(environmentError)
try {
await getEnvVars({
await getEnvVarsLib.getEnvVars({
rc: { environments: ['bad'], filePath: '../.custom-rc' },
verbose: true,
})
@ -217,7 +226,7 @@ describe('getEnvVars', (): void => {
it('should parse the env file from a custom path', async (): Promise<void> => {
getEnvFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
const envs = await getEnvVars({ envFile: { filePath: '../.env-file' } })
const envs = await getEnvVarsLib.getEnvVars({ envFile: { filePath: '../.env-file' } })
assert.isOk(envs)
assert.lengthOf(Object.keys(envs), 1)
assert.equal(envs.THANKS, 'FOR ALL THE FISH')
@ -228,14 +237,14 @@ describe('getEnvVars', (): void => {
it('should print path of .env file to info for verbose', async (): Promise<void> => {
logInfoStub = sinon.stub(console, 'info')
getEnvFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
await getEnvVars({ envFile: { filePath: '../.env-file' }, verbose: true })
await getEnvVarsLib.getEnvVars({ envFile: { filePath: '../.env-file' }, verbose: true })
assert.equal(logInfoStub.callCount, 1)
})
it('should fail to find env file at custom path', async (): Promise<void> => {
getEnvFileVarsStub.rejects('Not found.')
try {
await getEnvVars({ envFile: { filePath: '../.env-file' } })
await getEnvVarsLib.getEnvVars({ envFile: { filePath: '../.env-file' } })
assert.fail('should not get here.')
}
catch (e) {
@ -249,7 +258,7 @@ describe('getEnvVars', (): void => {
logInfoStub = sinon.stub(console, 'info')
getEnvFileVarsStub.rejects('Not found.')
try {
await getEnvVars({ envFile: { filePath: '../.env-file' }, verbose: true })
await getEnvVarsLib.getEnvVars({ envFile: { filePath: '../.env-file' }, verbose: true })
assert.fail('should not get here.')
}
catch {
@ -263,7 +272,7 @@ describe('getEnvVars', (): void => {
async (): Promise<void> => {
getEnvFileVarsStub.onFirstCall().rejects('File not found.')
getEnvFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
const envs = await getEnvVars({ envFile: { filePath: '../.env-file', fallback: true } })
const envs = await getEnvVarsLib.getEnvVars({ envFile: { filePath: '../.env-file', fallback: true } })
assert.isOk(envs)
assert.lengthOf(Object.keys(envs), 1)
assert.equal(envs.THANKS, 'FOR ALL THE FISH')
@ -279,14 +288,14 @@ describe('getEnvVars', (): void => {
logInfoStub = sinon.stub(console, 'info')
getEnvFileVarsStub.onFirstCall().rejects('File not found.')
getEnvFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
await getEnvVars({ envFile: { filePath: '../.env-file', fallback: true }, verbose: true })
await getEnvVarsLib.getEnvVars({ envFile: { filePath: '../.env-file', fallback: true }, verbose: true })
assert.equal(logInfoStub.callCount, 2)
},
)
it('should parse the env file from the default path', async (): Promise<void> => {
getEnvFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
const envs = await getEnvVars()
const envs = await getEnvVarsLib.getEnvVars()
assert.isOk(envs)
assert.lengthOf(Object.keys(envs), 1)
assert.equal(envs.THANKS, 'FOR ALL THE FISH')
@ -297,14 +306,14 @@ describe('getEnvVars', (): void => {
it('should print path of .env file to info for verbose', async (): Promise<void> => {
logInfoStub = sinon.stub(console, 'info')
getEnvFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
await getEnvVars({ verbose: true })
await getEnvVarsLib.getEnvVars({ verbose: true })
assert.equal(logInfoStub.callCount, 1)
})
it('should search all default env file paths', async (): Promise<void> => {
getEnvFileVarsStub.throws('Not found.')
getEnvFileVarsStub.onThirdCall().returns({ THANKS: 'FOR ALL THE FISH' })
const envs = await getEnvVars()
const envs = await getEnvVarsLib.getEnvVars()
assert.isOk(envs)
assert.lengthOf(Object.keys(envs), 1)
assert.equal(envs.THANKS, 'FOR ALL THE FISH')
@ -315,7 +324,7 @@ describe('getEnvVars', (): void => {
it('should fail to find env file at default path', async (): Promise<void> => {
getEnvFileVarsStub.rejects('Not found.')
try {
await getEnvVars()
await getEnvVarsLib.getEnvVars()
assert.fail('should not get here.')
}
catch (e) {
@ -332,7 +341,7 @@ describe('getEnvVars', (): void => {
logInfoStub = sinon.stub(console, 'info')
getEnvFileVarsStub.rejects('Not found.')
try {
await getEnvVars({ verbose: true })
await getEnvVarsLib.getEnvVars({ verbose: true })
assert.fail('should not get here.')
}
catch {

4
test/parse-args.spec.ts
View File

@ -1,7 +1,7 @@
/* eslint @typescript-eslint/no-non-null-assertion: 0 */
import * as sinon from 'sinon'
import { default as sinon } from 'sinon'
import { assert } from 'chai'
import { parseArgs } from '../src/parse-args'
import { parseArgs } from '../src/parse-args.js'
describe('parseArgs', (): void => {
const command = 'command'

27
test/parse-env-file.spec.ts
View File

@ -2,7 +2,7 @@ import { assert } from 'chai'
import {
stripEmptyLines, stripComments, parseEnvVars,
parseEnvString, getEnvFileVars,
} from '../src/parse-env-file'
} from '../src/parse-env-file.js'
describe('stripEmptyLines', (): void => {
it('should strip out all empty lines', (): void => {
@ -125,8 +125,8 @@ describe('getEnvFileVars', (): void => {
})
})
it('should parse a js file', async (): Promise<void> => {
const env = await getEnvFileVars('./test/test-files/test.js')
it('should parse a js/cjs file', async (): Promise<void> => {
const env = await getEnvFileVars('./test/test-files/test.cjs')
assert.deepEqual(env, {
THANKS: 'FOR ALL THE FISH',
ANSWER: 0,
@ -134,8 +134,25 @@ describe('getEnvFileVars', (): void => {
})
})
it('should parse an async js file', async (): Promise<void> => {
const env = await getEnvFileVars('./test/test-files/test-async.js')
it('should parse an async js/cjs file', async (): Promise<void> => {
const env = await getEnvFileVars('./test/test-files/test-async.cjs')
assert.deepEqual(env, {
THANKS: 'FOR ALL THE FISH',
ANSWER: 0,
})
})
it('should parse a mjs file', async (): Promise<void> => {
const env = await getEnvFileVars('./test/test-files/test.mjs')
assert.deepEqual(env, {
THANKS: 'FOR ALL THE FISH',
ANSWER: 0,
GALAXY: 'hitch\nhiking',
})
})
it('should parse an async mjs file', async (): Promise<void> => {
const env = await getEnvFileVars('./test/test-files/test-async.mjs')
assert.deepEqual(env, {
THANKS: 'FOR ALL THE FISH',
ANSWER: 0,

19
test/parse-rc-file.spec.ts
View File

@ -1,5 +1,5 @@
import { assert } from 'chai'
import { getRCFileVars } from '../src/parse-rc-file'
import { getRCFileVars } from '../src/parse-rc-file.js'
const rcFilePath = './test/test-files/.rc-test'
const rcJSONFilePath = './test/test-files/.rc-test.json'
@ -58,10 +58,23 @@ describe('getRCFileVars', (): void => {
}
})
it('should parse an async js .rc file', async (): Promise<void> => {
it('should parse an async js/cjs .rc file', async (): Promise<void> => {
const env = await getRCFileVars({
environments: ['production'],
filePath: './test/test-files/.rc-test-async.js',
filePath: './test/test-files/.rc-test-async.cjs',
})
assert.deepEqual(env, {
THANKS: 'FOR WHAT?!',
ANSWER: 42,
ONLY: 'IN PRODUCTION',
BRINGATOWEL: true,
})
})
it('should parse an async mjs .rc file', async (): Promise<void> => {
const env = await getRCFileVars({
environments: ['production'],
filePath: './test/test-files/.rc-test-async.mjs',
})
assert.deepEqual(env, {
THANKS: 'FOR WHAT?!',

4
test/signal-termination.spec.ts
View File

@ -1,6 +1,6 @@
import { assert } from 'chai'
import * as sinon from 'sinon'
import { TermSignals } from '../src/signal-termination'
import { default as sinon } from 'sinon'
import { TermSignals } from '../src/signal-termination.js'
import { ChildProcess } from 'child_process'
type ChildExitListener = (code: number | null, signal: NodeJS.Signals | null | number) => void

1
test/test-files/.rc-test-async.js → test/test-files/.rc-test-async.cjs
View File

@ -1,5 +1,6 @@
module.exports = new Promise((resolve) => {
setTimeout(() => {
console.log('resolved')
resolve({
development: {
THANKS: 'FOR ALL THE FISH',

20
test/test-files/.rc-test-async.mjs Normal file
View File

@ -0,0 +1,20 @@
export default new Promise((resolve) => {
setTimeout(() => {
resolve({
development: {
THANKS: 'FOR ALL THE FISH',
ANSWER: 0,
},
test: {
THANKS: 'FOR MORE FISHIES',
ANSWER: 21,
},
production: {
THANKS: 'FOR WHAT?!',
ANSWER: 42,
ONLY: 'IN PRODUCTION',
BRINGATOWEL: true,
},
})
}, 200)
})

0
test/test-files/test-async.js → test/test-files/test-async.cjs
View File

8
test/test-files/test-async.mjs Normal file
View File

@ -0,0 +1,8 @@
export default new Promise((resolve) => {
setTimeout(() => {
resolve({
THANKS: 'FOR ALL THE FISH',
ANSWER: 0,
})
}, 200)
})

0
test/test-files/test.js → test/test-files/test.cjs
View File

5
test/test-files/test.mjs Normal file
View File

@ -0,0 +1,5 @@
export default {
THANKS: 'FOR ALL THE FISH',
ANSWER: 0,
GALAXY: 'hitch\nhiking',
}

18
test/tsconfig.json Normal file
View File

@ -0,0 +1,18 @@
{
"compilerOptions": {
"declaration": true,
"esModuleInterop": false,
"lib": ["es2023"],
"module": "Node16",
"moduleDetection": "force",
"noEmit": true,
"resolveJsonModule": true,
"strict": true,
"target": "ES2022",
},
"include": [
"./**/*",
"./test-files/.rc-test-async.cjs",
"./test-files/.rc-test-async.mjs",
]
}

40
test/utils.spec.ts
View File

@ -1,14 +1,31 @@
import * as os from 'os'
import * as process from 'process'
import * as path from 'path'
import { homedir } from 'node:os'
import { cwd } from 'node:process'
import { normalize } from 'node:path'
import { assert } from 'chai'
import * as sinon from 'sinon'
import { resolveEnvFilePath, parseArgList, isPromise } from '../src/utils'
import { default as sinon } from 'sinon'
import { default as esmock } from 'esmock'
import { resolveEnvFilePath, parseArgList, isPromise } from '../src/utils.js'
let utilsLib: {
resolveEnvFilePath: typeof resolveEnvFilePath,
parseArgList: typeof parseArgList,
isPromise: typeof isPromise
}
describe('utils', (): void => {
describe('resolveEnvFilePath', (): void => {
const homePath = os.homedir()
const currentDir = process.cwd()
const homePath = homedir()
const currentDir = cwd()
let homedirStub: sinon.SinonStub<any>
before(async (): Promise<void> => {
homedirStub = sinon.stub()
utilsLib = await esmock('../src/utils.js', {
'node:os': {
homedir: homedirStub
},
})
})
afterEach((): void => {
sinon.restore()
@ -16,18 +33,17 @@ describe('utils', (): void => {
it('should return an absolute path, given a relative path', (): void => {
const res = resolveEnvFilePath('./bob')
assert.equal(res, path.normalize(`${currentDir}/bob`))
assert.equal(res, normalize(`${currentDir}/bob`))
})
it('should return an absolute path, given a path with ~ for home directory', (): void => {
const res = resolveEnvFilePath('~/bob')
assert.equal(res, path.normalize(`${homePath}/bob`))
assert.equal(res, normalize(`${homePath}/bob`))
})
it('should not attempt to replace ~ if home dir does not exist', (): void => {
sinon.stub(os, 'homedir')
const res = resolveEnvFilePath('~/bob')
assert.equal(res, path.normalize(`${currentDir}/~/bob`))
const res = utilsLib.resolveEnvFilePath('~/bob')
assert.equal(res, normalize(`${currentDir}/~/bob`))
})
})

17
tsconfig.json
View File

@ -1,18 +1,17 @@
{
"compilerOptions": {
"declaration": true,
"esModuleInterop": false,
"lib": ["es2023"],
"module": "NodeNext",
"moduleDetection": "force",
"outDir": "./dist",
"target": "es2017",
"module": "commonjs",
"resolveJsonModule": true,
"strict": true,
"declaration": true,
"lib": [
"es2018",
"es2019",
"es2020"
]
"target": "ES2022",
"rootDir": "src"
},
"include": [
"./src/**/*"
"src/**/*"
]
}