Require Node.js 8, return undefined instead of null, add TypeScript definition (#7)

Author: BendingBender

.gitattributes

@@ -1,2 +1 @@
-* text=auto
-*.js text eol=lf
+* text=auto eol=lf

.gitignore

@@ -1 +1,2 @@
 node_modules
+yarn.lock

.npmrc

@@ -0,0 +1 @@
+package-lock=false

.travis.yml

@@ -1,4 +1,5 @@
 language: node_js
 node_js:
-  - '6'
-  - '4'
+  - '12'
+  - '10'
+  - '8'

index.d.ts

@@ -0,0 +1,41 @@
+declare const importFrom: {
+	/**
+	Import a module like with [`require()`](https://nodejs.org/api/modules.html#modules_require_id) but from a given path.
+
+	@param fromDirectory - Directory to import from.
+	@param moduleId - What you would use in `require()`.
+	@throws Like `require()`, throws when the module can't be found.
+
+	@example
+	```
+	import importFrom = require('import-from');
+
+	try {
+		const bar = importFrom('foo', './bar');
+		// do something with `bar`
+	} catch (error) {
+		// `error` is thrown when `./bar` can't be found
+	}
+	```
+	*/
+	(fromDirectory: string, moduleId: string): unknown;
+
+	/**
+	Import a module like with [`require()`](https://nodejs.org/api/modules.html#modules_require_id) but from a given path.
+
+	@param fromDirectory - Directory to import from.
+	@param moduleId - What you would use in `require()`.
+	@returns `undefined` instead of throwing when the module can't be found.
+
+	@example
+	```
+	import importFrom = require('import-from');
+
+	const bar = importFrom.silent('foo', './bar');
+	// do something with `bar`, may be `undefined` when `./bar` can't be found
+	```
+	*/
+	silent(fromDirectory: string, moduleId: string): unknown;
+};
+
+export = importFrom;

index.js

@@ -1,12 +1,10 @@
 'use strict';
 const resolveFrom = require('resolve-from');
 
-module.exports = (fromDir, moduleId) => require(resolveFrom(fromDir, moduleId));
+module.exports = (fromDirectory, moduleId) => require(resolveFrom(fromDirectory, moduleId));
 
-module.exports.silent = (fromDir, moduleId) => {
+module.exports.silent = (fromDirectory, moduleId) => {
 	try {
-		return require(resolveFrom(fromDir, moduleId));
-	} catch (err) {
-		return null;
-	}
+		return require(resolveFrom(fromDirectory, moduleId));
+	} catch (_) {}
 };

index.test-d.ts

@@ -0,0 +1,4 @@
+import importFrom = require('.');
+
+importFrom('foo', './bar');
+importFrom.silent('foo', './bar');

license

@@ -1,21 +1,9 @@
-The MIT License (MIT)
+MIT License
 
 Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package.json

@@ -1,38 +1,40 @@
 {
-  "name": "import-from",
-  "version": "2.1.0",
-  "description": "Import a module like with `require()` but from a given path",
-  "license": "MIT",
-  "repository": "sindresorhus/import-from",
-  "author": {
-    "name": "Sindre Sorhus",
-    "email": "sindresorhus@gmail.com",
-    "url": "sindresorhus.com"
-  },
-  "engines": {
-    "node": ">=4"
-  },
-  "scripts": {
-    "test": "xo && ava"
-  },
-  "files": [
-    "index.js"
-  ],
-  "keywords": [
-    "require",
-    "resolve",
-    "path",
-    "module",
-    "from",
-    "like",
-    "import",
-    "path"
-  ],
-  "dependencies": {
-    "resolve-from": "^3.0.0"
-  },
-  "devDependencies": {
-    "ava": "*",
-    "xo": "*"
-  }
+	"name": "import-from",
+	"version": "2.1.0",
+	"description": "Import a module like with `require()` but from a given path",
+	"license": "MIT",
+	"repository": "sindresorhus/import-from",
+	"author": {
+		"name": "Sindre Sorhus",
+		"email": "sindresorhus@gmail.com",
+		"url": "sindresorhus.com"
+	},
+	"engines": {
+		"node": ">=8"
+	},
+	"scripts": {
+		"test": "xo && ava && tsd"
+	},
+	"files": [
+		"index.js",
+		"index.d.ts"
+	],
+	"keywords": [
+		"require",
+		"resolve",
+		"path",
+		"module",
+		"from",
+		"like",
+		"import",
+		"path"
+	],
+	"dependencies": {
+		"resolve-from": "^5.0.0"
+	},
+	"devDependencies": {
+		"ava": "^1.4.1",
+		"tsd": "^0.7.2",
+		"xo": "^0.24.0"
+	}
 }

readme.md

@@ -1,12 +1,12 @@
 # import-from [![Build Status](https://travis-ci.org/sindresorhus/import-from.svg?branch=master)](https://travis-ci.org/sindresorhus/import-from)
 
-> Import a module like with [`require()`](https://nodejs.org/api/globals.html#globals_require) but from a given path
+> Import a module like with [`require()`](https://nodejs.org/api/modules.html#modules_require_id) but from a given path
 
 
 ## Install
 
 ```
-$ npm install --save import-from
+$ npm install import-from
 ```
 
 
@@ -23,15 +23,15 @@ importFrom('foo', './bar');
 
 ## API
 
-### importFrom(fromDir, moduleId)
+### importFrom(fromDirectory, moduleId)
 
 Like `require()`, throws when the module can't be found.
 
-### importFrom.silent(fromDir, moduleId)
+### importFrom.silent(fromDirectory, moduleId)
 
-Returns `null` instead of throwing when the module can't be found.
+Returns `undefined` instead of throwing when the module can't be found.
 
-#### fromDir
+#### fromDirectory
 
 Type: `string`
 

test.js

@@ -1,18 +1,18 @@
 import test from 'ava';
-import m from '.';
+import importFrom from '.';
 
 test('importFrom()', t => {
-	t.is(m('fixture', './fixture'), 'unicorn');
-	t.throws(() => m('fixture', './nonexistent'));
+	t.is(importFrom('fixture', './fixture'), 'unicorn');
+	t.throws(() => importFrom('fixture', './nonexistent'));
 
 	const moduleNotFoundError = t.throws(() => {
-		m('fixture', './nonexistent');
+		importFrom('fixture', './nonexistent');
 	}, Error);
 	t.is(moduleNotFoundError.code, 'MODULE_NOT_FOUND');
-	t.is(moduleNotFoundError.message, 'Cannot find module \'./nonexistent\'');
+	t.regex(moduleNotFoundError.message, /^Cannot find module '.\/nonexistent'/);
 });
 
 test('importFrom.silent()', t => {
-	t.is(m.silent('fixture', './fixture'), 'unicorn');
-	t.is(m.silent('fixture', './nonexistent'), null);
+	t.is(importFrom.silent('fixture', './fixture'), 'unicorn');
+	t.is(importFrom.silent('fixture', './nonexistent'), undefined);
 });