https://github.com/chrisyip/requere
Better way to require file in node
https://github.com/chrisyip/requere
Last synced: about 1 year ago
JSON representation
Better way to require file in node
- Host: GitHub
- URL: https://github.com/chrisyip/requere
- Owner: chrisyip
- License: mit
- Created: 2015-04-09T07:57:31.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2017-03-13T19:56:24.000Z (over 9 years ago)
- Last Synced: 2025-05-14T22:12:17.319Z (about 1 year ago)
- Language: JavaScript
- Size: 24.4 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# requere
[![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Travis CI][travis-image]][travis-url] [![Coveralls][coveralls-image]][coveralls-url]
Better way to load modules in node.
# What is `requere`
`requere` is a package that avoid ugly path when loading modules in node.
For example:
```
config.js
lib/
foo/
bar/
foobar.js
```
If you wanna use `config.js` in `foobar.js`, you might write code like this:
```js
const config = require('../../../config.js')
```
Yes, you have to figure out how many `../` out there.
But with `requere`:
```js
const config = require('requere')('config.js')
```
Yes, simple.
## glob
`requere` supports [`glob`](https://github.com/isaacs/node-glob).
```js
requere(pattern, onlySupportedExtname)
// Example
requere('foo/bar/**/*.js')
```
Returns an object with loaded modules, module's full path will be the key:
```js
{
'/path/to/foo.js': exported
}
```
### `onlySupportedExtname`
If `onlySupportedExtname` is `true`, `requere` will only load modules with supported extname.
You can check supported extnames by `require.extensions` and `requere.extensions`.
For example:
```
foo/
bar/
baz.jpg
foobar.js
```
`requere('foo/bar/*')` will throw errors, but `requere('foo/bar/*', true)` will not throw errors and return `foobar.js`.
## How to Use
Install via [npm](https://www.npmjs.com/):
```
npm install requere
```
```js
const requere = require('requere')
// Loading a npm package
const path = requere('path')
// Loading a file module
const foo = requere('./foo')
// Loading a file module from package root folder
const bar = requere('foobar/bar')
// Loading with glob pattern
const modules = requere('baz/**/*.@(js|json)')
// Loading with custom module loader
requere.register('.cson', requere('cson').load.bind(requere('cson')))
requere('config/*.cson')
```
## Require Hook (deprecated)
Requere hook is buggy, so, it's deprecated.
# Contributors
Via [GitHub](https://github.com/chrisyip/requere/graphs/contributors)
[npm-url]: https://npmjs.org/package/requere
[npm-image]: http://img.shields.io/npm/v/requere.svg?style=flat-square
[daviddm-url]: https://david-dm.org/chrisyip/requere
[daviddm-image]: https://david-dm.org/chrisyip/requere.svg?style=flat-square
[travis-url]: https://travis-ci.org/chrisyip/requere
[travis-image]: http://img.shields.io/travis/chrisyip/requere.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/chrisyip/requere
[coveralls-image]: http://img.shields.io/coveralls/chrisyip/requere.svg?style=flat-square