Require global modules like a boss
Require global modules in node.js like a boss
requireg tries to find modules in global locations which are
not natively supported by the node.js module resolve algorithm.
- $HOME/node_modules (instead of $HOME/.node_modules)
- $HOME/node_libraries (instead of $HOME/.node_libraries)
- $HOME/node_packages (specific of
- $PREFIX/lib/node_modules (instead of $PREFIX/lib/node)
- $NODE_MODULES (use the specific modules path environment variable)
- Resolve via native
- User home directory (
- Node installation path
- $NODE_MODULES (can have different multiple paths, semicolon separated)
- Common operative system installation paths
$ npm install requireg --save[-dev]
var requireg = require'requireg'// require a globally installed packagevar npm = requireg'npm'
var modulePath = requiregresolve'npm'// returns '/usr/local/lib/node_modules/npm/lib/npm.js'
Now it is globally available from any source file
var globalModule = requireg'npm'
requireg maintains the same behavior as the native
It will throw an
Error exception if the module was not found
- Require global modules in node.js are considered anti-pattern.
Note that you can experiment unreliability or inconsistency across different environments.
I hope you know exactly what you do with
- Only node packages installed with NPM are supported (which means only standardized NPM paths are supported)
- Custom environment variable with custom path to resolve global modules
- Possible configuration object (force to use only global modules...)
Released under MIT license