ChatGPT解决这个技术问题 Extra ChatGPT

How do I resolve "Cannot find module" error using Node.js?

After pulling down a module from GitHub and following the instructions to build it, I try pulling it into an existing project using:

> npm install ../faye

This appears to do the trick:

> npm list
/home/dave/src/server
└─┬ faye@0.7.1
  ├── cookiejar@1.3.0
  ├── hiredis@0.1.13
  └── redis@0.7.1

But Node.js can't find the module:

> node app.js
node.js:201
        throw e; // process.nextTick error, or 'error' event on first tick
              ^
Error: Cannot find module 'faye'
    at Function._resolveFilename (module.js:334:11)
    at Function._load (module.js:279:25)
    at Module.require (module.js:357:17)
    at require (module.js:368:17)
    at Object.<anonymous> (/home/dave/src/server/app.js:2:12)
    at Module._compile (module.js:432:26)
    at Object..js (module.js:450:10)
    at Module.load (module.js:351:31)
    at Function._load (module.js:310:12)
    at Array.0 (module.js:470:10)

I really want to understand what is going on here, but I'm at a bit of a loss as to where to look next. Any suggestions?

The node_modules directory is expected to be in the root of your project, alongisde app.js in your case. Why did you use .. the npm install path?
After changing "npm install ../faye" to "npm install ../faye/build", it works as expected. I don't know how typical this is, but faye creates a build directory when it is built and puts a copy of package.json in there. npm doesn't complain about package.json at the root level, but it references files that don't exist at that level.
I solved the problem, but didn't really get any resolution to my real question, which was how to troubleshoot this issue. I'll try to come up with some suggestions for improving npm and/or node to make it easier for newcomers to avoid this situation.
Go through this Link, you may get some idea like where exactly its failing to lookup your modules..
Check weather you are in the same folder where you installed it ? if you did not installed it globally .

C
Charlie Bamford

Using npm install installs the module into the current directory only (in a subdirectory called node_modules). Is app.js located under home/dave/src/server/? If not and you want to use the module from any directory, you need to install it globally using npm install -g.

I usually install most packages locally so that they get checked in along with my project code.

Update (8/2019):

Nowadays you can use package-lock.json file, which is automatically generated when npm modifies your node_modules directory. Therefore you can leave out checking in packages, because the package-lock.json tracks the exact versions of your node_modules, you're currently using. To install packages from package-lock.json instead of package.json use the command npm ci.

Update (3/2016):

I've received a lot of flak for my response, specifically that I check in the packages that my code depends on. A few days ago, somebody unpublished all of their packages (https://kodfabrik.com/journal/i-ve-just-liberated-my-modules) which broke React, Babel, and just about everything else. Hopefully it's clear now that if you have production code, you can't rely on NPM actually maintaining your dependencies for you.


"I usually install most packages locally so that they get checked in along with my project code." It's usually better to make a package.json listing what npm modules you depend on and ignore the node_modules folder. Then simply npm install to get setup after you clone the repo.
In addition to package.json listing the dependencies, I like to keep known good copies of things that I depend on. Disk space is cheap and if npm or the package disappears from npm, I'll still have a fully working project in my repo.
As an old developer I nearly choked when I read the Node devs "paradigm" that "disk space is cheap". I have libraries that I am using. The idea that I might have 100 copies (or worse, NEAR copies) makes my stomach turn. Disk space is cheap, but maintenance time is expensive. Perhaps if you are doing a one-off toy project, maintenance is cheap. For real work, however, maintenance is expensive and has no bearing on the cost of disk space.
I really don't understand this last comment. Nobody is saying to have 100 copies of any piece of code, just to have 1 copy of the code that your project depends on. The alternative is to have a non-functional project if NPM or the dependency disappears one day. I would think re-writing a dependency from scratch is also pretty expensive. As an aside, I worked at Microsoft for 10 years and we always had 3rd party dependencies checked into our source tree.
@LloydSargent Having "NEAR copies" isn't worse, it's better, because each project has a specific dependency, that you've defined, and the rest of your code relies on. If you had the same versions across multiple projects then if you update anything you must update everything. Pinning dependencies allows piecemeal upgrades-substantially less maintenance. Real work, non-toy projects.
P
Peter Mortensen

I had a very similar issue. Removing the entire node_modules folder and re-installing worked for me:

rm -rf node_modules
npm install

I would also do a npm cache clean, just as a safety thing :)
Probably a good first troubleshooting step whenever a weird dependency issue pops up that npm install/npm update won't solve. This solved an issue where Error: Cannot find module 'http-errors' randomly started showing when I tried to run my Express app.
Amazing, @carelesslyChoosy's answer resolved a missing dependency. It seems upgrading and downgrading with npm install in place does not keep things tidy.
A missing step here is to remove your package-lock.json file before running npm install.
npm ci will do the same thing but is x-platform
b
bruntime
npm install --save module_name

For example, if the error is:

{ [Error: Cannot find module '/root/.npm/form-data'] code: 'MODULE_NOT_FOUND' }

then you can resolve this issue by executing the command npm install --save form-data.


it seems like when i installed it globally the npm/node-modules folder was empty and i was trying to use ng new project-name it was showing some modules missing ... I had to install them each using the given command.Then it solved the issue but is there any single command to install all of the them at once ?
m
mgthomas99

For TypeScript users, if you are importing a built-in Node module (such as http, path or url) and you are getting an error such as "Cannot find module "x" then the error can be fixed by running

npm install @types/node --save-dev

The command will import the NodeJS TypeScript definitions into your project, allowing you to use Node's built-in modules.


X
Xakiru
rm package-lock.json
rm -r node_modules
npm i

That should fix issue and install all packages.


Great help, thanks
P
Peter Mortensen

This happens when a first npm install has crashed for some reason (SIGINT of npm), or that the delay was too long, or data is corrupted. Trying an npm install again won't save the problem.

Something got wrong on the npm first check, so the best choice is to remove the file and to restart npm install.


this diagnosed the problem for me. i ended up doing npm cache clear and clearing out node_modules followed by npm install to fix my issue.
u
ukosteopath

I experienced this error yesterday. Took me a while to realise that the main entry in package.json was pointing to a file that I'd moved. Once I updated that the error disappeared and the package worked.


Holy cow...out of desperation I typed in "Error: Cannot find module" into google, and found this question. Your answer fixed my problem. I can't believe such a vague search term turned up the right answer. Kudos to you and to Google!
Very much this. I had managed to point the main entry for my submodule in a directory that was excluded from its repository so when I tried to include it via npm install it worked, but no exports were found when required in! Many thanks for this obvious but useful answer.
Thanks for this. I had this situation whilst using Yarn workspaces, so was looking all over for path resolution algorithms and all sorts. :) I was thrown by the way the error message talks of 'locating' the module, and also that ESLint was giving similar error messages. And then I saw your answer and realised I was a dimwit. Thanks!
E
Edgar Chavolla

Check if the enviroment variable NODE_PATH is set correctly and pointing to the node_modules path. nodejs uses this variable to search for the libraries


I upvoted this as it solved my immediate problem, and led me to this node.js documentation. But I think this is not a blanket answer, as the documentation indicates alternative strategies for locating modules.
P
Peter Mortensen

If you use nvm, check that existing node_modules that are bindings to other libraries are compiled for the correct Node.js version.

I was having the same error. The reason was the following: We use nvm since we're running two apps on a server, one requires Node.js 5.6 because it uses node-gd (which doesn't run on Node.js 6 for now), the other requires Node.js 6. Node.js 6 is the apt-get installation.

Also we use the pm2 tool to deploy.

So, the default setup is that the pm2 process starts when nvm is not in effect, so it uses the apt-get installation of Node.js (version 6). So the main pm2 daemon starts with Node.js 6. If I run applications in fork mode they start in separate processes and nvm settings are in effect. When I run applications in cluster mode - they inherit the non-nvm environment.

So when I tried to switch to the cluster mode the application failed to start because the bindings compiled for 5.6 fail with this message.

I've fixed that by restarting pm2 when nvm setings are in effect. Also startup scripts should be fixed.


M
MrCranky

This error can be encountered if you are requireing a module that has a missing or incorrect main field in its package.json. Though the module itself is installed, npm/node has to use a single .js file as an entrypoint to your module. If the main field is not there, it defaults to looking for index.js in your module's folder. If your module's main file is not called index.js, it won't be able to require it.

Discovered while turning a browserify-based module into a CommonJS require-able module; browserify didn't care about the missing main field, and so the error had gone unnoticed.


j
james ace

If all other methods are not working for you... Try

npm link package_name

e.g

npm link webpack
npm link autoprefixer

e.t.c


An explanation would be appreciated!
Explain, someone!
P
PrashanthiDevi

Remove your node_module root folder from your project(eg: myApp). Go to myApp folder and then type below command from terminal

>myApp>npm install

It will install all the dependency modules required for your project.


Could you please elaborate more your answer adding a little more description about the solution you provide?
D
Dave

PRO TIP:

This error happened to me, while fighting fatigue and mild illness, because I typed node blah instead of npm blah.

The error message received wasn't angry enough to alert me to my own folly!


S
Srishti Singh

Specify the path to the restler folder, which will be inside node_modules folder like : var rest = require('./node_modules/restler');

This worked for me.


m
martinp999

I can add one more place to check; the package that I was trying to use was another one of my own packages that I had published to a private NPM repo. I had forgotten to configure the 'main' property in the package.json properly. So, the package was there in the node_modules folder of the consuming package, but I was getting "cannot find module". Took me a few minutes to realise my blunder. :-(


K
Kartik Garasia

If you are using typescript and getting an error after installing all node modules then remove package-lock.json. And then run npm install.


Y
Yevgeny Simkin

Just found an unusual scenario that may be of use to someone and is sort of a red herring.

I was also getting the Cannot Find Module error but oddly everything worked perfectly in my local (Mac hosted) Node.js environment. This problem only appeared when the code was deployed on our Linux server.

Well... it turned out to be a typo that (apparently) the Mac based Node.js installation was perfectly happy to ignore.

The include looked like this:

var S3Uploader = require('./S3Uploader.class');

But the actual file was called "s3Uploader.class.js"

Notice the casing difference in the 's' vs. 'S' between the code and the filename.

So - in the odd chance that none of the other solutions here are solving your problem, triple check that you're not mis-casing the characters in your included filename! :)

and DUH!


By default osx filesystem (HFS+) is case insensitive ... discovered not long ago, it's definitely configurable though
U
Ursu Alexandr

In my case I had UNMET PEER DEPENDENCY redux@^3.0.0 causing this error message, see all of them and install missing modules again using --save

npm install redux --save

K
Kal

Removing node/npm and then re-installing the stable(not the latest) version worked for me.

sudo rm -rf /usr/local/{lib/node{,/.npm,_modules},bin,share/man}/{npm*,node*,man1/node*}

https://nodejs.org/en/download/

J
JGFMK

I had this issue using live-server (using the Fullstack React book):

I kept getting:

Error: Cannot find module './disable-browser-cache.js' ...

I had to tweak my package.json

From: "scripts": { ... "server": "live-server public --host=localhost --port=3000 --middleware=./disable-browser-cache.js" ... } "scripts": {

To: ... "server": "live-server public --host=localhost --port=3000 --middleware=../../disable-browser-cache.js" ... }

Notice relative paths seem broken/awkward... ./ becomes ../../

I found the issue here

Also if anyone follows along with that book:

change devDependencies in packages.json to:

"live-server": "https://github.com/tapio/live-server/tarball/master"

Currently that upgrades from v1.2.0 to v1.2.1

It's good to use nvm. It's best to install v13.14 of Node (*v14+ creates other headaches) nvm install v13.14.0 nvm alias default v13.14.0 Update npm with npm i -g npm@7.3.0 run: npm update you can use npm list to see the hierarchy of dependencies too. (For some reason node 15 + latest npm defaults to only showing first level of depth - a la package.json. That renders default command pointless! You can append --depth=n) to make command more useful again). you can use npm audit too. There issues requiring (update of chokidar and some others packages) to newer versions. live-server hasn't been updated to support the newer corresponding node v 14 library versions.

See similar post here

Footnote: Another thing when you get to the JSX section, check out my answer here: https://stackoverflow.com/a/65430910/495157

When you get to:

Advanced Component Configuration with props, state, and children. P182+, node version 13 isn't supported for some of the dependencies there.

Will add findings for that later too.


x
xpagesbeast

In my case,

npm install -D tslib @types/node

solved my problem, I was then able to run

ts-node index.ts

successfully.


B
Belgor

I was trying to publish my own package and then include it in another project. I had that issue because of how I've built the first module. Im using ES2015 export to create the module, e.g lets say the module looks like that:

export default function(who = 'world'){
    return `Hello ${who}`;
}

After compiled with Babel and before been published:

'use strict';

Object.defineProperty(exports, "__esModule", {
    value: true
});

exports.default = function () {
    var who = arguments.length <= 0 || arguments[0] === undefined ? 'world' : arguments[0];


    return 'Hello ' + who;
};

So after npm install module-name in another project (none ES2015) i had to do

var hello = require('module-name').default;

To actually got the package imported.

Hope that helps!


C
Chris

Encountered this problem while using webpack with webpack-dev-middleware.

Had turned a single file into a folder.

The watcher seemed to not see the new folder and the module was now missing.

Fixed by restarting the process.


M
Mohammed Abo-zaid

Maybe like me you set 'view engine' in express to an engine that doesn't exist, or tried to use an unregistered templating engine. Make sure that you use: app.engine('engine name',engine) app.set('view engine','engine name')


m
maverick

In my case, i was not using the proper version of nvm.


s
skygate

A rare but also possible case is a typo in the module name. I missed the "s" in the file name when executing node .\util.js, where it should be node.\utils.js and didn't find any solution among all the answers under this question until I found out that I can't run the file even if I delete everything!


D
DerpyNerd

Apparently, judging by this question, there are a LOT of possible causes.

Maybe this will help someone, hoping nobody was as stupid as I was to use this technique:

Check if you have any node_modules folder up the folder tree.

Scenario 1: If you ever had a projects folder, where you shared a node_modules folder between multiple projects, you may not have had any problems

|- projects
| |- node_modules     <- OK
| |- project1         <- No node_modules folder
| | |- package.json
| |- project2         <- No node_modules folder
| | |- package.json

Scenario 2: If you add a third project of a different nature, you may choose to keep a node_modules folder in that project:

|- projects
| |- node_modules     <- Can be used by project 3
| |- project1         <- No node_modules folder
| | |- package.json
| |- project2         <- No node_modules folder
| | |- package.json
| |- project3
| | |- node_modules   <- Packages for project 3 only
| | |- package.json

I'm guessing some packages in project 3's node-modules folder are relying on packages that it finds (or doesn't find) in the parent folder's node_modules folder. Even though you'd expect the dependencies to be found in project 3's node_modules folder. Maybe it's because of the way some packages are imported and referenced?

Goes without saying that's a disaster waiting to happen :)


m
majestzim

I ran into this issue when I was upgrading the node version along with installing several different package versions. The project created a docker image/container to work in.

The issue was that the Docker image wasn't recreated when I added a package and rebuilt the project. The proper information had been in my local package.json and package-lock.json files.

Deleting the Docker image and not just the container solved my problem.


S
Soumya Kanti

I faced the same problem when someone else in the team updated package.json in SVN. Merely removing the node_modules directory did not help. How I solved the problem is:

rm -rf node_modules
rm package.json
rm package-lock.json
svn up
npm install
ng build --env=prod

Hope this helps someone!


Thanks for the reminder. In my case it was package-lock.json messing things up again but after deleting it and node_modules then running npm install all is well again.
If you remove package.json how does NPM know what to install?
A
Akash Limbani

Please install the new CLI v3 (npm install -g ionic@latest).

If this issue is still a problem in CLI v3. Thank you!