Node require absolute path

Question

I have a directory that looks like this:

-- app/    |- models/       |- user.js    |- config.json 

I want my user.js file to require config.json. Right now I'm using require('/config') but this is not working. What am I doing wrong? I'd like to avoid using require('../config').

Answer 1

The simple answer is that you aren't doing anything wrong. Per a little research, the require function looks for one of:

• a core module such as fs
• a relative filepath that you specify in your require call
• a directory search for the appropriately named module in a node_modules folder somewhere in a parent directory of the file in which the require function is called.

See: http://www.bennadel.com/blog/2169-Where-Does-Node-js-And-Require-Look-For-Modules-.htm And: http://nodejs.org/api/modules.html#loading_from_node_modules_Folders

Both resources above reference the ability to also modify a NODE_PATH environment variable, however this sounds like very bad practice and at a minimum would make your code way less portable. It also probably wouldn't even work for a file like config.json since, though I'd never done it, I'd imagine changing the NODE_PATH variable only changes where require() looks for package.json files corresponding to real modules.

In summary, see: How to make the require in node.js to be always relative to the root folder of the project? as referenced above by Piotr Kowalczuk. Per that post, you have two real options:

1. Use relative file paths.
2. Package up your desired resource as a real module with a package.json file and drop it into the node_modules folder.

Finally, just bear in mind that what you are trying to do goes against the grain of the program that you are using. I think this is one case where you will ultimately make your life easier (and your collaborators'!) by going with the grain of Node and using relative file paths as the design intends.

Answer 2

I couldn't find any better solution than to write my own module.

After testing it in some projects I have decided to make it open source.

const user = require('../../../database/user'); // 👎 what you have // OR const user = require('$db/user'); // 👍 no matter how deep you are const product = require('/database/product'); // 👍 alias or pathing from root directory 

Three simple steps to use it.

1. Install the package: npm install sexy-require --save

2. Include require('sexy-require') once on the top of your main application file.

    require('sexy-require');  const routers = require('/routers');  const api = require('$api');  ... 

3. Optional step. Path configuration can be defined in .paths file on root directory of your project.

    $db = /server/database  $api-v1 = /server/api/legacy  $api-v2 = /server/api/v2 

Anywhere in your project you can get the defined shortcut paths:

const path = require(`sexy-require`); console.log(path.$db); // -> '/full/path/to/app/server/database'