cjs-loader
Node.js require() hook for loading ESM & TypeScript.
Features
Transforms ESM & TypeScript to CommonJS on demand
Supports TS extensions .cjs & .mjs (.cts & .mts)
Cached for performance boost
Supports Node.js v12.16.2+
Handles node: import prefixes
Resolves tsconfig.json paths
Protip: use with esm-loader or tsx
cjs-loader only transforms CommonJS modules (.cjs/.cts or .js files in commonjs type packages).
To hook into import() calls or ES modules (.mjs/.mts extensions or .js files in module type packages), use this with esm-loader .
Alternatively, use tsx to handle them both automatically.
Install
npm install --save-dev @esbuild-kit/cjs-loader
Usage
Pass @esbuild-kit/cjs-loader into the --require
node -r @esbuild-kit/cjs-loader ./file.js
TypeScript configuration
The following properties are used from tsconfig.json in the working directory:
strictjsx
Warning: When set to preserve, the JSX syntax will remain untransformed. To prevent Node.js from throwing a syntax error, chain another Node.js loader that can transform JSX to JS.
jsxFactoryjsxFragmentFactoryjsxImportSourceallowJspaths
Custom tsconfig.json path
By default, tsconfig.json will be detected from the current working directory.
To set a custom path, use the ESBK_TSCONFIG_PATH environment variable:
ESBK_TSCONFIG_PATH=. /path/ to /tsconfig.custom.json node -r @esbuild-kit/ cjs-loader ./ file .js
Cache
Modules transformations are cached in the system cache directory (TMPDIR
Set environment variable ESBK_DISABLE_CACHE to a truthy value to disable the cache:
ESBK_DISABLE_CACHE= 1 node -r @esbuild-kit/cjs-loader ./file.js
Related
Sponsors
