feat: esm only (#6)

BREAKING CHANGE: drop Node.js < 22.17.0 support

Author: fengmk2

.github/workflows/ci.yml

@@ -5,13 +5,14 @@ on:
     branches: [master]
   pull_request:
     branches: [master]
+  merge_group:
 
 jobs:
   Job:
     name: Node.js
     uses: node-modules/github-actions/.github/workflows/node-test.yml@master
     with:
       os: 'ubuntu-latest, macos-latest, windows-latest'
-      version: '20, 22, 24'
+      version: '22, 24'
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/pkg.pr.new.yml

@@ -12,7 +12,7 @@ jobs:
       - run: corepack enable
       - uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 22
 
       - name: Install dependencies
         run: npm install

.oxlintrc.json

@@ -78,6 +78,7 @@
     "import/no-default-export": "allow",
     "import/unambiguous": "error",
     "import/group-exports": "allow",
+    "import/consistent-type-specifier-style": "allow",
 
     // promise
     "promise/no-return-wrap": "error",

package.json

@@ -17,30 +17,26 @@
   },
   "homepage": "https://github.com/node-modules/read-env-value#readme",
   "engines": {
-    "node": ">= 20.0.0"
+    "node": ">= 22.17.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.18.1",
-    "@eggjs/tsconfig": "2",
-    "@types/node": "22",
-    "@vitest/coverage-v8": "3",
+    "@eggjs/tsconfig": "3",
+    "@types/node": "24",
+    "c8": "10",
     "husky": "9",
     "mm": "4",
-    "oxlint": "^0.16.10",
+    "oxlint": "1",
     "prettier": "3",
-    "tshy": "3",
-    "tshy-after": "1",
-    "typescript": "5",
-    "vitest": "3"
+    "typescript": "5"
   },
   "scripts": {
     "lint": "oxlint",
     "pretest": "npm run lint -- --fix",
-    "test": "vitest run",
+    "test": "node --test --experimental-strip-types",
     "preci": "npm run lint",
-    "ci": "vitest run --coverage",
+    "ci": "c8 -r html -r lcov -r text npm test",
     "postci": "npm run prepublishOnly",
-    "prepublishOnly": "tshy && tshy-after && attw --pack",
+    "prepublishOnly": "tsc -b --clean && tsc",
     "prepare": "husky"
   },
   "lint-staged": {
@@ -50,31 +46,11 @@
       "oxlint --fix"
     ]
   },
-  "type": "module",
-  "tshy": {
-    "exports": {
-      ".": "./src/index.ts",
-      "./package.json": "./package.json"
-    }
-  },
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/esm/index.d.ts",
-        "default": "./dist/esm/index.js"
-      },
-      "require": {
-        "types": "./dist/commonjs/index.d.ts",
-        "default": "./dist/commonjs/index.js"
-      }
-    },
-    "./package.json": "./package.json"
-  },
   "files": [
     "dist",
     "src"
   ],
-  "types": "./dist/commonjs/index.d.ts",
-  "main": "./dist/commonjs/index.js",
-  "module": "./dist/esm/index.js"
+  "type": "module",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts"
 }

src/index.ts

@@ -1,13 +1,16 @@
 export type ValueType = 'string' | 'boolean' | 'number';
 export type DefaultValue = string | boolean | number | undefined;
 
-interface TypeMap<D> {
-  string: D extends undefined ? string | undefined : string;
-  boolean: D extends undefined ? boolean | undefined : boolean;
-  number: D extends undefined ? number | undefined : number;
+interface TypeMap<Default> {
+  string: Default extends undefined ? string | undefined : string;
+  boolean: Default extends undefined ? boolean | undefined : boolean;
+  number: Default extends undefined ? number | undefined : number;
 }
 
-type EnvReturn<V extends ValueType, D extends DefaultValue> = TypeMap<D>[V];
+type EnvReturn<
+  Value extends ValueType,
+  Default extends DefaultValue,
+> = TypeMap<Default>[Value];
 
 export class EnvError extends Error {
   code: string;
@@ -19,21 +22,21 @@ export class EnvError extends Error {
   }
 }
 
-export function env<V extends ValueType, D extends DefaultValue>(
+export function env<Value extends ValueType, Default extends DefaultValue>(
   key: string,
-  valueType: V,
-  defaultValue?: D
-): EnvReturn<V, D> {
+  valueType: Value,
+  defaultValue?: Default
+): EnvReturn<Value, Default> {
   let value = process.env[key];
   if (typeof value === 'string') {
     value = value.trim();
   }
   if (undefined === value || value === '') {
-    return defaultValue as EnvReturn<V, D>;
+    return defaultValue as EnvReturn<Value, Default>;
   }
 
   if (valueType === 'string') {
-    return value as EnvReturn<V, D>;
+    return value as EnvReturn<Value, Default>;
   }
 
   if (valueType === 'boolean') {
@@ -49,7 +52,7 @@ export function env<V extends ValueType, D extends DefaultValue>(
         'ERR_ENV_INVALID_BOOLEAN_VALUE'
       );
     }
-    return booleanValue as EnvReturn<V, D>;
+    return booleanValue as EnvReturn<Value, Default>;
   }
 
   if (valueType === 'number') {
@@ -60,7 +63,7 @@ export function env<V extends ValueType, D extends DefaultValue>(
         'ERR_ENV_INVALID_NUMBER_VALUE'
       );
     }
-    return numberValue as EnvReturn<V, D>;
+    return numberValue as EnvReturn<Value, Default>;
   }
 
   throw new EnvError(

test/index.test.ts

@@ -1,9 +1,9 @@
 import assert from 'node:assert/strict';
+import { test, beforeEach } from 'node:test';
 
-import { test, beforeEach } from 'vitest';
 import { mock, restore } from 'mm';
 
-import { env, type ValueType } from '../src/index.js';
+import { env, EnvError, type ValueType } from '../src/index.ts';
 
 beforeEach(restore);
 
@@ -142,3 +142,10 @@ test('should work with number value', () => {
   mock(process.env, 'TEST_ENV_NUMBER', '0');
   assert.equal(env('TEST_ENV_NUMBER', 'number', 10), 0);
 });
+
+test('should create EnvError without code', () => {
+  const err = new EnvError('test');
+  assert.equal(err.code, 'READ_ENV_VALUE_ERROR');
+  assert.equal(err.message, 'test');
+  assert.equal(err.name, 'ReadEnvValueError');
+});

tsconfig.json

@@ -1,3 +1,9 @@
 {
-  "extends": "@eggjs/tsconfig"
+  "extends": "@eggjs/tsconfig",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist"
+  },
+  "include": ["src"],
+  "exclude": ["test"]
 }