mirror of
https://github.com/toddbluhm/env-cmd.git
synced 2025-12-08 18:23:33 +00:00
Merge pull request #392 from toddbluhm/update-to-recent-node-versions
feat(update): Update Project to Recent Node Versions
This commit is contained in:
commit
bdf3ddf53c
8
.mocharc.json
Normal file
8
.mocharc.json
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://json.schemastore.org/mocharc.json",
|
||||||
|
"require": ["tsx/esm", "esmock"],
|
||||||
|
"extensions": ["ts"],
|
||||||
|
"spec": [
|
||||||
|
"test/**/*.ts"
|
||||||
|
]
|
||||||
|
}
|
||||||
2
LICENSE
2
LICENSE
@ -1,6 +1,6 @@
|
|||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2019 Todd Bluhm
|
Copyright (c) Todd Bluhm
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|||||||
@ -1,2 +1,3 @@
|
|||||||
#! /usr/bin/env node
|
#! /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
8
dist/cli.d.ts
vendored
Normal 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
21
dist/cli.js
vendored
Normal 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
13
dist/env-cmd.d.ts
vendored
@ -1,17 +1,10 @@
|
|||||||
import { EnvCmdOptions } from './types';
|
import type { EnvCmdOptions, 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<{ [key: string]: any }>}
|
|
||||||
*/
|
|
||||||
export declare function CLI(args: string[]): Promise<Record<string, any>>;
|
|
||||||
/**
|
/**
|
||||||
* The main env-cmd program. This will spawn a new process and run the given command using
|
* The main env-cmd program. This will spawn a new process and run the given command using
|
||||||
* various environment file solutions.
|
* various environment file solutions.
|
||||||
*
|
*
|
||||||
* @export
|
* @export
|
||||||
* @param {EnvCmdOptions} { command, commandArgs, envFile, rc, options }
|
* @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
55
dist/env-cmd.js
vendored
@ -1,70 +1,47 @@
|
|||||||
"use strict";
|
import { default as spawn } from 'cross-spawn';
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
import { TermSignals } from './signal-termination.js';
|
||||||
const spawn_1 = require("./spawn");
|
import { getEnvVars } from './get-env-vars.js';
|
||||||
const signal_termination_1 = require("./signal-termination");
|
import { expandEnvs } from './expand-envs.js';
|
||||||
const parse_args_1 = require("./parse-args");
|
import * as processLib from 'node:process';
|
||||||
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;
|
|
||||||
/**
|
/**
|
||||||
* The main env-cmd program. This will spawn a new process and run the given command using
|
* The main env-cmd program. This will spawn a new process and run the given command using
|
||||||
* various environment file solutions.
|
* various environment file solutions.
|
||||||
*
|
*
|
||||||
* @export
|
* @export
|
||||||
* @param {EnvCmdOptions} { command, commandArgs, envFile, rc, options }
|
* @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 = {} }) {
|
export async function EnvCmd({ command, commandArgs, envFile, rc, options = {}, }) {
|
||||||
var _a;
|
|
||||||
let env = {};
|
let env = {};
|
||||||
try {
|
try {
|
||||||
env = await get_env_vars_1.getEnvVars({ envFile, rc, verbose: options.verbose });
|
env = await getEnvVars({ envFile, rc, verbose: options.verbose });
|
||||||
}
|
}
|
||||||
catch (e) {
|
catch (e) {
|
||||||
if (!((_a = options.silent) !== null && _a !== void 0 ? _a : false)) {
|
if (!(options.silent ?? false)) {
|
||||||
throw e;
|
throw e;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// Override the merge order if --no-override flag set
|
// Override the merge order if --no-override flag set
|
||||||
if (options.noOverride === true) {
|
if (options.noOverride === true) {
|
||||||
env = Object.assign({}, env, process.env);
|
env = Object.assign({}, env, processLib.env);
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
// Add in the system environment variables to our environment list
|
// 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) {
|
if (options.expandEnvs === true) {
|
||||||
command = expand_envs_1.expandEnvs(command, env);
|
command = expandEnvs(command, env);
|
||||||
commandArgs = commandArgs.map(arg => expand_envs_1.expandEnvs(arg, env));
|
commandArgs = commandArgs.map(arg => expandEnvs(arg, env));
|
||||||
}
|
}
|
||||||
// Execute the command with the given environment variables
|
// Execute the command with the given environment variables
|
||||||
const proc = spawn_1.spawn(command, commandArgs, {
|
const proc = spawn(command, commandArgs, {
|
||||||
stdio: 'inherit',
|
stdio: 'inherit',
|
||||||
shell: options.useShell,
|
shell: options.useShell,
|
||||||
env
|
env: env,
|
||||||
});
|
});
|
||||||
// Handle any termination signals for parent and child proceses
|
// 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.handleUncaughtExceptions();
|
||||||
signals.handleTermSignals(proc);
|
signals.handleTermSignals(proc);
|
||||||
return env;
|
return env;
|
||||||
}
|
}
|
||||||
exports.EnvCmd = EnvCmd;
|
|
||||||
|
|||||||
5
dist/expand-envs.d.ts
vendored
5
dist/expand-envs.d.ts
vendored
@ -1,5 +1,6 @@
|
|||||||
|
import type { Environment } from './types.ts';
|
||||||
/**
|
/**
|
||||||
* expandEnvs Replaces $var in args and command with environment variables
|
* 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
12
dist/expand-envs.js
vendored
@ -1,13 +1,11 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
/**
|
/**
|
||||||
* expandEnvs Replaces $var in args and command with environment variables
|
* 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) {
|
export function expandEnvs(str, envs) {
|
||||||
return str.replace(/(?<!\\)\$[a-zA-Z0-9_]+/g, varName => {
|
return str.replace(/(?<!\\)\$[a-zA-Z0-9_]+/g, (varName) => {
|
||||||
const varValue = envs[varName.slice(1)];
|
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
8
dist/get-env-vars.d.ts
vendored
@ -1,12 +1,12 @@
|
|||||||
import { GetEnvVarOptions } from './types';
|
import type { GetEnvVarOptions, Environment } from './types.ts';
|
||||||
export declare function getEnvVars(options?: GetEnvVarOptions): Promise<Record<string, any>>;
|
export declare function getEnvVars(options?: GetEnvVarOptions): Promise<Environment>;
|
||||||
export declare function getEnvFile({ filePath, fallback, verbose }: {
|
export declare function getEnvFile({ filePath, fallback, verbose }: {
|
||||||
filePath?: string;
|
filePath?: string;
|
||||||
fallback?: boolean;
|
fallback?: boolean;
|
||||||
verbose?: boolean;
|
verbose?: boolean;
|
||||||
}): Promise<Record<string, any>>;
|
}): Promise<Environment>;
|
||||||
export declare function getRCFile({ environments, filePath, verbose }: {
|
export declare function getRCFile({ environments, filePath, verbose }: {
|
||||||
environments: string[];
|
environments: string[];
|
||||||
filePath?: string;
|
filePath?: string;
|
||||||
verbose?: boolean;
|
verbose?: boolean;
|
||||||
}): Promise<Record<string, any>>;
|
}): Promise<Environment>;
|
||||||
|
|||||||
70
dist/get-env-vars.js
vendored
70
dist/get-env-vars.js
vendored
@ -1,40 +1,38 @@
|
|||||||
"use strict";
|
import { getRCFileVars } from './parse-rc-file.js';
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
import { getEnvFileVars } from './parse-env-file.js';
|
||||||
const parse_rc_file_1 = require("./parse-rc-file");
|
|
||||||
const parse_env_file_1 = require("./parse-env-file");
|
|
||||||
const RC_FILE_DEFAULT_LOCATIONS = ['./.env-cmdrc', './.env-cmdrc.js', './.env-cmdrc.json'];
|
const RC_FILE_DEFAULT_LOCATIONS = ['./.env-cmdrc', './.env-cmdrc.js', './.env-cmdrc.json'];
|
||||||
const ENV_FILE_DEFAULT_LOCATIONS = ['./.env', './.env.js', './.env.json'];
|
const ENV_FILE_DEFAULT_LOCATIONS = ['./.env', './.env.js', './.env.json'];
|
||||||
async function getEnvVars(options = {}) {
|
export async function getEnvVars(options = {}) {
|
||||||
options.envFile = options.envFile !== undefined ? options.envFile : {};
|
options.envFile = options.envFile ?? {};
|
||||||
// Check for rc file usage
|
// Check for rc file usage
|
||||||
if (options.rc !== undefined) {
|
if (options.rc !== undefined) {
|
||||||
return await getRCFile({
|
return await getRCFile({
|
||||||
environments: options.rc.environments,
|
environments: options.rc.environments,
|
||||||
filePath: options.rc.filePath,
|
filePath: options.rc.filePath,
|
||||||
verbose: options.verbose
|
verbose: options.verbose,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
return await getEnvFile({
|
return await getEnvFile({
|
||||||
filePath: options.envFile.filePath,
|
filePath: options.envFile.filePath,
|
||||||
fallback: options.envFile.fallback,
|
fallback: options.envFile.fallback,
|
||||||
verbose: options.verbose
|
verbose: options.verbose,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
exports.getEnvVars = getEnvVars;
|
export async function getEnvFile({ filePath, fallback, verbose }) {
|
||||||
async function getEnvFile({ filePath, fallback, verbose }) {
|
|
||||||
// Use env file
|
// Use env file
|
||||||
if (filePath !== undefined) {
|
if (filePath !== undefined) {
|
||||||
try {
|
try {
|
||||||
const env = await parse_env_file_1.getEnvFileVars(filePath);
|
const env = await getEnvFileVars(filePath);
|
||||||
if (verbose === true) {
|
if (verbose === true) {
|
||||||
console.info(`Found .env file at path: ${filePath}`);
|
console.info(`Found .env file at path: ${filePath}`);
|
||||||
}
|
}
|
||||||
return env;
|
return env;
|
||||||
}
|
}
|
||||||
catch (e) {
|
catch {
|
||||||
if (verbose === true) {
|
if (verbose === true) {
|
||||||
console.info(`Failed to find .env file at path: ${filePath}`);
|
console.info(`Failed to find .env file at path: ${filePath}`);
|
||||||
}
|
}
|
||||||
|
// Ignore error as we are just trying this location
|
||||||
}
|
}
|
||||||
if (fallback !== true) {
|
if (fallback !== true) {
|
||||||
throw new Error(`Failed to find .env file at path: ${filePath}`);
|
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
|
// Use the default env file locations
|
||||||
for (const path of ENV_FILE_DEFAULT_LOCATIONS) {
|
for (const path of ENV_FILE_DEFAULT_LOCATIONS) {
|
||||||
try {
|
try {
|
||||||
const env = await parse_env_file_1.getEnvFileVars(path);
|
const env = await getEnvFileVars(path);
|
||||||
if (verbose === true) {
|
if (verbose === true) {
|
||||||
console.info(`Found .env file at default path: ${path}`);
|
console.info(`Found .env file at default path: ${path}`);
|
||||||
}
|
}
|
||||||
return env;
|
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(',')}]`;
|
const error = `Failed to find .env file at default paths: [${ENV_FILE_DEFAULT_LOCATIONS.join(',')}]`;
|
||||||
if (verbose === true) {
|
if (verbose === true) {
|
||||||
@ -57,26 +57,27 @@ async function getEnvFile({ filePath, fallback, verbose }) {
|
|||||||
}
|
}
|
||||||
throw new Error(error);
|
throw new Error(error);
|
||||||
}
|
}
|
||||||
exports.getEnvFile = getEnvFile;
|
export async function getRCFile({ environments, filePath, verbose }) {
|
||||||
async function getRCFile({ environments, filePath, verbose }) {
|
|
||||||
// User provided an .rc file path
|
// User provided an .rc file path
|
||||||
if (filePath !== undefined) {
|
if (filePath !== undefined) {
|
||||||
try {
|
try {
|
||||||
const env = await parse_rc_file_1.getRCFileVars({ environments, filePath });
|
const env = await getRCFileVars({ environments, filePath });
|
||||||
if (verbose === true) {
|
if (verbose === true) {
|
||||||
console.info(`Found environments: [${environments.join(',')}] for .rc file at path: ${filePath}`);
|
console.info(`Found environments: [${environments.join(',')}] for .rc file at path: ${filePath}`);
|
||||||
}
|
}
|
||||||
return env;
|
return env;
|
||||||
}
|
}
|
||||||
catch (e) {
|
catch (e) {
|
||||||
if (e.name === 'PathError') {
|
if (e instanceof Error) {
|
||||||
if (verbose === true) {
|
if (e.name === 'PathError') {
|
||||||
console.info(`Failed to find .rc file at path: ${filePath}`);
|
if (verbose === true) {
|
||||||
|
console.info(`Failed to find .rc file at path: ${filePath}`);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
if (e.name === 'EnvironmentError') {
|
||||||
if (e.name === 'EnvironmentError') {
|
if (verbose === true) {
|
||||||
if (verbose === true) {
|
console.info(`Failed to find environments: [${environments.join(',')}] for .rc file at path: ${filePath}`);
|
||||||
console.info(`Failed to find environments: [${environments.join(',')}] for .rc file at path: ${filePath}`);
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
throw e;
|
throw e;
|
||||||
@ -85,19 +86,27 @@ async function getRCFile({ environments, filePath, verbose }) {
|
|||||||
// Use the default .rc file locations
|
// Use the default .rc file locations
|
||||||
for (const path of RC_FILE_DEFAULT_LOCATIONS) {
|
for (const path of RC_FILE_DEFAULT_LOCATIONS) {
|
||||||
try {
|
try {
|
||||||
const env = await parse_rc_file_1.getRCFileVars({ environments, filePath: path });
|
const env = await getRCFileVars({ environments, filePath: path });
|
||||||
if (verbose === true) {
|
if (verbose === true) {
|
||||||
console.info(`Found environments: [${environments.join(',')}] for default .rc file at path: ${path}`);
|
console.info(`Found environments: [${environments.join(',')}] for default .rc file at path: ${path}`);
|
||||||
}
|
}
|
||||||
return env;
|
return env;
|
||||||
}
|
}
|
||||||
catch (e) {
|
catch (e) {
|
||||||
if (e.name === 'EnvironmentError') {
|
if (e instanceof Error) {
|
||||||
const errorText = `Failed to find environments: [${environments.join(',')}] for .rc file at path: ${path}`;
|
if (e.name === 'EnvironmentError') {
|
||||||
if (verbose === true) {
|
const errorText = `Failed to find environments: [${environments.join(',')}] for .rc file at path: ${path}`;
|
||||||
console.info(errorText);
|
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);
|
throw new Error(errorText);
|
||||||
}
|
}
|
||||||
exports.getRCFile = getRCFile;
|
|
||||||
|
|||||||
7
dist/index.d.ts
vendored
7
dist/index.d.ts
vendored
@ -1,4 +1,5 @@
|
|||||||
import { getEnvVars } from './get-env-vars';
|
import { getEnvVars } from './get-env-vars.js';
|
||||||
export * from './types';
|
export * from './types.js';
|
||||||
export * from './env-cmd';
|
export * from './cli.js';
|
||||||
|
export * from './env-cmd.js';
|
||||||
export declare const GetEnvVars: typeof getEnvVars;
|
export declare const GetEnvVars: typeof getEnvVars;
|
||||||
|
|||||||
14
dist/index.js
vendored
14
dist/index.js
vendored
@ -1,8 +1,6 @@
|
|||||||
"use strict";
|
import { getEnvVars } from './get-env-vars.js';
|
||||||
function __export(m) {
|
// Export the core env-cmd API
|
||||||
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
export * from './types.js';
|
||||||
}
|
export * from './cli.js';
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
export * from './env-cmd.js';
|
||||||
const get_env_vars_1 = require("./get-env-vars");
|
export const GetEnvVars = getEnvVars;
|
||||||
__export(require("./env-cmd"));
|
|
||||||
exports.GetEnvVars = get_env_vars_1.getEnvVars;
|
|
||||||
|
|||||||
5
dist/parse-args.d.ts
vendored
5
dist/parse-args.d.ts
vendored
@ -1,7 +1,6 @@
|
|||||||
import * as commander from 'commander';
|
import type { EnvCmdOptions, CommanderOptions } from './types.ts';
|
||||||
import { EnvCmdOptions } from './types';
|
|
||||||
/**
|
/**
|
||||||
* Parses the arguments passed into the cli
|
* Parses the arguments passed into the cli
|
||||||
*/
|
*/
|
||||||
export declare function parseArgs(args: string[]): EnvCmdOptions;
|
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
29
dist/parse-args.js
vendored
@ -1,13 +1,10 @@
|
|||||||
"use strict";
|
import * as commander from 'commander';
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
import { parseArgList } from './utils.js';
|
||||||
const commander = require("commander");
|
import { default as packageJson } from '../package.json' with { type: 'json' };
|
||||||
const utils_1 = require("./utils");
|
|
||||||
// Use commonjs require to prevent a weird folder hierarchy in dist
|
|
||||||
const packageJson = require('../package.json');
|
|
||||||
/**
|
/**
|
||||||
* Parses the arguments passed into the cli
|
* Parses the arguments passed into the cli
|
||||||
*/
|
*/
|
||||||
function parseArgs(args) {
|
export function parseArgs(args) {
|
||||||
// Run the initial arguments through commander in order to determine
|
// Run the initial arguments through commander in order to determine
|
||||||
// which value in the args array is the `command` to execute
|
// which value in the args array is the `command` to execute
|
||||||
let program = parseArgsUsingCommander(args);
|
let program = parseArgsUsingCommander(args);
|
||||||
@ -39,17 +36,19 @@ function parseArgs(args) {
|
|||||||
silent = true;
|
silent = true;
|
||||||
}
|
}
|
||||||
let rc;
|
let rc;
|
||||||
if (program.environments !== undefined && program.environments.length !== 0) {
|
if (program.environments !== undefined
|
||||||
|
&& Array.isArray(program.environments)
|
||||||
|
&& program.environments.length !== 0) {
|
||||||
rc = {
|
rc = {
|
||||||
environments: program.environments,
|
environments: program.environments,
|
||||||
filePath: program.rcFile
|
filePath: program.rcFile,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
let envFile;
|
let envFile;
|
||||||
if (program.file !== undefined) {
|
if (program.file !== undefined) {
|
||||||
envFile = {
|
envFile = {
|
||||||
filePath: program.file,
|
filePath: program.file,
|
||||||
fallback: program.fallback
|
fallback: program.fallback,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
const options = {
|
const options = {
|
||||||
@ -62,21 +61,20 @@ function parseArgs(args) {
|
|||||||
noOverride,
|
noOverride,
|
||||||
silent,
|
silent,
|
||||||
useShell,
|
useShell,
|
||||||
verbose
|
verbose,
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
if (verbose) {
|
if (verbose) {
|
||||||
console.info(`Options: ${JSON.stringify(options, null, 0)}`);
|
console.info(`Options: ${JSON.stringify(options, null, 0)}`);
|
||||||
}
|
}
|
||||||
return options;
|
return options;
|
||||||
}
|
}
|
||||||
exports.parseArgs = parseArgs;
|
export function parseArgsUsingCommander(args) {
|
||||||
function parseArgsUsingCommander(args) {
|
|
||||||
const program = new commander.Command();
|
const program = new commander.Command();
|
||||||
return program
|
return program
|
||||||
.version(packageJson.version, '-v, --version')
|
.version(packageJson.version, '-v, --version')
|
||||||
.usage('[options] <command> [...args]')
|
.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('-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('--fallback', 'Fallback to default env file path, if custom env file path not found')
|
||||||
.option('--no-override', 'Do not override existing environment variables')
|
.option('--no-override', 'Do not override existing environment variables')
|
||||||
@ -88,4 +86,3 @@ function parseArgsUsingCommander(args) {
|
|||||||
.allowUnknownOption(true)
|
.allowUnknownOption(true)
|
||||||
.parse(['_', '_', ...args]);
|
.parse(['_', '_', ...args]);
|
||||||
}
|
}
|
||||||
exports.parseArgsUsingCommander = parseArgsUsingCommander;
|
|
||||||
|
|||||||
7
dist/parse-env-file.d.ts
vendored
7
dist/parse-env-file.d.ts
vendored
@ -1,15 +1,16 @@
|
|||||||
|
import type { Environment } from './types.ts';
|
||||||
/**
|
/**
|
||||||
* Gets the environment vars from an env file
|
* 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
|
* 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
|
* 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
|
* Strips out comments from env file string
|
||||||
*/
|
*/
|
||||||
|
|||||||
72
dist/parse-env-file.js
vendored
72
dist/parse-env-file.js
vendored
@ -1,37 +1,48 @@
|
|||||||
"use strict";
|
import { existsSync, readFileSync } from 'node:fs';
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
import { extname } from 'node:path';
|
||||||
const fs = require("fs");
|
import { pathToFileURL } from 'node:url';
|
||||||
const path = require("path");
|
import { resolveEnvFilePath, IMPORT_HOOK_EXTENSIONS, isPromise } from './utils.js';
|
||||||
const utils_1 = require("./utils");
|
|
||||||
const REQUIRE_HOOK_EXTENSIONS = ['.json', '.js', '.cjs'];
|
|
||||||
/**
|
/**
|
||||||
* Gets the environment vars from an env file
|
* Gets the environment vars from an env file
|
||||||
*/
|
*/
|
||||||
async function getEnvFileVars(envFilePath) {
|
export async function getEnvFileVars(envFilePath) {
|
||||||
const absolutePath = utils_1.resolveEnvFilePath(envFilePath);
|
const absolutePath = resolveEnvFilePath(envFilePath);
|
||||||
if (!fs.existsSync(absolutePath)) {
|
if (!existsSync(absolutePath)) {
|
||||||
const pathError = new Error(`Invalid env file path (${envFilePath}).`);
|
const pathError = new Error(`Invalid env file path (${envFilePath}).`);
|
||||||
pathError.name = 'PathError';
|
pathError.name = 'PathError';
|
||||||
throw pathError;
|
throw pathError;
|
||||||
}
|
}
|
||||||
// Get the file extension
|
// Get the file extension
|
||||||
const ext = path.extname(absolutePath).toLowerCase();
|
const ext = extname(absolutePath).toLowerCase();
|
||||||
let env = {};
|
let env = {};
|
||||||
if (REQUIRE_HOOK_EXTENSIONS.includes(ext)) {
|
if (IMPORT_HOOK_EXTENSIONS.includes(ext)) {
|
||||||
const possiblePromise = require(absolutePath);
|
// For some reason in ES Modules, only JSON file types need to be specifically delinated when importing them
|
||||||
env = utils_1.isPromise(possiblePromise) ? await possiblePromise : possiblePromise;
|
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 {
|
else {
|
||||||
const file = fs.readFileSync(absolutePath, { encoding: 'utf8' });
|
const file = readFileSync(absolutePath, { encoding: 'utf8' });
|
||||||
env = parseEnvString(file);
|
env = parseEnvString(file);
|
||||||
}
|
}
|
||||||
return env;
|
return env;
|
||||||
}
|
}
|
||||||
exports.getEnvFileVars = getEnvFileVars;
|
|
||||||
/**
|
/**
|
||||||
* Parse out all env vars from a given env file string and return an object
|
* 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
|
// First thing we do is stripe out all comments
|
||||||
envFileString = stripComments(envFileString.toString());
|
envFileString = stripComments(envFileString.toString());
|
||||||
// Next we stripe out all the empty lines
|
// 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)
|
// Merge the file env vars with the current process env vars (the file vars overwrite process vars)
|
||||||
return parseEnvVars(envFileString);
|
return parseEnvVars(envFileString);
|
||||||
}
|
}
|
||||||
exports.parseEnvString = parseEnvString;
|
|
||||||
/**
|
/**
|
||||||
* Parse out all env vars from an env file string
|
* Parse out all env vars from an env file string
|
||||||
*/
|
*/
|
||||||
function parseEnvVars(envString) {
|
export function parseEnvVars(envString) {
|
||||||
const envParseRegex = /^((.+?)[=](.*))$/gim;
|
const envParseRegex = /^((.+?)[=](.*))$/gim;
|
||||||
const matches = {};
|
const matches = {};
|
||||||
let match;
|
let match;
|
||||||
while ((match = envParseRegex.exec(envString)) !== null) {
|
while ((match = envParseRegex.exec(envString)) !== null) {
|
||||||
// Note: match[1] is the full env=var line
|
// Note: match[1] is the full env=var line
|
||||||
const key = match[2].trim();
|
const key = match[2].trim();
|
||||||
const value = match[3].trim();
|
let value = match[3].trim();
|
||||||
// remove any surrounding quotes
|
// remove any surrounding quotes
|
||||||
matches[key] = value
|
value = value
|
||||||
.replace(/(^['"]|['"]$)/g, '')
|
.replace(/(^['"]|['"]$)/g, '')
|
||||||
.replace(/\\n/g, '\n');
|
.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
|
* Strips out comments from env file string
|
||||||
*/
|
*/
|
||||||
function stripComments(envString) {
|
export function stripComments(envString) {
|
||||||
const commentsRegex = /(^#.*$)/gim;
|
const commentsRegex = /(^#.*$)/gim;
|
||||||
let match = commentsRegex.exec(envString);
|
let match = commentsRegex.exec(envString);
|
||||||
let newString = envString;
|
let newString = envString;
|
||||||
@ -72,12 +94,10 @@ function stripComments(envString) {
|
|||||||
}
|
}
|
||||||
return newString;
|
return newString;
|
||||||
}
|
}
|
||||||
exports.stripComments = stripComments;
|
|
||||||
/**
|
/**
|
||||||
* Strips out newlines from env file string
|
* Strips out newlines from env file string
|
||||||
*/
|
*/
|
||||||
function stripEmptyLines(envString) {
|
export function stripEmptyLines(envString) {
|
||||||
const emptyLinesRegex = /(^\n)/gim;
|
const emptyLinesRegex = /(^\n)/gim;
|
||||||
return envString.replace(emptyLinesRegex, '');
|
return envString.replace(emptyLinesRegex, '');
|
||||||
}
|
}
|
||||||
exports.stripEmptyLines = stripEmptyLines;
|
|
||||||
|
|||||||
3
dist/parse-rc-file.d.ts
vendored
3
dist/parse-rc-file.d.ts
vendored
@ -1,7 +1,8 @@
|
|||||||
|
import type { Environment } from './types.ts';
|
||||||
/**
|
/**
|
||||||
* Gets the env vars from the rc file and rc environments
|
* Gets the env vars from the rc file and rc environments
|
||||||
*/
|
*/
|
||||||
export declare function getRCFileVars({ environments, filePath }: {
|
export declare function getRCFileVars({ environments, filePath }: {
|
||||||
environments: string[];
|
environments: string[];
|
||||||
filePath: string;
|
filePath: string;
|
||||||
}): Promise<Record<string, any>>;
|
}): Promise<Environment>;
|
||||||
|
|||||||
66
dist/parse-rc-file.js
vendored
66
dist/parse-rc-file.js
vendored
@ -1,31 +1,44 @@
|
|||||||
"use strict";
|
import { stat, readFile } from 'node:fs';
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
import { promisify } from 'node:util';
|
||||||
const fs_1 = require("fs");
|
import { extname } from 'node:path';
|
||||||
const util_1 = require("util");
|
import { pathToFileURL } from 'node:url';
|
||||||
const path_1 = require("path");
|
import { resolveEnvFilePath, IMPORT_HOOK_EXTENSIONS, isPromise } from './utils.js';
|
||||||
const utils_1 = require("./utils");
|
const statAsync = promisify(stat);
|
||||||
const statAsync = util_1.promisify(fs_1.stat);
|
const readFileAsync = promisify(readFile);
|
||||||
const readFileAsync = util_1.promisify(fs_1.readFile);
|
|
||||||
/**
|
/**
|
||||||
* Gets the env vars from the rc file and rc environments
|
* Gets the env vars from the rc file and rc environments
|
||||||
*/
|
*/
|
||||||
async function getRCFileVars({ environments, filePath }) {
|
export async function getRCFileVars({ environments, filePath }) {
|
||||||
const absolutePath = utils_1.resolveEnvFilePath(filePath);
|
const absolutePath = resolveEnvFilePath(filePath);
|
||||||
try {
|
try {
|
||||||
await statAsync(absolutePath);
|
await statAsync(absolutePath);
|
||||||
}
|
}
|
||||||
catch (e) {
|
catch {
|
||||||
const pathError = new Error(`Failed to find .rc file at path: ${absolutePath}`);
|
const pathError = new Error(`Failed to find .rc file at path: ${absolutePath}`);
|
||||||
pathError.name = 'PathError';
|
pathError.name = 'PathError';
|
||||||
throw pathError;
|
throw pathError;
|
||||||
}
|
}
|
||||||
// Get the file extension
|
// Get the file extension
|
||||||
const ext = path_1.extname(absolutePath).toLowerCase();
|
const ext = extname(absolutePath).toLowerCase();
|
||||||
let parsedData;
|
let parsedData = {};
|
||||||
try {
|
try {
|
||||||
if (ext === '.json' || ext === '.js' || ext === '.cjs') {
|
if (IMPORT_HOOK_EXTENSIONS.includes(ext)) {
|
||||||
const possiblePromise = require(absolutePath);
|
// For some reason in ES Modules, only JSON file types need to be specifically delinated when importing them
|
||||||
parsedData = utils_1.isPromise(possiblePromise) ? await possiblePromise : possiblePromise;
|
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 {
|
else {
|
||||||
const file = await readFileAsync(absolutePath, { encoding: 'utf8' });
|
const file = await readFileAsync(absolutePath, { encoding: 'utf8' });
|
||||||
@ -33,20 +46,26 @@ async function getRCFileVars({ environments, filePath }) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
catch (e) {
|
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';
|
parseError.name = 'ParseError';
|
||||||
throw parseError;
|
throw parseError;
|
||||||
}
|
}
|
||||||
// Parse and merge multiple rc environments together
|
// Parse and merge multiple rc environments together
|
||||||
let result = {};
|
let result = {};
|
||||||
let environmentFound = false;
|
let environmentFound = false;
|
||||||
environments.forEach((name) => {
|
for (const name of environments) {
|
||||||
const envVars = parsedData[name];
|
if (name in parsedData) {
|
||||||
if (envVars !== undefined) {
|
const envVars = parsedData[name];
|
||||||
environmentFound = true;
|
if (envVars != null && typeof envVars === 'object') {
|
||||||
result = Object.assign(Object.assign({}, result), envVars);
|
environmentFound = true;
|
||||||
|
result = {
|
||||||
|
...result,
|
||||||
|
...envVars,
|
||||||
|
};
|
||||||
|
}
|
||||||
}
|
}
|
||||||
});
|
}
|
||||||
if (!environmentFound) {
|
if (!environmentFound) {
|
||||||
const environmentError = new Error(`Failed to find environments [${environments.join(',')}] at .rc file location: ${absolutePath}`);
|
const environmentError = new Error(`Failed to find environments [${environments.join(',')}] at .rc file location: ${absolutePath}`);
|
||||||
environmentError.name = 'EnvironmentError';
|
environmentError.name = 'EnvironmentError';
|
||||||
@ -54,4 +73,3 @@ async function getRCFileVars({ environments, filePath }) {
|
|||||||
}
|
}
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
exports.getRCFileVars = getRCFileVars;
|
|
||||||
|
|||||||
4
dist/signal-termination.d.ts
vendored
4
dist/signal-termination.d.ts
vendored
@ -1,7 +1,7 @@
|
|||||||
/// <reference types="node" />
|
|
||||||
import { ChildProcess } from 'child_process';
|
import { ChildProcess } from 'child_process';
|
||||||
export declare class TermSignals {
|
export declare class TermSignals {
|
||||||
private readonly terminateSpawnedProcessFuncHandlers;
|
private readonly terminateSpawnedProcessFuncHandlers;
|
||||||
|
private terminateSpawnedProcessFuncExitHandler?;
|
||||||
private readonly verbose;
|
private readonly verbose;
|
||||||
_exitCalled: boolean;
|
_exitCalled: boolean;
|
||||||
constructor(options?: {
|
constructor(options?: {
|
||||||
@ -15,7 +15,7 @@ export declare class TermSignals {
|
|||||||
/**
|
/**
|
||||||
* Terminate parent process helper
|
* Terminate parent process helper
|
||||||
*/
|
*/
|
||||||
_terminateProcess(code?: number, signal?: NodeJS.Signals): void;
|
_terminateProcess(signal?: NodeJS.Signals | number): void;
|
||||||
/**
|
/**
|
||||||
* Exit event listener clean up helper
|
* Exit event listener clean up helper
|
||||||
*/
|
*/
|
||||||
|
|||||||
111
dist/signal-termination.js
vendored
111
dist/signal-termination.js
vendored
@ -1,73 +1,73 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const SIGNALS_TO_HANDLE = [
|
const SIGNALS_TO_HANDLE = [
|
||||||
'SIGINT', 'SIGTERM', 'SIGHUP'
|
'SIGINT', 'SIGTERM', 'SIGHUP',
|
||||||
];
|
];
|
||||||
class TermSignals {
|
export class TermSignals {
|
||||||
|
terminateSpawnedProcessFuncHandlers = {};
|
||||||
|
terminateSpawnedProcessFuncExitHandler;
|
||||||
|
verbose = false;
|
||||||
|
_exitCalled = false;
|
||||||
constructor(options = {}) {
|
constructor(options = {}) {
|
||||||
this.terminateSpawnedProcessFuncHandlers = {};
|
|
||||||
this.verbose = false;
|
|
||||||
this._exitCalled = false;
|
|
||||||
this.verbose = options.verbose === true;
|
this.verbose = options.verbose === true;
|
||||||
}
|
}
|
||||||
handleTermSignals(proc) {
|
handleTermSignals(proc) {
|
||||||
// Terminate child process if parent process receives termination events
|
// Terminate child process if parent process receives termination events
|
||||||
SIGNALS_TO_HANDLE.forEach((signal) => {
|
const terminationFunc = (signal) => {
|
||||||
this.terminateSpawnedProcessFuncHandlers[signal] =
|
this._removeProcessListeners();
|
||||||
(signal, code) => {
|
if (!this._exitCalled) {
|
||||||
this._removeProcessListeners();
|
if (this.verbose) {
|
||||||
if (!this._exitCalled) {
|
console.info('Parent process exited with signal: '
|
||||||
if (this.verbose) {
|
+ signal.toString()
|
||||||
console.info('Parent process exited with signal: ' +
|
+ '. Terminating child process...');
|
||||||
signal.toString() +
|
}
|
||||||
'. Terminating child process...');
|
// Mark shared state so we do not run into a signal/exit loop
|
||||||
}
|
this._exitCalled = true;
|
||||||
// Mark shared state so we do not run into a signal/exit loop
|
// Use the signal code if it is an error code
|
||||||
this._exitCalled = true;
|
// let correctSignal: NodeJS.Signals | undefined
|
||||||
// Use the signal code if it is an error code
|
if (typeof signal === 'number') {
|
||||||
let correctSignal;
|
if (signal > 0) {
|
||||||
if (typeof signal === 'number') {
|
// code = signal
|
||||||
if (signal > (code !== null && code !== void 0 ? code : 0)) {
|
signal = 'SIGINT';
|
||||||
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);
|
|
||||||
}
|
}
|
||||||
};
|
}
|
||||||
|
// 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(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
|
// Terminate parent process if child process receives termination events
|
||||||
proc.on('exit', (code, signal) => {
|
proc.on('exit', (code, signal) => {
|
||||||
this._removeProcessListeners();
|
this._removeProcessListeners();
|
||||||
if (!this._exitCalled) {
|
if (!this._exitCalled) {
|
||||||
if (this.verbose) {
|
if (this.verbose) {
|
||||||
console.info(`Child process exited with code: ${(code !== null && code !== void 0 ? code : '').toString()} and signal:` +
|
console.info(`Child process exited with code: ${(code ?? '').toString()} and signal:`
|
||||||
(signal !== null && signal !== void 0 ? signal : '').toString() +
|
+ (signal ?? '').toString()
|
||||||
'. Terminating parent process...');
|
+ '. Terminating parent process...');
|
||||||
}
|
}
|
||||||
// Mark shared state so we do not run into a signal/exit loop
|
// Mark shared state so we do not run into a signal/exit loop
|
||||||
this._exitCalled = true;
|
this._exitCalled = true;
|
||||||
// Use the signal code if it is an error code
|
// Use the signal code if it is an error code
|
||||||
let correctSignal;
|
let correctSignal;
|
||||||
if (typeof signal === 'number') {
|
if (typeof signal === 'number') {
|
||||||
if (signal > (code !== null && code !== void 0 ? code : 0)) {
|
if (signal > (code ?? 0)) {
|
||||||
code = signal;
|
code = signal;
|
||||||
correctSignal = 'SIGINT';
|
correctSignal = 'SIGINT';
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
correctSignal = signal !== null && signal !== void 0 ? signal : undefined;
|
correctSignal = signal ?? undefined;
|
||||||
}
|
}
|
||||||
// Terminate the parent process
|
// Terminate the parent process
|
||||||
this._terminateProcess(code, correctSignal);
|
this._terminateProcess(correctSignal ?? code);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@ -75,17 +75,23 @@ class TermSignals {
|
|||||||
* Enables catching of unhandled exceptions
|
* Enables catching of unhandled exceptions
|
||||||
*/
|
*/
|
||||||
handleUncaughtExceptions() {
|
handleUncaughtExceptions() {
|
||||||
process.on('uncaughtException', (e) => this._uncaughtExceptionHandler(e));
|
process.on('uncaughtException', (e) => {
|
||||||
|
this._uncaughtExceptionHandler(e);
|
||||||
|
});
|
||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* Terminate parent process helper
|
* Terminate parent process helper
|
||||||
*/
|
*/
|
||||||
_terminateProcess(code, signal) {
|
_terminateProcess(signal) {
|
||||||
if (signal !== undefined) {
|
if (signal != null) {
|
||||||
return process.kill(process.pid, signal);
|
if (typeof signal === 'string') {
|
||||||
}
|
process.kill(process.pid, signal);
|
||||||
if (code !== undefined) {
|
return;
|
||||||
return process.exit(code);
|
}
|
||||||
|
if (typeof signal === 'number') {
|
||||||
|
process.exit(signal);
|
||||||
|
return;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
throw new Error('Unable to terminate parent process successfully');
|
throw new Error('Unable to terminate parent process successfully');
|
||||||
}
|
}
|
||||||
@ -96,7 +102,9 @@ class TermSignals {
|
|||||||
SIGNALS_TO_HANDLE.forEach((signal) => {
|
SIGNALS_TO_HANDLE.forEach((signal) => {
|
||||||
process.removeListener(signal, this.terminateSpawnedProcessFuncHandlers[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
|
* General exception handler
|
||||||
@ -106,4 +114,3 @@ class TermSignals {
|
|||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
exports.TermSignals = TermSignals;
|
|
||||||
|
|||||||
2
dist/spawn.d.ts
vendored
2
dist/spawn.d.ts
vendored
@ -1,2 +0,0 @@
|
|||||||
import * as spawn from 'cross-spawn';
|
|
||||||
export { spawn };
|
|
||||||
4
dist/spawn.js
vendored
4
dist/spawn.js
vendored
@ -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
34
dist/types.d.ts
vendored
@ -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 {
|
export interface GetEnvVarOptions {
|
||||||
envFile?: {
|
envFile?: EnvFileOptions;
|
||||||
filePath?: string;
|
rc?: RCFileOptions;
|
||||||
fallback?: boolean;
|
|
||||||
};
|
|
||||||
rc?: {
|
|
||||||
environments: string[];
|
|
||||||
filePath?: string;
|
|
||||||
};
|
|
||||||
verbose?: boolean;
|
verbose?: boolean;
|
||||||
}
|
}
|
||||||
export interface EnvCmdOptions extends Pick<GetEnvVarOptions, 'envFile' | 'rc'> {
|
export interface EnvCmdOptions extends GetEnvVarOptions {
|
||||||
command: string;
|
command: string;
|
||||||
commandArgs: string[];
|
commandArgs: string[];
|
||||||
options?: {
|
options?: {
|
||||||
|
|||||||
3
dist/types.js
vendored
3
dist/types.js
vendored
@ -1,2 +1 @@
|
|||||||
"use strict";
|
export {};
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
|
|||||||
5
dist/utils.d.ts
vendored
5
dist/utils.d.ts
vendored
@ -1,3 +1,4 @@
|
|||||||
|
export declare const IMPORT_HOOK_EXTENSIONS: string[];
|
||||||
/**
|
/**
|
||||||
* A simple function for resolving the path the user entered
|
* 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[];
|
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
31
dist/utils.js
vendored
@ -1,30 +1,31 @@
|
|||||||
"use strict";
|
import { resolve } from 'node:path';
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
import { homedir } from 'node:os';
|
||||||
const path = require("path");
|
import { cwd } from 'node:process';
|
||||||
const os = require("os");
|
// 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
|
* A simple function for resolving the path the user entered
|
||||||
*/
|
*/
|
||||||
function resolveEnvFilePath(userPath) {
|
export function resolveEnvFilePath(userPath) {
|
||||||
// Make sure a home directory exist
|
// Make sure a home directory exist
|
||||||
const home = os.homedir();
|
const home = homedir();
|
||||||
if (home !== undefined) {
|
if (home != null) {
|
||||||
userPath = userPath.replace(/^~($|\/|\\)/, `${home}$1`);
|
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
|
* A simple function that parses a comma separated string into an array of strings
|
||||||
*/
|
*/
|
||||||
function parseArgList(list) {
|
export function parseArgList(list) {
|
||||||
return list.split(',');
|
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) {
|
export function isPromise(value) {
|
||||||
return value != null && typeof value.then === 'function';
|
return value != null
|
||||||
|
&& typeof value === 'object'
|
||||||
|
&& 'then' in value
|
||||||
|
&& typeof value.then === 'function';
|
||||||
}
|
}
|
||||||
exports.isPromise = isPromise;
|
|
||||||
|
|||||||
@ -1,43 +1,38 @@
|
|||||||
const eslint = require('@eslint/js')
|
import { default as tseslint } from 'typescript-eslint'
|
||||||
const tseslint = require('typescript-eslint')
|
import { default as globals } from 'globals'
|
||||||
const globals = require('globals')
|
import { default as eslint } from '@eslint/js'
|
||||||
const stylistic = require('@stylistic/eslint-plugin')
|
|
||||||
|
|
||||||
module.exports = tseslint.config(
|
export default tseslint.config(
|
||||||
{
|
{
|
||||||
ignores: ['dist/*', 'bin/*'],
|
// Ignore build folder
|
||||||
rules: {
|
ignores: ['dist/*'],
|
||||||
'@typescript-eslint/no-require-imports': 'off',
|
},
|
||||||
},
|
eslint.configs.recommended,
|
||||||
|
tseslint.configs.strictTypeChecked,
|
||||||
|
tseslint.configs.stylisticTypeChecked,
|
||||||
|
{
|
||||||
|
// Enable Type generation
|
||||||
languageOptions: {
|
languageOptions: {
|
||||||
globals: {
|
globals: {
|
||||||
...globals.node,
|
...globals.node,
|
||||||
},
|
},
|
||||||
parserOptions: {
|
parserOptions: {
|
||||||
projectService: {
|
project: ['./tsconfig.json', './test/tsconfig.json'],
|
||||||
allowDefaultProject: ['test/*.ts'],
|
|
||||||
},
|
|
||||||
},
|
},
|
||||||
},
|
}
|
||||||
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
|
// For test files ignore some rules
|
||||||
files: ['test/*.ts'],
|
files: ['test/**/*'],
|
||||||
rules: {
|
rules: {
|
||||||
'@typescript-eslint/no-explicit-any': 'off',
|
'@typescript-eslint/no-explicit-any': 'off',
|
||||||
'@typescript-eslint/no-unsafe-member-access': '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],
|
||||||
|
},
|
||||||
)
|
)
|
||||||
|
|||||||
@ -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
64
package.json
@ -4,16 +4,17 @@
|
|||||||
"description": "Executes a command using the environment variables in an env file",
|
"description": "Executes a command using the environment variables in an env file",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"types": "dist/index.d.ts",
|
"types": "dist/index.d.ts",
|
||||||
|
"type": "module",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=8.0.0"
|
"node": ">=18.0.0"
|
||||||
},
|
},
|
||||||
"bin": {
|
"bin": {
|
||||||
"env-cmd": "bin/env-cmd.js"
|
"env-cmd": "bin/env-cmd.js"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"prepare": "husky",
|
"prepare": "husky",
|
||||||
"test": "mocha -r ts-node/register ./test/**/*.ts",
|
"test": "mocha",
|
||||||
"test-cover": "nyc npm test",
|
"test-cover": "c8 npm test",
|
||||||
"coveralls": "coveralls < coverage/lcov.info",
|
"coveralls": "coveralls < coverage/lcov.info",
|
||||||
"lint": "npx eslint .",
|
"lint": "npx eslint .",
|
||||||
"build": "tsc",
|
"build": "tsc",
|
||||||
@ -54,58 +55,33 @@
|
|||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@commitlint/cli": "^19.6.0",
|
"@commitlint/cli": "^19.6.0",
|
||||||
"@commitlint/config-conventional": "^19.6.0",
|
"@commitlint/config-conventional": "^19.6.0",
|
||||||
"@eslint/js": "^9.15.0",
|
"@eslint/js": "^9.16.0",
|
||||||
"@stylistic/eslint-plugin": "^2.11.0",
|
"@types/chai": "^5.0.1",
|
||||||
"@types/chai": "^4.0.0",
|
"@types/cross-spawn": "^6.0.6",
|
||||||
"@types/cross-spawn": "^6.0.0",
|
"@types/mocha": "^10.0.10",
|
||||||
"@types/mocha": "^7.0.0",
|
"@types/node": "^22.10.1",
|
||||||
"@types/node": "^12.0.0",
|
|
||||||
"@types/sinon": "^17.0.3",
|
"@types/sinon": "^17.0.3",
|
||||||
"chai": "^4.0.0",
|
"c8": "^10.1.2",
|
||||||
|
"chai": "^5.1.2",
|
||||||
"coveralls": "^3.0.0",
|
"coveralls": "^3.0.0",
|
||||||
|
"esmock": "^2.6.9",
|
||||||
"globals": "^15.12.0",
|
"globals": "^15.12.0",
|
||||||
"husky": "^9.1.7",
|
"husky": "^9.1.7",
|
||||||
"mocha": "^10.8.2",
|
"mocha": "^11.0.0",
|
||||||
"nyc": "^17.1.0",
|
|
||||||
"sinon": "^19.0.2",
|
"sinon": "^19.0.2",
|
||||||
"ts-node": "^8.0.0",
|
"tsx": "^4.19.2",
|
||||||
"typescript": "^5.7.2",
|
"typescript": "^5.7.2",
|
||||||
"typescript-eslint": "^8.15.0"
|
"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": {
|
"commitlint": {
|
||||||
"extends": [
|
"extends": [
|
||||||
"@commitlint/config-conventional"
|
"@commitlint/config-conventional"
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
"c8": {
|
||||||
|
"reporter": [
|
||||||
|
"text",
|
||||||
|
"lcov"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
25
src/cli.ts
Normal file
25
src/cli.ts
Normal 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)
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -1,29 +1,9 @@
|
|||||||
import { spawn } from './spawn'
|
import { default as spawn } from 'cross-spawn'
|
||||||
import { EnvCmdOptions, Environment } from './types'
|
import type { EnvCmdOptions, Environment } from './types.ts'
|
||||||
import { TermSignals } from './signal-termination'
|
import { TermSignals } from './signal-termination.js'
|
||||||
import { parseArgs } from './parse-args'
|
import { getEnvVars } from './get-env-vars.js'
|
||||||
import { getEnvVars } from './get-env-vars'
|
import { expandEnvs } from './expand-envs.js'
|
||||||
import { expandEnvs } from './expand-envs'
|
import * as processLib from 'node:process'
|
||||||
|
|
||||||
/**
|
|
||||||
* 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)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The main env-cmd program. This will spawn a new process and run the given command using
|
* 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
|
// Override the merge order if --no-override flag set
|
||||||
if (options.noOverride === true) {
|
if (options.noOverride === true) {
|
||||||
env = Object.assign({}, env, process.env)
|
env = Object.assign({}, env, processLib.env)
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
// Add in the system environment variables to our environment list
|
// 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) {
|
if (options.expandEnvs === true) {
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
import { Environment } from './types'
|
import type { Environment } from './types.ts'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* expandEnvs Replaces $var in args and command with environment variables
|
* expandEnvs Replaces $var in args and command with environment variables
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
import { GetEnvVarOptions, Environment } from './types'
|
import type { GetEnvVarOptions, Environment } from './types.ts'
|
||||||
import { getRCFileVars } from './parse-rc-file'
|
import { getRCFileVars } from './parse-rc-file.js'
|
||||||
import { getEnvFileVars } from './parse-env-file'
|
import { getEnvFileVars } from './parse-env-file.js'
|
||||||
|
|
||||||
const RC_FILE_DEFAULT_LOCATIONS = ['./.env-cmdrc', './.env-cmdrc.js', './.env-cmdrc.json']
|
const RC_FILE_DEFAULT_LOCATIONS = ['./.env-cmdrc', './.env-cmdrc.js', './.env-cmdrc.json']
|
||||||
const ENV_FILE_DEFAULT_LOCATIONS = ['./.env', './.env.js', './.env.json']
|
const ENV_FILE_DEFAULT_LOCATIONS = ['./.env', './.env.js', './.env.json']
|
||||||
|
|||||||
@ -1,6 +1,7 @@
|
|||||||
import { getEnvVars } from './get-env-vars'
|
import { getEnvVars } from './get-env-vars.js'
|
||||||
|
|
||||||
// Export the core env-cmd API
|
// Export the core env-cmd API
|
||||||
export * from './types'
|
export * from './types.js'
|
||||||
export * from './env-cmd'
|
export * from './cli.js'
|
||||||
|
export * from './env-cmd.js'
|
||||||
export const GetEnvVars = getEnvVars
|
export const GetEnvVars = getEnvVars
|
||||||
|
|||||||
@ -1,9 +1,7 @@
|
|||||||
import * as commander from 'commander'
|
import * as commander from 'commander'
|
||||||
import { EnvCmdOptions, CommanderOptions, EnvFileOptions, RCFileOptions } from './types'
|
import type { EnvCmdOptions, CommanderOptions, EnvFileOptions, RCFileOptions } from './types.ts'
|
||||||
import { parseArgList } from './utils'
|
import { parseArgList } from './utils.js'
|
||||||
|
import { default as packageJson } from '../package.json' with { type: 'json' };
|
||||||
// Use commonjs require to prevent a weird folder hierarchy in dist
|
|
||||||
const packageJson: { version: string } = require('../package.json') /* eslint-disable-line */
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses the arguments passed into the cli
|
* Parses the arguments passed into the cli
|
||||||
|
|||||||
@ -1,30 +1,42 @@
|
|||||||
import * as fs from 'fs'
|
import { existsSync, readFileSync } from 'node:fs'
|
||||||
import * as path from 'path'
|
import { extname } from 'node:path'
|
||||||
import { resolveEnvFilePath, isPromise } from './utils'
|
import { pathToFileURL } from 'node:url'
|
||||||
import { Environment } from './types'
|
import { resolveEnvFilePath, IMPORT_HOOK_EXTENSIONS, isPromise } from './utils.js'
|
||||||
|
import type { Environment } from './types.ts'
|
||||||
const REQUIRE_HOOK_EXTENSIONS = ['.json', '.js', '.cjs']
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the environment vars from an env file
|
* Gets the environment vars from an env file
|
||||||
*/
|
*/
|
||||||
export async function getEnvFileVars(envFilePath: string): Promise<Environment> {
|
export async function getEnvFileVars(envFilePath: string): Promise<Environment> {
|
||||||
const absolutePath = resolveEnvFilePath(envFilePath)
|
const absolutePath = resolveEnvFilePath(envFilePath)
|
||||||
if (!fs.existsSync(absolutePath)) {
|
if (!existsSync(absolutePath)) {
|
||||||
const pathError = new Error(`Invalid env file path (${envFilePath}).`)
|
const pathError = new Error(`Invalid env file path (${envFilePath}).`)
|
||||||
pathError.name = 'PathError'
|
pathError.name = 'PathError'
|
||||||
throw pathError
|
throw pathError
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get the file extension
|
// Get the file extension
|
||||||
const ext = path.extname(absolutePath).toLowerCase()
|
const ext = extname(absolutePath).toLowerCase()
|
||||||
let env: Environment = {}
|
let env: Environment = {}
|
||||||
if (REQUIRE_HOOK_EXTENSIONS.includes(ext)) {
|
if (IMPORT_HOOK_EXTENSIONS.includes(ext)) {
|
||||||
const possiblePromise: Environment | Promise<Environment> = require(absolutePath) /* eslint-disable-line */
|
// For some reason in ES Modules, only JSON file types need to be specifically delinated when importing them
|
||||||
env = isPromise(possiblePromise) ? await possiblePromise : possiblePromise
|
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 {
|
else {
|
||||||
const file = fs.readFileSync(absolutePath, { encoding: 'utf8' })
|
const file = readFileSync(absolutePath, { encoding: 'utf8' })
|
||||||
env = parseEnvString(file)
|
env = parseEnvString(file)
|
||||||
}
|
}
|
||||||
return env
|
return env
|
||||||
|
|||||||
@ -1,8 +1,9 @@
|
|||||||
import { stat, readFile } from 'fs'
|
import { stat, readFile } from 'node:fs'
|
||||||
import { promisify } from 'util'
|
import { promisify } from 'node:util'
|
||||||
import { extname } from 'path'
|
import { extname } from 'node:path'
|
||||||
import { resolveEnvFilePath, isPromise } from './utils'
|
import { pathToFileURL } from 'node:url'
|
||||||
import { Environment, RCEnvironment } from './types'
|
import { resolveEnvFilePath, IMPORT_HOOK_EXTENSIONS, isPromise } from './utils.js'
|
||||||
|
import type { Environment, RCEnvironment } from './types.ts'
|
||||||
|
|
||||||
const statAsync = promisify(stat)
|
const statAsync = promisify(stat)
|
||||||
const readFileAsync = promisify(readFile)
|
const readFileAsync = promisify(readFile)
|
||||||
@ -26,11 +27,24 @@ export async function getRCFileVars(
|
|||||||
|
|
||||||
// Get the file extension
|
// Get the file extension
|
||||||
const ext = extname(absolutePath).toLowerCase()
|
const ext = extname(absolutePath).toLowerCase()
|
||||||
let parsedData: Partial<RCEnvironment>
|
let parsedData: Partial<RCEnvironment> = {}
|
||||||
try {
|
try {
|
||||||
if (ext === '.json' || ext === '.js' || ext === '.cjs') {
|
if (IMPORT_HOOK_EXTENSIONS.includes(ext)) {
|
||||||
const possiblePromise = require(absolutePath) as PromiseLike<RCEnvironment> | RCEnvironment
|
// For some reason in ES Modules, only JSON file types need to be specifically delinated when importing them
|
||||||
parsedData = isPromise(possiblePromise) ? await possiblePromise : possiblePromise
|
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 {
|
else {
|
||||||
const file = await readFileAsync(absolutePath, { encoding: 'utf8' })
|
const file = await readFileAsync(absolutePath, { encoding: 'utf8' })
|
||||||
|
|||||||
@ -1,4 +0,0 @@
|
|||||||
import * as spawn from 'cross-spawn'
|
|
||||||
export {
|
|
||||||
spawn,
|
|
||||||
}
|
|
||||||
12
src/utils.ts
12
src/utils.ts
@ -1,16 +1,20 @@
|
|||||||
import * as path from 'path'
|
import { resolve } from 'node:path'
|
||||||
import * as os from 'os'
|
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
|
* A simple function for resolving the path the user entered
|
||||||
*/
|
*/
|
||||||
export function resolveEnvFilePath(userPath: string): string {
|
export function resolveEnvFilePath(userPath: string): string {
|
||||||
// Make sure a home directory exist
|
// Make sure a home directory exist
|
||||||
const home = os.homedir() as string | undefined
|
const home = homedir() as string | undefined
|
||||||
if (home != null) {
|
if (home != null) {
|
||||||
userPath = userPath.replace(/^~($|\/|\\)/, `${home}$1`)
|
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
|
* A simple function that parses a comma separated string into an array of strings
|
||||||
|
|||||||
57
test/cli.spec.ts
Normal file
57
test/cli.spec.ts
Normal 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)
|
||||||
|
})
|
||||||
|
})
|
||||||
@ -1,68 +1,44 @@
|
|||||||
import * as sinon from 'sinon'
|
import { default as sinon } from 'sinon'
|
||||||
import { assert } from 'chai'
|
import { assert } from 'chai'
|
||||||
import * as signalTermLib from '../src/signal-termination'
|
import { default as esmock } from 'esmock'
|
||||||
import * as parseArgsLib from '../src/parse-args'
|
import { expandEnvs } from '../src/expand-envs.js'
|
||||||
import * as getEnvVarsLib from '../src/get-env-vars'
|
import type { EnvCmd } from '../src/env-cmd.ts'
|
||||||
import * as expandEnvsLib from '../src/expand-envs'
|
|
||||||
import * as spawnLib from '../src/spawn'
|
|
||||||
import * as envCmdLib from '../src/env-cmd'
|
|
||||||
|
|
||||||
describe('CLI', (): void => {
|
let envCmdLib: { EnvCmd: typeof EnvCmd }
|
||||||
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)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('EnvCmd', (): void => {
|
describe('EnvCmd', (): void => {
|
||||||
let sandbox: sinon.SinonSandbox
|
let sandbox: sinon.SinonSandbox
|
||||||
let getEnvVarsStub: sinon.SinonStub<any>
|
let getEnvVarsStub: sinon.SinonStub<any>
|
||||||
let spawnStub: sinon.SinonStub<any>
|
let spawnStub: sinon.SinonStub<any>
|
||||||
let expandEnvsSpy: sinon.SinonSpy<any>
|
let expandEnvsSpy: sinon.SinonSpy<any>
|
||||||
before((): void => {
|
before(async (): Promise<void> => {
|
||||||
sandbox = sinon.createSandbox()
|
sandbox = sinon.createSandbox()
|
||||||
getEnvVarsStub = sandbox.stub(getEnvVarsLib, 'getEnvVars')
|
getEnvVarsStub = sandbox.stub()
|
||||||
spawnStub = sandbox.stub(spawnLib, 'spawn')
|
spawnStub = sandbox.stub()
|
||||||
spawnStub.returns({
|
spawnStub.returns({
|
||||||
on: (): void => { /* Fake the on method */ },
|
on: sinon.stub(),
|
||||||
kill: (): void => { /* Fake the kill method */ },
|
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 => {
|
after((): void => {
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
/* eslint @typescript-eslint/no-non-null-assertion: 0 */
|
/* eslint @typescript-eslint/no-non-null-assertion: 0 */
|
||||||
import { assert } from 'chai'
|
import { assert } from 'chai'
|
||||||
import { expandEnvs } from '../src/expand-envs'
|
import { expandEnvs } from '../src/expand-envs.js'
|
||||||
|
|
||||||
describe('expandEnvs', (): void => {
|
describe('expandEnvs', (): void => {
|
||||||
const envs = {
|
const envs = {
|
||||||
|
|||||||
@ -1,17 +1,26 @@
|
|||||||
import * as sinon from 'sinon'
|
import { default as sinon } from 'sinon'
|
||||||
import { assert } from 'chai'
|
import { assert } from 'chai'
|
||||||
import { getEnvVars } from '../src/get-env-vars'
|
import { default as esmock } from 'esmock'
|
||||||
import * as rcFile from '../src/parse-rc-file'
|
import type { getEnvVars } from '../src/get-env-vars.ts'
|
||||||
import * as envFile from '../src/parse-env-file'
|
|
||||||
|
let getEnvVarsLib: { getEnvVars: typeof getEnvVars }
|
||||||
|
|
||||||
describe('getEnvVars', (): void => {
|
describe('getEnvVars', (): void => {
|
||||||
let getRCFileVarsStub: sinon.SinonStub<any>
|
let getRCFileVarsStub: sinon.SinonStub<any>
|
||||||
let getEnvFileVarsStub: sinon.SinonStub<any>
|
let getEnvFileVarsStub: sinon.SinonStub<any>
|
||||||
let logInfoStub: sinon.SinonStub<any> | undefined
|
let logInfoStub: sinon.SinonStub<any> | undefined
|
||||||
|
|
||||||
before((): void => {
|
before(async (): Promise<void> => {
|
||||||
getRCFileVarsStub = sinon.stub(rcFile, 'getRCFileVars')
|
getRCFileVarsStub = sinon.stub()
|
||||||
getEnvFileVarsStub = sinon.stub(envFile, 'getEnvFileVars')
|
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 => {
|
after((): void => {
|
||||||
@ -27,7 +36,7 @@ describe('getEnvVars', (): void => {
|
|||||||
it('should parse the json .rc file from the default path with the given environment',
|
it('should parse the json .rc file from the default path with the given environment',
|
||||||
async (): Promise<void> => {
|
async (): Promise<void> => {
|
||||||
getRCFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
|
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.isOk(envs)
|
||||||
assert.lengthOf(Object.keys(envs), 1)
|
assert.lengthOf(Object.keys(envs), 1)
|
||||||
assert.equal(envs.THANKS, 'FOR ALL THE FISH')
|
assert.equal(envs.THANKS, 'FOR ALL THE FISH')
|
||||||
@ -42,7 +51,7 @@ describe('getEnvVars', (): void => {
|
|||||||
async (): Promise<void> => {
|
async (): Promise<void> => {
|
||||||
logInfoStub = sinon.stub(console, 'info')
|
logInfoStub = sinon.stub(console, 'info')
|
||||||
getRCFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
|
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)
|
assert.equal(logInfoStub.callCount, 1)
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
@ -52,7 +61,7 @@ describe('getEnvVars', (): void => {
|
|||||||
pathError.name = 'PathError'
|
pathError.name = 'PathError'
|
||||||
getRCFileVarsStub.rejects(pathError)
|
getRCFileVarsStub.rejects(pathError)
|
||||||
getRCFileVarsStub.onThirdCall().returns({ THANKS: 'FOR ALL THE FISH' })
|
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.isOk(envs)
|
||||||
assert.lengthOf(Object.keys(envs), 1)
|
assert.lengthOf(Object.keys(envs), 1)
|
||||||
assert.equal(envs.THANKS, 'FOR ALL THE FISH')
|
assert.equal(envs.THANKS, 'FOR ALL THE FISH')
|
||||||
@ -67,7 +76,7 @@ describe('getEnvVars', (): void => {
|
|||||||
pathError.name = 'PathError'
|
pathError.name = 'PathError'
|
||||||
getRCFileVarsStub.rejects(pathError)
|
getRCFileVarsStub.rejects(pathError)
|
||||||
try {
|
try {
|
||||||
await getEnvVars({ rc: { environments: ['production'] } })
|
await getEnvVarsLib.getEnvVars({ rc: { environments: ['production'] } })
|
||||||
assert.fail('should not get here.')
|
assert.fail('should not get here.')
|
||||||
}
|
}
|
||||||
catch (e) {
|
catch (e) {
|
||||||
@ -84,7 +93,7 @@ describe('getEnvVars', (): void => {
|
|||||||
pathError.name = 'PathError'
|
pathError.name = 'PathError'
|
||||||
getRCFileVarsStub.rejects(pathError)
|
getRCFileVarsStub.rejects(pathError)
|
||||||
try {
|
try {
|
||||||
await getEnvVars({ rc: { environments: ['production'] }, verbose: true })
|
await getEnvVarsLib.getEnvVars({ rc: { environments: ['production'] }, verbose: true })
|
||||||
assert.fail('should not get here.')
|
assert.fail('should not get here.')
|
||||||
}
|
}
|
||||||
catch {
|
catch {
|
||||||
@ -97,7 +106,7 @@ describe('getEnvVars', (): void => {
|
|||||||
environmentError.name = 'EnvironmentError'
|
environmentError.name = 'EnvironmentError'
|
||||||
getRCFileVarsStub.rejects(environmentError)
|
getRCFileVarsStub.rejects(environmentError)
|
||||||
try {
|
try {
|
||||||
await getEnvVars({ rc: { environments: ['bad'] } })
|
await getEnvVarsLib.getEnvVars({ rc: { environments: ['bad'] } })
|
||||||
assert.fail('should not get here.')
|
assert.fail('should not get here.')
|
||||||
}
|
}
|
||||||
catch (e) {
|
catch (e) {
|
||||||
@ -113,7 +122,7 @@ describe('getEnvVars', (): void => {
|
|||||||
environmentError.name = 'EnvironmentError'
|
environmentError.name = 'EnvironmentError'
|
||||||
getRCFileVarsStub.rejects(environmentError)
|
getRCFileVarsStub.rejects(environmentError)
|
||||||
try {
|
try {
|
||||||
await getEnvVars({ rc: { environments: ['bad'] }, verbose: true })
|
await getEnvVarsLib.getEnvVars({ rc: { environments: ['bad'] }, verbose: true })
|
||||||
assert.fail('should not get here.')
|
assert.fail('should not get here.')
|
||||||
}
|
}
|
||||||
catch {
|
catch {
|
||||||
@ -123,7 +132,7 @@ describe('getEnvVars', (): void => {
|
|||||||
|
|
||||||
it('should find .rc file at custom path path', async (): Promise<void> => {
|
it('should find .rc file at custom path path', async (): Promise<void> => {
|
||||||
getRCFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
|
getRCFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
|
||||||
const envs = await getEnvVars({
|
const envs = await getEnvVarsLib.getEnvVars({
|
||||||
rc: { environments: ['production'], filePath: '../.custom-rc' },
|
rc: { environments: ['production'], filePath: '../.custom-rc' },
|
||||||
})
|
})
|
||||||
assert.isOk(envs)
|
assert.isOk(envs)
|
||||||
@ -138,7 +147,7 @@ describe('getEnvVars', (): void => {
|
|||||||
it('should print custom .rc file path to info for verbose', async (): Promise<void> => {
|
it('should print custom .rc file path to info for verbose', async (): Promise<void> => {
|
||||||
logInfoStub = sinon.stub(console, 'info')
|
logInfoStub = sinon.stub(console, 'info')
|
||||||
getRCFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
|
getRCFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
|
||||||
await getEnvVars({
|
await getEnvVarsLib.getEnvVars({
|
||||||
rc: { environments: ['production'], filePath: '../.custom-rc' },
|
rc: { environments: ['production'], filePath: '../.custom-rc' },
|
||||||
verbose: true,
|
verbose: true,
|
||||||
})
|
})
|
||||||
@ -150,7 +159,7 @@ describe('getEnvVars', (): void => {
|
|||||||
pathError.name = 'PathError'
|
pathError.name = 'PathError'
|
||||||
getRCFileVarsStub.rejects(pathError)
|
getRCFileVarsStub.rejects(pathError)
|
||||||
try {
|
try {
|
||||||
await getEnvVars({
|
await getEnvVarsLib.getEnvVars({
|
||||||
rc: { environments: ['production'], filePath: '../.custom-rc' },
|
rc: { environments: ['production'], filePath: '../.custom-rc' },
|
||||||
})
|
})
|
||||||
assert.fail('should not get here.')
|
assert.fail('should not get here.')
|
||||||
@ -168,7 +177,7 @@ describe('getEnvVars', (): void => {
|
|||||||
pathError.name = 'PathError'
|
pathError.name = 'PathError'
|
||||||
getRCFileVarsStub.rejects(pathError)
|
getRCFileVarsStub.rejects(pathError)
|
||||||
try {
|
try {
|
||||||
await getEnvVars({
|
await getEnvVarsLib.getEnvVars({
|
||||||
rc: { environments: ['production'], filePath: '../.custom-rc' },
|
rc: { environments: ['production'], filePath: '../.custom-rc' },
|
||||||
verbose: true,
|
verbose: true,
|
||||||
})
|
})
|
||||||
@ -184,7 +193,7 @@ describe('getEnvVars', (): void => {
|
|||||||
environmentError.name = 'EnvironmentError'
|
environmentError.name = 'EnvironmentError'
|
||||||
getRCFileVarsStub.rejects(environmentError)
|
getRCFileVarsStub.rejects(environmentError)
|
||||||
try {
|
try {
|
||||||
await getEnvVars({
|
await getEnvVarsLib.getEnvVars({
|
||||||
rc: { environments: ['bad'], filePath: '../.custom-rc' },
|
rc: { environments: ['bad'], filePath: '../.custom-rc' },
|
||||||
})
|
})
|
||||||
assert.fail('should not get here.')
|
assert.fail('should not get here.')
|
||||||
@ -203,7 +212,7 @@ describe('getEnvVars', (): void => {
|
|||||||
environmentError.name = 'EnvironmentError'
|
environmentError.name = 'EnvironmentError'
|
||||||
getRCFileVarsStub.rejects(environmentError)
|
getRCFileVarsStub.rejects(environmentError)
|
||||||
try {
|
try {
|
||||||
await getEnvVars({
|
await getEnvVarsLib.getEnvVars({
|
||||||
rc: { environments: ['bad'], filePath: '../.custom-rc' },
|
rc: { environments: ['bad'], filePath: '../.custom-rc' },
|
||||||
verbose: true,
|
verbose: true,
|
||||||
})
|
})
|
||||||
@ -217,7 +226,7 @@ describe('getEnvVars', (): void => {
|
|||||||
|
|
||||||
it('should parse the env file from a custom path', async (): Promise<void> => {
|
it('should parse the env file from a custom path', async (): Promise<void> => {
|
||||||
getEnvFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
|
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.isOk(envs)
|
||||||
assert.lengthOf(Object.keys(envs), 1)
|
assert.lengthOf(Object.keys(envs), 1)
|
||||||
assert.equal(envs.THANKS, 'FOR ALL THE FISH')
|
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> => {
|
it('should print path of .env file to info for verbose', async (): Promise<void> => {
|
||||||
logInfoStub = sinon.stub(console, 'info')
|
logInfoStub = sinon.stub(console, 'info')
|
||||||
getEnvFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
|
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)
|
assert.equal(logInfoStub.callCount, 1)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should fail to find env file at custom path', async (): Promise<void> => {
|
it('should fail to find env file at custom path', async (): Promise<void> => {
|
||||||
getEnvFileVarsStub.rejects('Not found.')
|
getEnvFileVarsStub.rejects('Not found.')
|
||||||
try {
|
try {
|
||||||
await getEnvVars({ envFile: { filePath: '../.env-file' } })
|
await getEnvVarsLib.getEnvVars({ envFile: { filePath: '../.env-file' } })
|
||||||
assert.fail('should not get here.')
|
assert.fail('should not get here.')
|
||||||
}
|
}
|
||||||
catch (e) {
|
catch (e) {
|
||||||
@ -249,7 +258,7 @@ describe('getEnvVars', (): void => {
|
|||||||
logInfoStub = sinon.stub(console, 'info')
|
logInfoStub = sinon.stub(console, 'info')
|
||||||
getEnvFileVarsStub.rejects('Not found.')
|
getEnvFileVarsStub.rejects('Not found.')
|
||||||
try {
|
try {
|
||||||
await getEnvVars({ envFile: { filePath: '../.env-file' }, verbose: true })
|
await getEnvVarsLib.getEnvVars({ envFile: { filePath: '../.env-file' }, verbose: true })
|
||||||
assert.fail('should not get here.')
|
assert.fail('should not get here.')
|
||||||
}
|
}
|
||||||
catch {
|
catch {
|
||||||
@ -263,7 +272,7 @@ describe('getEnvVars', (): void => {
|
|||||||
async (): Promise<void> => {
|
async (): Promise<void> => {
|
||||||
getEnvFileVarsStub.onFirstCall().rejects('File not found.')
|
getEnvFileVarsStub.onFirstCall().rejects('File not found.')
|
||||||
getEnvFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
|
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.isOk(envs)
|
||||||
assert.lengthOf(Object.keys(envs), 1)
|
assert.lengthOf(Object.keys(envs), 1)
|
||||||
assert.equal(envs.THANKS, 'FOR ALL THE FISH')
|
assert.equal(envs.THANKS, 'FOR ALL THE FISH')
|
||||||
@ -279,14 +288,14 @@ describe('getEnvVars', (): void => {
|
|||||||
logInfoStub = sinon.stub(console, 'info')
|
logInfoStub = sinon.stub(console, 'info')
|
||||||
getEnvFileVarsStub.onFirstCall().rejects('File not found.')
|
getEnvFileVarsStub.onFirstCall().rejects('File not found.')
|
||||||
getEnvFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
|
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)
|
assert.equal(logInfoStub.callCount, 2)
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
it('should parse the env file from the default path', async (): Promise<void> => {
|
it('should parse the env file from the default path', async (): Promise<void> => {
|
||||||
getEnvFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
|
getEnvFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
|
||||||
const envs = await getEnvVars()
|
const envs = await getEnvVarsLib.getEnvVars()
|
||||||
assert.isOk(envs)
|
assert.isOk(envs)
|
||||||
assert.lengthOf(Object.keys(envs), 1)
|
assert.lengthOf(Object.keys(envs), 1)
|
||||||
assert.equal(envs.THANKS, 'FOR ALL THE FISH')
|
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> => {
|
it('should print path of .env file to info for verbose', async (): Promise<void> => {
|
||||||
logInfoStub = sinon.stub(console, 'info')
|
logInfoStub = sinon.stub(console, 'info')
|
||||||
getEnvFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
|
getEnvFileVarsStub.returns({ THANKS: 'FOR ALL THE FISH' })
|
||||||
await getEnvVars({ verbose: true })
|
await getEnvVarsLib.getEnvVars({ verbose: true })
|
||||||
assert.equal(logInfoStub.callCount, 1)
|
assert.equal(logInfoStub.callCount, 1)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should search all default env file paths', async (): Promise<void> => {
|
it('should search all default env file paths', async (): Promise<void> => {
|
||||||
getEnvFileVarsStub.throws('Not found.')
|
getEnvFileVarsStub.throws('Not found.')
|
||||||
getEnvFileVarsStub.onThirdCall().returns({ THANKS: 'FOR ALL THE FISH' })
|
getEnvFileVarsStub.onThirdCall().returns({ THANKS: 'FOR ALL THE FISH' })
|
||||||
const envs = await getEnvVars()
|
const envs = await getEnvVarsLib.getEnvVars()
|
||||||
assert.isOk(envs)
|
assert.isOk(envs)
|
||||||
assert.lengthOf(Object.keys(envs), 1)
|
assert.lengthOf(Object.keys(envs), 1)
|
||||||
assert.equal(envs.THANKS, 'FOR ALL THE FISH')
|
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> => {
|
it('should fail to find env file at default path', async (): Promise<void> => {
|
||||||
getEnvFileVarsStub.rejects('Not found.')
|
getEnvFileVarsStub.rejects('Not found.')
|
||||||
try {
|
try {
|
||||||
await getEnvVars()
|
await getEnvVarsLib.getEnvVars()
|
||||||
assert.fail('should not get here.')
|
assert.fail('should not get here.')
|
||||||
}
|
}
|
||||||
catch (e) {
|
catch (e) {
|
||||||
@ -332,7 +341,7 @@ describe('getEnvVars', (): void => {
|
|||||||
logInfoStub = sinon.stub(console, 'info')
|
logInfoStub = sinon.stub(console, 'info')
|
||||||
getEnvFileVarsStub.rejects('Not found.')
|
getEnvFileVarsStub.rejects('Not found.')
|
||||||
try {
|
try {
|
||||||
await getEnvVars({ verbose: true })
|
await getEnvVarsLib.getEnvVars({ verbose: true })
|
||||||
assert.fail('should not get here.')
|
assert.fail('should not get here.')
|
||||||
}
|
}
|
||||||
catch {
|
catch {
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
/* eslint @typescript-eslint/no-non-null-assertion: 0 */
|
/* eslint @typescript-eslint/no-non-null-assertion: 0 */
|
||||||
import * as sinon from 'sinon'
|
import { default as sinon } from 'sinon'
|
||||||
import { assert } from 'chai'
|
import { assert } from 'chai'
|
||||||
import { parseArgs } from '../src/parse-args'
|
import { parseArgs } from '../src/parse-args.js'
|
||||||
|
|
||||||
describe('parseArgs', (): void => {
|
describe('parseArgs', (): void => {
|
||||||
const command = 'command'
|
const command = 'command'
|
||||||
|
|||||||
@ -2,7 +2,7 @@ import { assert } from 'chai'
|
|||||||
import {
|
import {
|
||||||
stripEmptyLines, stripComments, parseEnvVars,
|
stripEmptyLines, stripComments, parseEnvVars,
|
||||||
parseEnvString, getEnvFileVars,
|
parseEnvString, getEnvFileVars,
|
||||||
} from '../src/parse-env-file'
|
} from '../src/parse-env-file.js'
|
||||||
|
|
||||||
describe('stripEmptyLines', (): void => {
|
describe('stripEmptyLines', (): void => {
|
||||||
it('should strip out all empty lines', (): 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> => {
|
it('should parse a js/cjs file', async (): Promise<void> => {
|
||||||
const env = await getEnvFileVars('./test/test-files/test.js')
|
const env = await getEnvFileVars('./test/test-files/test.cjs')
|
||||||
assert.deepEqual(env, {
|
assert.deepEqual(env, {
|
||||||
THANKS: 'FOR ALL THE FISH',
|
THANKS: 'FOR ALL THE FISH',
|
||||||
ANSWER: 0,
|
ANSWER: 0,
|
||||||
@ -134,8 +134,25 @@ describe('getEnvFileVars', (): void => {
|
|||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should parse an async js file', async (): Promise<void> => {
|
it('should parse an async js/cjs file', async (): Promise<void> => {
|
||||||
const env = await getEnvFileVars('./test/test-files/test-async.js')
|
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, {
|
assert.deepEqual(env, {
|
||||||
THANKS: 'FOR ALL THE FISH',
|
THANKS: 'FOR ALL THE FISH',
|
||||||
ANSWER: 0,
|
ANSWER: 0,
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
import { assert } from 'chai'
|
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 rcFilePath = './test/test-files/.rc-test'
|
||||||
const rcJSONFilePath = './test/test-files/.rc-test.json'
|
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({
|
const env = await getRCFileVars({
|
||||||
environments: ['production'],
|
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, {
|
assert.deepEqual(env, {
|
||||||
THANKS: 'FOR WHAT?!',
|
THANKS: 'FOR WHAT?!',
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
import { assert } from 'chai'
|
import { assert } from 'chai'
|
||||||
import * as sinon from 'sinon'
|
import { default as sinon } from 'sinon'
|
||||||
import { TermSignals } from '../src/signal-termination'
|
import { TermSignals } from '../src/signal-termination.js'
|
||||||
import { ChildProcess } from 'child_process'
|
import { ChildProcess } from 'child_process'
|
||||||
|
|
||||||
type ChildExitListener = (code: number | null, signal: NodeJS.Signals | null | number) => void
|
type ChildExitListener = (code: number | null, signal: NodeJS.Signals | null | number) => void
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
module.exports = new Promise((resolve) => {
|
module.exports = new Promise((resolve) => {
|
||||||
setTimeout(() => {
|
setTimeout(() => {
|
||||||
|
console.log('resolved')
|
||||||
resolve({
|
resolve({
|
||||||
development: {
|
development: {
|
||||||
THANKS: 'FOR ALL THE FISH',
|
THANKS: 'FOR ALL THE FISH',
|
||||||
20
test/test-files/.rc-test-async.mjs
Normal file
20
test/test-files/.rc-test-async.mjs
Normal 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)
|
||||||
|
})
|
||||||
8
test/test-files/test-async.mjs
Normal file
8
test/test-files/test-async.mjs
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
export default new Promise((resolve) => {
|
||||||
|
setTimeout(() => {
|
||||||
|
resolve({
|
||||||
|
THANKS: 'FOR ALL THE FISH',
|
||||||
|
ANSWER: 0,
|
||||||
|
})
|
||||||
|
}, 200)
|
||||||
|
})
|
||||||
5
test/test-files/test.mjs
Normal file
5
test/test-files/test.mjs
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
export default {
|
||||||
|
THANKS: 'FOR ALL THE FISH',
|
||||||
|
ANSWER: 0,
|
||||||
|
GALAXY: 'hitch\nhiking',
|
||||||
|
}
|
||||||
18
test/tsconfig.json
Normal file
18
test/tsconfig.json
Normal 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",
|
||||||
|
]
|
||||||
|
}
|
||||||
@ -1,14 +1,31 @@
|
|||||||
import * as os from 'os'
|
import { homedir } from 'node:os'
|
||||||
import * as process from 'process'
|
import { cwd } from 'node:process'
|
||||||
import * as path from 'path'
|
import { normalize } from 'node:path'
|
||||||
import { assert } from 'chai'
|
import { assert } from 'chai'
|
||||||
import * as sinon from 'sinon'
|
import { default as sinon } from 'sinon'
|
||||||
import { resolveEnvFilePath, parseArgList, isPromise } from '../src/utils'
|
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('utils', (): void => {
|
||||||
describe('resolveEnvFilePath', (): void => {
|
describe('resolveEnvFilePath', (): void => {
|
||||||
const homePath = os.homedir()
|
const homePath = homedir()
|
||||||
const currentDir = process.cwd()
|
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 => {
|
afterEach((): void => {
|
||||||
sinon.restore()
|
sinon.restore()
|
||||||
@ -16,18 +33,17 @@ describe('utils', (): void => {
|
|||||||
|
|
||||||
it('should return an absolute path, given a relative path', (): void => {
|
it('should return an absolute path, given a relative path', (): void => {
|
||||||
const res = resolveEnvFilePath('./bob')
|
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 => {
|
it('should return an absolute path, given a path with ~ for home directory', (): void => {
|
||||||
const res = resolveEnvFilePath('~/bob')
|
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 => {
|
it('should not attempt to replace ~ if home dir does not exist', (): void => {
|
||||||
sinon.stub(os, 'homedir')
|
const res = utilsLib.resolveEnvFilePath('~/bob')
|
||||||
const res = resolveEnvFilePath('~/bob')
|
assert.equal(res, normalize(`${currentDir}/~/bob`))
|
||||||
assert.equal(res, path.normalize(`${currentDir}/~/bob`))
|
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
@ -1,18 +1,17 @@
|
|||||||
{
|
{
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
|
"declaration": true,
|
||||||
|
"esModuleInterop": false,
|
||||||
|
"lib": ["es2023"],
|
||||||
|
"module": "NodeNext",
|
||||||
|
"moduleDetection": "force",
|
||||||
"outDir": "./dist",
|
"outDir": "./dist",
|
||||||
"target": "es2017",
|
|
||||||
"module": "commonjs",
|
|
||||||
"resolveJsonModule": true,
|
"resolveJsonModule": true,
|
||||||
"strict": true,
|
"strict": true,
|
||||||
"declaration": true,
|
"target": "ES2022",
|
||||||
"lib": [
|
"rootDir": "src"
|
||||||
"es2018",
|
|
||||||
"es2019",
|
|
||||||
"es2020"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"include": [
|
"include": [
|
||||||
"./src/**/*"
|
"src/**/*"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user