Refactor TypeScript definition to CommonJS compatible export (#17)

Author: BendingBender

index.d.ts

@@ -1,45 +1,58 @@
-export type Reviver = (this: unknown, key: string, value: unknown) => unknown;
-export type BeforeParse = (data: string) => string;
+import {JsonValue} from 'type-fest';
 
-export interface Options {
+declare namespace loadJsonFile {
+	type Reviver = (this: unknown, key: string, value: any) => unknown;
+	type BeforeParse = (data: string) => string;
+
+	interface Options {
+		/**
+		Applies a function to the JSON string before parsing.
+		*/
+		readonly beforeParse?: BeforeParse;
+
+		/**
+		Prescribes how the value originally produced by parsing is transformed, before being returned.
+		See the [`JSON.parse` docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Using_the_reviver_parameter) for more.
+		*/
+		readonly reviver?: Reviver;
+	}
+}
+
+declare const loadJsonFile: {
 	/**
-	 * Applies a function to the JSON string before parsing.
-	 */
-	readonly beforeParse?: BeforeParse;
+	Read and parse a JSON file.
+
+	Strips UTF-8 BOM, uses graceful-fs, and throws more helpful JSON errors.
+
+	@example
+	```
+	import loadJsonFile = require('load-json-file');
+
+	(async () => {
+		const json = await loadJsonFile('foo.json');
+		//=> {foo: true}
+	})();
+	```
+	*/
+	<T = JsonValue>(filePath: string, options?: loadJsonFile.Options): Promise<T>;
 
 	/**
-	 * Prescribes how the value originally produced by parsing is transformed, before being returned.
-	 * See the [`JSON.parse` docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Using_the_reviver_parameter) for more.
-	 */
-	readonly reviver?: Reviver;
-}
+	Read and parse a JSON file.
+
+	Strips UTF-8 BOM, uses graceful-fs, and throws more helpful JSON errors.
+
+	@example
+	```
+	import loadJsonFile = require('load-json-file');
+
+	const json = loadJsonFile.sync('foo.json');
+	//=> {foo: true}
+	```
+	*/
+	sync<T = JsonValue>(filePath: string, options?: loadJsonFile.Options): T;
+
+	// TODO: Remove this for the next major release
+	default: typeof loadJsonFile;
+};
 
-/**
- * Read and parse a JSON file.
- *
- * Strips UTF-8 BOM, uses graceful-fs, and throws more helpful JSON errors.
- *
- * @example
- *
- * import loadJsonFile from 'load-json-file';
- *
- * (async () => {
- * 	const json = await loadJsonFile('foo.json');
- * 	//=> {foo: true}
- * })();
- */
-export default function loadJsonFile<T = unknown>(filePath: string, options?: Options): Promise<T>;
-
-/**
- * Read and parse a JSON file.
- *
- * Strips UTF-8 BOM, uses graceful-fs, and throws more helpful JSON errors.
- *
- * @example
- *
- * import * as loadJsonFile from 'load-json-file';
- *
- * const json = loadJsonFile.sync('foo.json');
- * //=> {foo: true}
- */
-export function sync<T = unknown>(filePath: string, options?: Options): T;
+export = loadJsonFile;

index.js

@@ -18,5 +18,6 @@ const parse = (data, filePath, options = {}) => {
 const loadJsonFile = (filePath, options) => pify(fs.readFile)(filePath, 'utf8').then(data => parse(data, filePath, options));
 
 module.exports = loadJsonFile;
+// TODO: Remove this for the next major release
 module.exports.default = loadJsonFile;
 module.exports.sync = (filePath, options) => parse(fs.readFileSync(filePath, 'utf8'), filePath, options);

index.test-d.ts

@@ -1,12 +1,14 @@
-import {expectType} from 'tsd-check';
-import loadJsonFile, {sync, Reviver, BeforeParse} from '.';
+import {expectType} from 'tsd';
+import {JsonValue} from 'type-fest';
+import loadJsonFile = require('.');
+import {Reviver, BeforeParse} from '.';
 
 expectType<Reviver>(() => 1);
 expectType<Reviver>((a: string) => a.length);
 expectType<Reviver>((a: string, b: string) => a.length - b.length);
 
-expectType<BeforeParse>((data) => data);
+expectType<BeforeParse>(data => data);
 
-expectType<unknown>(await loadJsonFile('unicorn.json'));
+expectType<Promise<JsonValue>>(loadJsonFile('unicorn.json'));
 
-expectType<unknown>(sync('unicorn.json'));
+expectType<JsonValue>(loadJsonFile.sync('unicorn.json'));

package.json

@@ -13,7 +13,7 @@
 		"node": ">=6"
 	},
 	"scripts": {
-		"test": "xo && ava && tsd-check"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
 		"index.js",
@@ -29,14 +29,15 @@
 		"load"
 	],
 	"dependencies": {
-		"graceful-fs": "^4.1.2",
+		"graceful-fs": "^4.1.15",
 		"parse-json": "^4.0.0",
-		"pify": "^3.0.0",
-		"strip-bom": "^3.0.0"
+		"pify": "^4.0.1",
+		"strip-bom": "^3.0.0",
+		"type-fest": "^0.3.0"
 	},
 	"devDependencies": {
-		"ava": "*",
-		"tsd-check": "^0.2.1",
-		"xo": "*"
+		"ava": "^1.4.1",
+		"tsd": "^0.7.2",
+		"xo": "^0.24.0"
 	}
 }