# best-require

> A require() hook plugin for requiring a module in your project elegantly for Node.js

Latest version **1.1.4** (published 2018-07-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install best-require
pnpm add best-require
yarn add best-require
bun add best-require
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.4 |
| Published | 2018-07-26 |
| First published | 2018-02-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 9.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Zhihan Yue |
| Maintainers | yuezhihan |
| Keywords | require, hook, path |

## Links

- npm: https://www.npmjs.com/package/best-require
- Repository: https://github.com/yuezhihan/best-require
- Homepage: https://github.com/yuezhihan/best-require#readme
- Issues: https://github.com/yuezhihan/best-require/issues
- npm.io page: https://npm.io/package/best-require

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.1.4 (latest) — 2018-07-26
- 1.1.3 — 2018-03-06
- 1.1.2 — 2018-02-28
- 1.1.1 — 2018-02-26
- 1.1.0 — 2018-02-26
- 1.0.2 — 2018-02-20
- 1.0.1 — 2018-02-20

## README

[![Build Status](https://travis-ci.org/yuezhihan/best-require.svg)](https://travis-ci.org/yuezhihan/best-require)
[![NPM version](https://img.shields.io/npm/v/best-require.svg)](https://www.npmjs.com/package/best-require)

Best Require
=============

**Best Require** is a `require()` hook plugin for requiring a module in your project elegantly for Node.js.

```js
require(':controllers/posts');
require(':models/Users');
require('~/application/apis/config');
```

Installation
-------------

```bash
npm install best-require --save
```

Introduction
-------------

#### Background

Have you ever coded like this in your application?

```js
// require the 'posts' module
require('./posts');
require('./controllers/posts');
require('../controllers/posts');
require('../../controllers/posts');
require('../../../apis/controllers/posts');
```

When our project contains many layers of directory, the relative path of each module will become complicated, which not only makes us very confused, but also makes the project difficult to maintain.

When faced with the problem, you might tend to find a unified way to access the `posts` module, just like me. I used to require modules in this way:

```js
require(ROOT_PATH + '/application/apis/controllers/posts');
// other require()...
require(ROOT_PATH + '/application/apis/controllers/users');
require(ROOT_PATH + '/application/apis/controllers/products');
require(ROOT_PATH + '/application/apis/services/rest');
require(ROOT_PATH + '/application/apis/config');
```

ummmm... It's more maintainable than before. But, `ROOT_PATH` is ugly, isn't it?

#### Solution

Let's try to use **Best Require**, by adding this at the beginning of the app:

```js
require('best-require')(process.cwd())
```

Now, we can use `~` to represent `process.cwd()` in the path:

```js
require('~/application/apis/controllers/posts');
require('~/application/apis/controllers/users');
require('~/application/apis/controllers/products');
require('~/application/apis/services/rest');
require('~/application/apis/config');
```

However, this directory name is still a bit long, which can be shortened by defining the name mapping:

```js
const ROOT_PATH = process.cwd();
require('best-require')(ROOT_PATH, {
    apis: ROOT_PATH + '/application/apis',
    controllers: ROOT_PATH + '/application/apis/controllers'
});
```

Then we are able to use `:apis` for `~/application/apis` and `:controllers` for `~/application/apis/controllers`:

```js
require(':controllers/posts');
require(':controllers/users');
require(':controllers/products');
require(':apis/services/rest');
require(':apis/config');
```

With the release V1.1+, you can also use other keys in the definition of a key-value pair in the name mapping, and our plug-in will automatically handle the keys' dependencies on each other. Therefore, the definition can be simplified as:

```js
require('best-require')(ROOT_PATH, {
    apis: '~/application/apis',
    controllers: ':apis/controllers'
});
```


Usage
------

Add this at the beginning of the program:

```js
require('best-require')(
    root_path, // [optional] project root directory, defaults to `process.cwd()`
    name_mapping // [optional] name mapping
)();
```

Then you can use:

```js
require('~/(path)'); // require(root_path + '/(path)');
require(':key/(path)'); // require(name_mapping[key] + '/(path)');
```

---
_Source: https://npm.io/package/best-require · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._