Skip to content

Commit

Permalink
fix: main field in package.json should correspond to cjs artifacts
Browse files Browse the repository at this point in the history
When axios#4787 was implemented, the project was switched to `"type": "module"` and "./index.js" became an esm file instead of commonjs, however, the "main" entry in package.json still points to "index.js". As a result, consumers using this field may get unexpected behavior since the main field is supposed to be commonjs if the entry is provided.

Many consumers won't run into this as a practical problem (for example when just doing `const axios = require('axios').default` from inside of a cjs file in node) because the "exports" map takes precedence over the main/module fields, but tools that don't parse the object map when resolving still run into problems here.

The fix for this is to just point the "main" entry-point to the commonjs artifacts located at "./dist/node/index.cjs".

I also added a module entrypoint to improve compatability for the cases where the export map is not used (webpack 4 for example) since that would likely be reading the cjs "main" entrypoint now that main has switched back to cjs.
  • Loading branch information
thebanjomatic committed Oct 5, 2023
1 parent a48a63a commit 7a60e50
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion package.json
Expand Up @@ -2,7 +2,8 @@
"name": "axios",
"version": "1.5.1",
"description": "Promise based HTTP client for the browser and node.js",
"main": "index.js",
"main": "./dist/node/axios.cjs",
"module": "./index.js",
"exports": {
".": {
"types": {
Expand Down

0 comments on commit 7a60e50

Please sign in to comment.