tinyhttp/milliparsec

Must use import to load ES Module

ac5tin opened this issue · 15 comments

Error [ERR_REQUIRE_ESM]: Must use import to load ES Module: /home/austin/Documents/node/quickcrawl/node_modules/milliparsec/dist/index.js
    at new NodeError (node:internal/errors:329:5)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1109:13)
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

My app.ts

import { App, Request,Response } from "@tinyhttp/app";
import StatusCodes from "http-status-codes";
import { json } from "milliparsec";
import { logger } from "@tinyhttp/logger";

const app = new App();
app.use(json());
app.use(logger());


// ping
app.get("/ping",(_:Request,res:Response)=> res.status(StatusCodes.OK).send("pong"));

const port = ~~(process.env?.PORT ?? "3000");
app
        .listen(port,()=> console.log(`STARTED SERVER ON PORT ${port}`));

my tsconfig.json :

{
  "compilerOptions": {
    /* Visit https://aka.ms/tsconfig.json to read more about this file */

    /* Basic Options */
    // "incremental": true,                         /* Enable incremental compilation */
    "target": "ES2019",                                /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
    "module": "ESNext",                           /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
    "lib": ["ESNext","DOM"],                                   /* Specify library files to be included in the compilation. */
    // "allowJs": true,                             /* Allow javascript files to be compiled. */
    // "checkJs": true,                             /* Report errors in .js files. */
    // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
    // "declaration": true,                         /* Generates corresponding '.d.ts' file. */
    // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
    // "outFile": "./",                             /* Concatenate and emit output to single file. */
    "outDir": "./dist",                              /* Redirect output structure to the directory. */
    // "rootDir": "./",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
    // "composite": true,                           /* Enable project compilation */
    // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
    // "removeComments": true,                      /* Do not emit comments to output. */
    // "noEmit": true,                              /* Do not emit outputs. */
    // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
    // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
    // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

    /* Strict Type-Checking Options */
    "strict": true,                                 /* Enable all strict type-checking options. */
    // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
    // "strictNullChecks": true,                    /* Enable strict null checks. */
    // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
    // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
    // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
    // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
    // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */

    /* Additional Checks */
    // "noUnusedLocals": true,                      /* Report errors on unused locals. */
    // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
    // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
    // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
    // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */

    /* Module Resolution Options */
    "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
    "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
    // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
    // "typeRoots": [],                             /* List of folders to include type definitions from. */
    // "types": [],                                 /* Type declaration files to be included in compilation. */
    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
    "esModuleInterop": true,                        /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */

    /* Source Map Options */
    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
    // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

    /* Experimental Options */
    "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
    "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */

    /* Advanced Options */
    //"skipLibCheck": true,                           /* Skip type checking of declaration files. */
    "forceConsistentCasingInFileNames": true        /* Disallow inconsistently-cased references to the same file. */
  }
}

my package.json:

{
  "name": "quickcrawl",
  "version": "1.0.0",
  "main": "index.js",
  "author": "<austinchang4@gmail.com>",
  "license": "MIT",
  "type": "module",
  "scripts": {
    "start": "node -r esm -r ts-node/register -r tsconfig-paths/register ./app.ts"
  },
  "dependencies": {
    "@tinyhttp/app": "^1.2.17",
    "@tinyhttp/logger": "^1.2.1",
    "chrome-aws-lambda": "^8.0.0",
    "http-status-codes": "^2.1.4",
    "milliparsec": "^2.0.0",
    "puppeteer-core": "^8.0.0"
  },
  "devDependencies": {
    "@types/node": "^14.14.35",
    "esm": "^3.2.25",
    "puppeteer": "^8.0.0",
    "ts-node": "^9.1.1",
    "tsconfig-paths": "^3.9.0",
    "typescript": "^4.2.3"
  }
}

the current temporary solution is to downgrade to version 1.0.4

milliparsec is an ESM-only library so you need add "type": "module" field in your package.json

milliparsec is an ESM-only library so you need add "type": "module" field in your package.json

i did, didnt work

@ac5tin does it persist with @latest? I did some module fixes so it might work now

@ac5tin does it persist with @latest? I did some module fixes so it might work now

the latest 2.0.2 doesn't work, the latest version that actually works is 1.0.4

@ac5tin it works with .mjs on Node 15.12:

import { createServer } from 'http'
import { json } from 'milliparsec'

createServer(async (req, res) => {
  const parsedData = await json()(req, res, () => {})
  res.setHeader('Content-Type', 'application/json')
  res.end(req.body.hello) // 'world'
}).listen(3000)

also works with tsc (ts 4.2.3):

// package.json

{
  "name": "app",
  "version": "1.0.0",
  "type": "module",
  "main": "index.js",
  "dependencies": {
    "milliparsec": "^2.0.2"
  },
  "devDependencies": {
    "@types/node": "^14.14.37",
    "typescript": "^4.2.3"
  }
}
// tsconfig.json

{
    "compilerOptions": {
        "module": "ESNext",
        "target": "ESNext",
        "outDir": "dist",
        "moduleResolution": "Node"
    }
}
// app.ts

import { createServer } from 'http'
import { json, ReqWithBody } from 'milliparsec'

createServer(async (req: ReqWithBody, res) => {
  const parsedData = await json()(req, res, () => {})
  res.setHeader('Content-Type', 'application/json')
  res.end((req.body).hello) // 'world'
}).listen(3000)

and then:

$ pnpx tsc
$ node dist/app.js

the error occurs because you register a lot of modules with -r (which requires them)

mb u should change smth there so it doesn't use CJS

but doesn't -r esm makes it ESM compatible?

@ac5tin try using flags in a different order

@ac5tin is the issue still present?

FYI for ts-node you can add settings in tsconfig:

  "ts-node": {
    "transpileOnly": true,
    "compilerOptions": {
      "module": "commonjs"
    }
  },

@ac5tin is the issue still present?

FYI for ts-node you can add settings in tsconfig:

  "ts-node": {
    "transpileOnly": true,
    "compilerOptions": {
      "module": "commonjs"
    }
  },

Nope, doesn't work

my tsconfig.json :

{
  "compilerOptions": {
    /* Visit https://aka.ms/tsconfig.json to read more about this file */

    /* Basic Options */
    // "incremental": true,                         /* Enable incremental compilation */
    "target": "ES2019",                                /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
    "module": "ESNext",                           /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
    "lib": ["ESNext","DOM"],                                   /* Specify library files to be included in the compilation. */
    // "allowJs": true,                             /* Allow javascript files to be compiled. */
    // "checkJs": true,                             /* Report errors in .js files. */
    // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
    // "declaration": true,                         /* Generates corresponding '.d.ts' file. */
    // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
    // "outFile": "./",                             /* Concatenate and emit output to single file. */
    "outDir": "./dist",                              /* Redirect output structure to the directory. */
    // "rootDir": "./",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
    // "composite": true,                           /* Enable project compilation */
    // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
    // "removeComments": true,                      /* Do not emit comments to output. */
    // "noEmit": true,                              /* Do not emit outputs. */
    // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
    // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
    // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

    /* Strict Type-Checking Options */
    "strict": true,                                 /* Enable all strict type-checking options. */
    // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
    // "strictNullChecks": true,                    /* Enable strict null checks. */
    // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
    // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
    // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
    // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
    // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */

    /* Additional Checks */
    // "noUnusedLocals": true,                      /* Report errors on unused locals. */
    // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
    // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
    // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
    // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */

    /* Module Resolution Options */
    "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
    "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
    "paths": {
		"@interfaces/*":["interfaces/*"],
		"@routes":["routes"],
		"@crawler/*":["crawler/*"]
	},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
    // "typeRoots": [],                             /* List of folders to include type definitions from. */
    // "types": [],                                 /* Type declaration files to be included in compilation. */
    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
    "esModuleInterop": true,                        /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */

    /* Source Map Options */
    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
    //"inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
    //"inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

    /* Experimental Options */
    "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
    "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */

    /* Advanced Options */
    //"skipLibCheck": true,                           /* Skip type checking of declaration files. */
    "forceConsistentCasingInFileNames": true        /* Disallow inconsistently-cased references to the same file. */
  },
  "ts-node": {
    "transpileOnly": true,
    "compilerOptions": {
      "module": "commonjs"
    }
  }
}

still get the following error: yarn run v1.22.10 $ node -r esm -r ts-node/register -r tsconfig-paths/register ./app.ts /home/austin/Documents/node/fbcf/node_modules/milliparsec/dist/index.js:1 Error [ERR_REQUIRE_ESM]: Must use import to load ES Module: /home/austin/Documents/node/fbcf/node_modules/milliparsec/dist/index.js at new NodeError (node:internal/errors:363:5) at Object.Module._extensions..js (node:internal/modules/cjs/loader:1125:13) error Command failed with exit code 1. info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

(got this error using milliparsec version 2.0.4

@ac5tin that happens because it runs in CJS environment. this is not related strictly to milliparsec

all esm modules will behave like that

to add, -r esm will set a fallback to cjs, so it's 100% not required here

try this instead:

NODE_OPTIONS="--no-warnings --loader ts-node/esm" ts-node index.ts

but i needed to load tsconfig-paths/register

do you know anyway to enable ESM + register tsconfig-paths at the same time?

According to the guide on tsconfig-paths , in order to enable that library i need to start my script like this : ts-node -r tsconfig-paths/register main.ts, which is why my current start script needed to include -r : node -r esm -r ts-node/register -r tsconfig-paths/register ./app.ts

if i set my start script to : "start": "NODE_OPTIONS='--no-warnings --loader ts-node/esm' ts-node ./app.ts",
i get the error :


/home/austin/Documents/node/fbm/node_modules/ts-node/dist-raw/node-esm-resolve-implementation.js:765
 throw new ERR_MODULE_NOT_FOUND(packageName, fileURLToPath(base));
       ^
Error: ERR_MODULE_NOT_FOUND @db/conn /home/austin/Documents/node/fbm/app.ts

which is probably because it didnt load the tsconfig-paths

If i add compiler options to my tsconfig:

"ts-node": {
    "transpileOnly": true,
    "compilerOptions": {
      "module": "commonjs"
    }
  },

Then i get the error :

$ NODE_OPTIONS='--no-warnings --loader ts-node/esm' ts-node ./app.ts
ReferenceError: exports is not defined in ES module scope
    at file:///home/austin/Documents/node/fbm/app.ts:25:23
    at ModuleJob.run (node:internal/modules/esm/module_job:175:25)
    at Loader.import (node:internal/modules/esm/loader:178:24)
    at Object.loadESM (node:internal/process/esm_loader:68:5)
error Command failed with exit code 1.

@ac5tin it still doesn't seem to be related to milliparsec directly

I don't know how to help you here

worth asking on tsconfig-paths repo instead