Merge branch 'release/1.1.4'

Author: shirohana

.eslintrc-ava.js

@@ -0,0 +1,5 @@
+module.exports = {
+  root: true,
+  plugins: ['ava'],
+  extends: 'plugin:ava/recommended'
+}

.eslintrc.js

@@ -6,3 +6,7 @@ node_modules
 
 # Compiled files
 dist
+
+# Coverage
+coverage
+.nyc_output

.gitignore

@@ -0,0 +1,11 @@
+language: node_js
+node_js:
+  - "8"
+  - "6"
+  - "4"
+install:
+  - yarn install
+script:
+  - yarn run test
+after_success:
+  - yarn run coverage

.travis.yml

@@ -1,36 +1,71 @@
 native-require
 ==============
-*Resolve requires in easy way*
+
+*Resolve requires in an easy way*
+
+[![npm](https://img.shields.io/npm/v/native-require.svg)](https://www.npmjs.com/package/native-require)
+[![Travis](https://img.shields.io/travis/shirohana/native-require.svg)](https://www.npmjs.com/package/native-require)
+[![Codecov branch](https://img.shields.io/codecov/c/github/shirohana/native-require/dev.svg)](https://codecov.io/gh/shirohana/native-require/branch/dev)
+[![license](https://img.shields.io/github/license/shirohana/native-require.svg)](https://www.npmjs.com/package/native-require)
+
+[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)
 
 Getting started
 ---------------
 
-```sh
-$ npm install native-require --save-dev
+##### Install
+```
+$ npm install native-require --save
 ```
 
-#### Require or Resolve from where you want
-
+##### Require or Resolve from where you want
 ```javascript
-import nrequire from 'native-require'
+import _require from 'native-require'
 
-// Normal use but helpful to require externals
-const axios = nrequire('axios')
+// Seems normal but useful to resolve external modules when using bunlders
+const axios = _require('axios')
 
-// Require from specified basedir
-const model = nrequire.from('./src/model')
+// Require from specific directory
+const model = _require.from('./src/model')
 
 const User = model('./user')
-const Production = model.require('./production') // <-- Alias
+// Alias
+const User = model.require('./user')
 ```
 
+Features
+--------
+
+- Simple to use, no more you didn't need
+- Relative requires from specific directory
+- Resolve external warnings from bundlers (Webpack, Rollup, etc.)
+- Higher performance (no `Module` will be created)
+- No dependencies
+- Compatible in Node v4, v6 and v8
+
 API
 ---
 
-- `nrequire(request)`
+#### `_require(request)` (default export)
+
+> Same as `require()`, but resolve external problems from bundlers
 
-- `.require(request)`
+#### `.require(request)`
 
-- `.resolve(request)`
+> Alias of `_require()`
 
-- `.from(basedir)`
+#### `.resolve(request)`
+
+> Same as `require.resolve()`
+
+#### `.from(basedir)`
+
+> ###### Create a new `native-require` instance but lookup modules from `basedir`
+
+One `basedir` only create instance once, so never worry about used like
+
+```javascript
+_require.from(modelDir).require('./user')
+_require.from(modelDir).require('./post')
+_require.from(modelDir).require('./comment')
+```

README.md

@@ -1,78 +1,75 @@
-const Module = require('module');
-const path = require('path');
+const Module = require('module')
+const path = require('path')
 
-// To solve relative requirings and resolvings for `nrequire.from`
-const NON_EXISTS_FILENAME = '__native_require__';
+// To solve relative requires and resolves from `_require.from`
+const UNIQUE_FILENAME = '__NATIVE_REQUIRE__'
 
-const cache = {};
+const cache = {}
 
 function resolveBasedir (basedir) {
-  if (path.isAbsolute(basedir)) {
-    return basedir;
-  } else if (module.parent && typeof module.parent.filename === 'string') {
-    return path.join(path.dirname(module.parent.filename), basedir); // Required from module
-  }
-  return path.join(process.cwd(), basedir); // Required from Node CLI
+  /* istanbul ignore next: `module.parent` will be undefined when required from Node CLI */
+  const moduleBasedir = (module.parent && module.parent.filename ? path.dirname(module.parent.filename) : process.cwd())
+  return (basedir ? path.resolve(moduleBasedir, basedir) : moduleBasedir)
 }
 
-function initOptions (_options) {
-  // Shallow copy to prevent side effect
-  const options = (typeof _options === 'object') ? Object.assign({}, _options) : {};
-  options.basedir = resolveBasedir(options.basedir || '');
-
-  return options;
+function initOptions (_opt) {
+  const opt = _opt || {}
+  const options = {}
+  options.basedir = resolveBasedir(opt.basedir)
+  return options
 }
 
-function nativeRequire (_options) {
-  const options = initOptions(_options);
-  const nmodule = {
+function nativeRequire (opt) {
+  const options = initOptions(opt)
+  const _module = {
     id: '<repl>',
     exports: {},
     parent: module.parent,
-    filename: path.join(options.basedir, NON_EXISTS_FILENAME),
+    filename: path.join(options.basedir, UNIQUE_FILENAME),
     loaded: false,
     children: [],
     paths: Module._nodeModulePaths(options.basedir)
-  };
+  }
 
-  const nrequire = function require (request) {
+  function _require (request) {
     try {
-      return Module.prototype.require.call(nmodule, request);
+      return Module.prototype.require.call(_module, request)
     } catch (err) {
+      /* istanbul ignore else */
       if (err.code === 'MODULE_NOT_FOUND') {
-        err.message += ' from \'' + options.basedir + '\'';
+        err.message += ` from '${options.basedir}'`
       }
-      throw err;
+      throw err
     }
-  };
+  }
 
-  Object.assign(nrequire, {
+  Object.assign(_require, {
     main: process.mainModule,
     extensions: Module._extensions,
     cache: Module._cache,
-    require: nrequire,
-    resolve: function resolve (request) {
+    require: _require,
+    resolve: function (request) {
       try {
-        return Module._resolveFilename(request, nmodule);
+        return Module._resolveFilename(request, _module)
       } catch (err) {
+        /* istanbul ignore else */
         if (err.code === 'MODULE_NOT_FOUND') {
-          err.message += ' from \'' + options.basedir + '\'';
+          err.message += ` from '${options.basedir}'`
         }
-        throw err;
+        throw err
       }
     },
-    from: function from (_basedir) {
-      const basedir = resolveBasedir(_basedir);
-
+    from: function (from) {
+      const basedir = resolveBasedir(from)
       return cache[basedir] || (cache[basedir] = nativeRequire({
         basedir: basedir
-      }));
+      }))
     }
-  });
+  })
 
-  return nrequire;
+  return _require
 }
 
-const instance = nativeRequire();
+const instance = nativeRequire()
 
-module.exports = instance;
+module.exports = instance

index.js

@@ -1,7 +1,7 @@
 {
   "name": "native-require",
-  "version": "1.1.3",
-  "description": "Used to require() external modules in webpack",
+  "version": "1.1.4",
+  "description": "To resolve external modules for bundlers",
   "main": "index.js",
   "repository": "https://github.com/shirohana/native-require/",
   "author": "Hana Shiro <shirohana0608@gmail.com>",
@@ -10,22 +10,26 @@
     "index.js"
   ],
   "keywords": [
-    "webpack",
-    "require",
-    "node_modules",
     "node",
-    "externals"
+    "require",
+    "resolve",
+    "externals",
+    "node_modules"
   ],
   "scripts": {
-    "test": "npm run lint && ava --verbose test/",
-    "lint": "eslint --ext .js index.js",
+    "test": "npm run lint && nyc ava --verbose test/ && nyc report --reporter=html",
+    "coverage": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
+    "lint": "standard index.js && eslint --config .eslintrc-ava.js test/",
     "precommit": "npm run lint"
   },
   "devDependencies": {
     "ava": "^0.22.0",
     "chalk": "^2.1.0",
-    "eslint": "^4.5.0",
-    "eslint-config-es5": "^0.5.0",
-    "husky": "^0.14.3"
+    "codecov": "^2.3.0",
+    "eslint": "^4.16.0",
+    "eslint-plugin-ava": "^4.5.0",
+    "husky": "^0.14.3",
+    "nyc": "^11.1.0",
+    "standard": "^10.0.3"
   }
 }