node.js local modules :cannot find module error

Question

I am trying to implement local modules in my application

1.Project root folder i have created folder named test with a file named index.js

      module.exports  = {

     myFunction:function(){
       console.log('ok');
     }
}

2.Added the following in package.json in the root folder

"dependencies": { 
    "test-module": "file:test"
  }

3.When i try to import var module = require('test-module'); in app.js i got this error

Cannot find module 'test-module'

I'm having the very same issue right now. It's weird because the module sits there in node_modules folder. Not sure why. — krisanalfa
– krisanalfa, Commented Aug 5, 2019 at 5:42
I think you missed the main section in your package.json inside the test-module package. — krisanalfa
– krisanalfa, Commented Aug 5, 2019 at 5:51

Marcello B. · Accepted Answer · 2020-08-14 05:10:14Z

3

you can provide a path to a local directory that contains a package

{
  "name": "baz",
  "dependencies": {
    "bar": "file:../foo/bar"
  }
}

and perform npm install -s or npm install --save reference

edited Aug 14, 2020 at 5:10

Marcello B.

4,47011 gold badges48 silver badges72 bronze badges

answered Feb 26, 2018 at 13:10

Akhilesh krishnan

7992 gold badges8 silver badges23 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Daniel Conde Marin · Accepted Answer · 2018-02-26 13:16:32Z

0

To add on @Blaze answer, if you follow the steps (Local Paths) to install a local module, it will sort out for you the local dependency in your package.json:

npm i ./test --save

That will produce the correct local dependency entry in your dependencies in the root package.json:

"test-module": "file:test"

assuming test-module is the name in the local dep package.json.

This is how it should look like:

edited Feb 26, 2018 at 13:16

answered Feb 26, 2018 at 13:11

Daniel Conde Marin

7,7324 gold badges38 silver badges44 bronze badges

6 Comments

shamon shamsudeen Over a year ago

Now the module not found error is gone but i got another error app.set not a function

Daniel Conde Marin Over a year ago

@iambatman: That would be a completely different problem :) I suggest you open another question for that one.

shamon shamsudeen Over a year ago

If i removed the import its gone

Daniel Conde Marin Over a year ago

What's on your test-module? Sounds like there is an app.set which is not in the original question

shamon shamsudeen Over a year ago

It contains a index.js file with a function i 've included that in the question

|

Soubhik Mondal · Accepted Answer · 2018-02-26 13:19:05Z

0

Make sure your test folder has a package.json.

test/package.json should have a "name" field with the value "test-module" (ie, same name as the dependency in your root package.json.

My files:

test/package.json

{
  "name": "test-module",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

test/index.js

module.exports = {
  t:() => console.log('t')
};

package.json

{
  "name": "t",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "test-module": "file:test"
  }
}

app.js

t = require('test-module');
t.t();

This is working for me.

edited Feb 26, 2018 at 13:19

answered Feb 26, 2018 at 13:08

Soubhik Mondal

2,6661 gold badge15 silver badges19 bronze badges

7 Comments

shamon shamsudeen Over a year ago

Do i need to install anyother packages??

Soubhik Mondal Over a year ago

No, you don't need any other packages. I tried exactly your code, and it worked for me. The only issue I got was when the name field was different.

Soubhik Mondal Over a year ago

I updated my answer to show all the files in my example. Can you show us the file structure inside node_modules folder?

shamon shamsudeen Over a year ago

my test folder is not in the node_modules folder do i need to add manually in it??

Soubhik Mondal Over a year ago

no, you have to npm install or npm i from the root folder. That will automatically generate the node_modules folder with your test-module inside it.

|

Collectives™ on Stack Overflow

node.js local modules :cannot find module error

3 Answers 3

Comments

6 Comments

7 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

6 Comments

7 Comments

Your Answer

Sign up or log in

Post as a guest

Related