Merge pull request #399 from toddbluhm/kh/ts

feat: support loading TypeScript files

Author: k-yle

dist/get-env-vars.js

@@ -1,5 +1,6 @@
 import { getRCFileVars } from './parse-rc-file.js';
 import { getEnvFileVars } from './parse-env-file.js';
+import { isLoaderError } from './utils.js';
 const RC_FILE_DEFAULT_LOCATIONS = ['./.env-cmdrc', './.env-cmdrc.js', './.env-cmdrc.json'];
 const ENV_FILE_DEFAULT_LOCATIONS = ['./.env', './.env.js', './.env.json'];
 export async function getEnvVars(options = {}) {
@@ -28,7 +29,10 @@ export async function getEnvFile({ filePath, fallback, verbose }) {
             }
             return env;
         }
-        catch {
+        catch (error) {
+            if (isLoaderError(error)) {
+                throw error;
+            }
             if (verbose === true) {
                 console.info(`Failed to find .env file at path: ${filePath}`);
             }

dist/loaders/typescript.d.ts

@@ -0,0 +1 @@
+export declare function checkIfTypescriptSupported(): void;

dist/loaders/typescript.js

@@ -0,0 +1,8 @@
+export function checkIfTypescriptSupported() {
+    if (!process.features.typescript) {
+        const error = new Error('To load typescript files with env-cmd, you need to upgrade to node v23.6' +
+            ' or later. See https://nodejs.org/en/learn/typescript/run-natively');
+        Object.assign(error, { code: 'ERR_UNKNOWN_FILE_EXTENSION' });
+        throw error;
+    }
+}

dist/parse-env-file.js

@@ -2,6 +2,7 @@ import { existsSync, readFileSync } from 'node:fs';
 import { extname } from 'node:path';
 import { pathToFileURL } from 'node:url';
 import { resolveEnvFilePath, IMPORT_HOOK_EXTENSIONS, isPromise } from './utils.js';
+import { checkIfTypescriptSupported } from './loaders/typescript.js';
 /**
  * Gets the environment vars from an env file
  */
@@ -16,6 +17,8 @@ export async function getEnvFileVars(envFilePath) {
     const ext = extname(absolutePath).toLowerCase();
     let env;
     if (IMPORT_HOOK_EXTENSIONS.includes(ext)) {
+        if (/tsx?$/.test(ext))
+            checkIfTypescriptSupported();
         // For some reason in ES Modules, only JSON file types need to be specifically delinated when importing them
         let attributeTypes = {};
         if (ext === '.json') {

dist/parse-rc-file.js

@@ -3,6 +3,7 @@ import { promisify } from 'node:util';
 import { extname } from 'node:path';
 import { pathToFileURL } from 'node:url';
 import { resolveEnvFilePath, IMPORT_HOOK_EXTENSIONS, isPromise } from './utils.js';
+import { checkIfTypescriptSupported } from './loaders/typescript.js';
 const statAsync = promisify(stat);
 const readFileAsync = promisify(readFile);
 /**
@@ -23,6 +24,8 @@ export async function getRCFileVars({ environments, filePath }) {
     let parsedData = {};
     try {
         if (IMPORT_HOOK_EXTENSIONS.includes(ext)) {
+            if (/tsx?$/.test(ext))
+                checkIfTypescriptSupported();
             // For some reason in ES Modules, only JSON file types need to be specifically delinated when importing them
             let attributeTypes = {};
             if (ext === '.json') {

dist/utils.d.ts

@@ -11,3 +11,5 @@ export declare function parseArgList(list: string): string[];
  * A simple function to test if the value is a promise/thenable
  */
 export declare function isPromise<T>(value?: T | PromiseLike<T>): value is PromiseLike<T>;
+/** @returns true if the error is `ERR_UNKNOWN_FILE_EXTENSION` */
+export declare function isLoaderError(error: unknown): error is Error;

dist/utils.js

@@ -2,7 +2,16 @@ import { resolve } from 'node:path';
 import { homedir } from 'node:os';
 import { cwd } from 'node:process';
 // Special file extensions that node can natively import
-export const IMPORT_HOOK_EXTENSIONS = ['.json', '.js', '.cjs', '.mjs'];
+export const IMPORT_HOOK_EXTENSIONS = [
+    '.json',
+    '.js',
+    '.cjs',
+    '.mjs',
+    '.ts',
+    '.mts',
+    '.cts',
+    '.tsx',
+];
 /**
  * A simple function for resolving the path the user entered
  */
@@ -29,3 +38,9 @@ export function isPromise(value) {
         && 'then' in value
         && typeof value.then === 'function';
 }
+/** @returns true if the error is `ERR_UNKNOWN_FILE_EXTENSION` */
+export function isLoaderError(error) {
+    return (error instanceof Error &&
+        'code' in error &&
+        error.code === 'ERR_UNKNOWN_FILE_EXTENSION');
+}

package.json

@@ -41,6 +41,7 @@
     "Eric Lanehart <eric@pushred.co>",
     "Jon Scheiding <jonscheiding@gmail.com>",
     "serapath (Alexander Praetorius) <dev@serapath.de>",
+    "Kyle Hensel <me@kyle.kiwi>",
     "Anton Versal <ant.ver@gmail.com>"
   ],
   "license": "MIT",

src/get-env-vars.ts

@@ -1,6 +1,7 @@
 import type { GetEnvVarOptions, Environment } from './types.ts'
 import { getRCFileVars } from './parse-rc-file.js'
 import { getEnvFileVars } from './parse-env-file.js'
+import { isLoaderError } from './utils.js'
 
 const RC_FILE_DEFAULT_LOCATIONS = ['./.env-cmdrc', './.env-cmdrc.js', './.env-cmdrc.json']
 const ENV_FILE_DEFAULT_LOCATIONS = ['./.env', './.env.js', './.env.json']
@@ -34,7 +35,11 @@ export async function getEnvFile(
       }
       return env
     }
-    catch {
+    catch (error) {
+      if (isLoaderError(error)) {
+        throw error
+      }
+
       if (verbose === true) {
         console.info(`Failed to find .env file at path: ${filePath}`)
       }

src/loaders/typescript.ts

@@ -0,0 +1,10 @@
+export function checkIfTypescriptSupported() {
+  if (!process.features.typescript) {
+    const error = new Error(
+      'To load typescript files with env-cmd, you need to upgrade to node v23.6' +
+        ' or later. See https://nodejs.org/en/learn/typescript/run-natively',
+    );
+    Object.assign(error, { code: 'ERR_UNKNOWN_FILE_EXTENSION' });
+    throw error;
+  }
+}