node@14.16.0 Error [ERR_REQUIRE_ESM]

[GuoSirius]

node: 14.16.0
electron: 13.0.1
webpack: 4.46.0

import { Low, JSONFile } from 'lowdb'

const adapter = new JSONFile('example.json')

export const lowdb = new Low(adapter)

The above code run error, ERR_REQUIRE_ESM has been prompted, what is the solution?

[GuoSirius]

https://pencilflip.medium.com/using-es-modules-with-commonjs-modules-in-node-js-1015786dab03

[jordan-loeser]

Convenient timing, I'm also seeing this issue.

[rafagets]

I have the same problem.

[istomyang]

Here some solutions:

1. Download source code zip, change into "module": "commonjs" in tsconfig.json, run build and put project into your node_modules, you can remove src dict manually.
2. Maintaining by youself and put into your packages if you are using lerna to manage your project.
3. Hey, dear author. Could you publish a package with commonjs for my piteous ts-node, whose esm support is Experimental. Please, and thank you!

[giovannefeitosa]

I'm having the same issue here...

[Gitter499]

Same issue here, very annoying

[dankreiger]

I opened a PR opened here to address this issue.

---

You can test it by installing the package from PR's lib branch

npm

npm install github:dankreiger/lowdb#chore/esm-cjs-hybrid-WITH-LIB 

yarn

yarn add github:dankreiger/lowdb#chore/esm-cjs-hybrid-WITH-LIB

[SystemFiles]

@dankreiger, god bless your soul

[Freddixx]

@dankreiger Nice one, thank you! Works like a charm!

[ste163]

@dankreiger Thank you! Working well :)

[ckcr4lyf]

Aces, thanks mate

[xdoer]

same problem

[borsTiHD]

Same problem here. My workaround was rewriting my hole code to esm syntax (I'm glad I did that) and it works in my dev environment, but I have a new problem. I want to use webpack 5 to bundle my express+lowdb app. My bundled index.cjs uses require again and crashs because of lowdb Error [ERR_REQUIRE_ESM]: ....

Does anyone have a solution for me? Can I reconfigure webpack to build with "import" syntax?

webpack.config.js

import path from 'path'
import { fileURLToPath } from 'url'
import nodeExternals from 'webpack-node-externals'

const __dirname = path.dirname(fileURLToPath(import.meta.url))
const { NODE_ENV = 'production' } = process.env

export default {
    entry: './src/api/app.js',
    mode: NODE_ENV,
    // target: 'node',
    output: {
        path: path.resolve(__dirname, 'dist', 'server'),
        filename: 'index.js'
    },
    resolve: {
        extensions: ['.ts', '.js']
    },
    externalsPresets: { node: true }, // in order to ignore built-in modules like path, fs, etc.
    externals: [nodeExternals()] // in order to ignore all modules in node_modules folder
}

Edit:
I found a solution for my problem. I'm bundling lowdb.
Changing my webpack.config: externals: [nodeExternals({ allowlist: ['lowdb'] })]

[typicode]

Closing as I prefer to keep v2 a pure ESM package. I'm aware not every project can migrate to ESM right now, but tools and libraries are catching up. If possible, I'd recommend migrating your project to ESM.

For anyone looking to fix the error, please follow this excellent guide:
https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[carlos-burelo]

I have the same problem with typescript, but I can't use the "type": "module", because it doesn't recognize the ".ts" extension, any solution so far?

[Gitter499]

@carlos-burelo Make sure to have ESM modules configured in your tsconfig.json file. It should be on a property called module

[njfamirm]

@dankreiger thank you :))))

[i5hi]

@dankreiger thank you soo much!!!

@typicode please consider merging the PR that supports cjs. Most off your users have upvoted @dankreiger and down voted your choice to stick with pure ESM. Please consider majority users.

[i5hi]

I trust your judgement, as I am not fully aware of the implications of supporting cjs. If it doesnt create any breaking changes, please consider.

Thanks for your work!