Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/h2non/requireg
Resolve and require local & global modules in node.js like a boss
https://github.com/h2non/requireg
global import modules node path require resolve
Last synced: 3 days ago
JSON representation
Resolve and require local & global modules in node.js like a boss
- Host: GitHub
- URL: https://github.com/h2non/requireg
- Owner: h2non
- License: mit
- Created: 2013-12-02T10:27:35.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2022-03-01T02:16:25.000Z (almost 3 years ago)
- Last Synced: 2024-12-25T19:33:02.569Z (8 days ago)
- Topics: global, import, modules, node, path, require, resolve
- Language: JavaScript
- Homepage:
- Size: 40 KB
- Stars: 45
- Watchers: 2
- Forks: 14
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# requireg [][2] [][3]
Require and resolve global modules in node.js like a boss.
## Differences with require()
`requireg` tries to find modules in global locations which are
not natively supported by the node.js [module resolve algorithm][1].
It supports both npm/yarn global packages installation paths.
Supported locations:
- $HOME/node_modules (instead of $HOME/.node_modules)
- $HOME/node_libraries (instead of $HOME/.node_libraries)
- $HOME/node_packages (specific of `requireg`)
- $PREFIX/lib/node_modules (instead of $PREFIX/lib/node)
- $NODE_MODULES (use the specific modules path environment variable)
## Resolution priority
1. Resolve via native `require()` (unless second parameter is true)
2. User home directory (`$HOME` or `%USERPROFILE%`)
3. Node installation path
4. $NODE_MODULES (can have different multiple paths, semicolon separated)
5. Common operative system installation paths
## Installation
```bash
$ npm install requireg --save[-dev]
```
```bash
$ yarn add requireg
```
## API
### requireg(path: string, onlyGlobal: boolean = false)
## Usage
### Load global modules
```js
var requireg = require('requireg')
// require a globally installed package
var npm = requireg('npm')
```
### Load only global modules
```js
var requireg = require('requireg')
// require a globally installed package and skip local packages
var eslint = requireg('eslint', true)
```
### Resolve module path
```js
var modulePath = requireg.resolve('npm')
// returns '/usr/local/lib/node_modules/npm/lib/npm.js'
```
### Globalize it
```js
require('requireg').globalize()
```
Now it is globally available from any source file
```js
var globalModule = requireg('npm')
```
### Module not found
`requireg` maintains the same behavior as the native `require()`.
It will throw an `Error` exception if the module was not found
## Considerations
- Require global modules in node.js is considered anti-pattern.
Note that you can experiment unreliability or inconsistency across different environments.
I hope you know exactly what you do with `requireg`
- Only node packages installed with [npm](https://npmjs.org) or [yarn](https://yarnpkg.com) are supported (which means only standardized NPM paths are supported)
## Possible extra features
- Custom environment variable with custom path to resolve global modules.
## License
Released under MIT license
[1]: http://nodejs.org/docs/latest/api/modules.html#modules_all_together
[2]: http://travis-ci.org/h2non/requireg
[3]: http://badge.fury.io/js/requireg