Best Require

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

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

Installation

npm install best-require --save

Introduction

Background

Have you ever coded like this in your application?

// 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:

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:

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

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

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:

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:

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:

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

Usage

Add this at the beginning of the program:

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

Then you can use:

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

Error packaging 'pkg' after project uses 'best require'

My project uses 'best require', it's work and good.
my code like this:

const bestRequire = require('best-require')
// best-require config
bestRequire(process.cwd(), {
  '@': '~/app',
  config: ':@/config',
  utils: ':@/utils',
  core: ':@/core',
  query: ':core/query'
})

but, when i use 'pkg' to packaging my project, it's return Error.
like this:

$ pkg .
> [email protected]
> Warning Cannot find module ':config' from '/Users/fungleo/Sites/Github/restful-cms-koa'
  %1: /Users/fungleo/Sites/Github/restful-cms-koa/app.js
> Warning Cannot find module ':utils/tool' from '/Users/fungleo/Sites/Github/restful-cms-koa/app'
  %1: /Users/fungleo/Sites/Github/restful-cms-koa/app/index.js
> Warning Cannot find module ':@/middle/logger' from '/Users/fungleo/Sites/Github/restful-cms-koa/app'
  %1: /Users/fungleo/Sites/Github/restful-cms-koa/app/index.js
> Warning Cannot find module ':@/middle/error' from '/Users/fungleo/Sites/Github/restful-cms-koa/app'
  %1: /Users/fungleo/Sites/Github/restful-cms-koa/app/index.js
> Warning Cannot find module ':config/config-koa-body' from '/Users/fungleo/Sites/Github/restful-cms-koa/app'
  %1: /Users/fungleo/Sites/Github/restful-cms-koa/app/index.js
> Warning Cannot find module ':@/router' from '/Users/fungleo/Sites/Github/restful-cms-koa/app'
  %1: /Users/fungleo/Sites/Github/restful-cms-koa/app/index.js

How can I solve this problem？can you help me?

my package.json

{
  "name": "restful-cms-koa",
  "version": "1.0.0",
  "description": "A small restful CMS based on koa framework",
  "main": "app.js",
  "scripts": {
    "dev": "nodemon app.js",
    "start": "node app.js"
  },
  "keywords": [
    "restful",
    "cms",
    "koa"
  ],
  "author": "fungleo",
  "license": "MIT",
  "dependencies": {
    "best-require": "^1.1.4",
    "koa": "^2.11.0",
    "koa-body": "^4.1.1",
    "koa-json": "^2.0.2",
    "koa-log4": "^2.3.2",
    "koa-router": "^8.0.8",
    "koa-static": "^5.0.0",
    "node-rsa": "^1.0.8",
    "sequelize": "^5.21.6",
    "sqlite3": "^4.1.1"
  },
  "devDependencies": {
    "eslint": "^6.8.0",
    "nodemon": "^2.0.3",
    "standard": "^14.3.3"
  },
  "pkg": {
    "output": "restful-cms-koa",
    "targets": [
      "node10-macos-x64"
    ]
  },
  "bin": "app.js"
}

my English is very poor, -_-|||

zhihanyue / best-require Goto Github PK

best-require's Introduction

Best Require

Installation

Introduction

Background

Solution

Usage

best-require's People

Contributors

Stargazers

Watchers

Forkers

best-require's Issues

Error packaging 'pkg' after project uses 'best require'

Nest 使用 import 找不到模块

小小的建议

大佬，使用test时，如何使用best-require呢？

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent