@stdlib/fs-read-json 0.1.1 → 0.2.1

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2023 The Stdlib Authors.
+Copyright (c) 2016-2024 The Stdlib Authors.

package/README.md

@@ -206,7 +206,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors].
+Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -219,8 +219,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/fs-read-json.svg
 [npm-url]: https://npmjs.org/package/@stdlib/fs-read-json
 
-[test-image]: https://github.com/stdlib-js/fs-read-json/actions/workflows/test.yml/badge.svg?branch=v0.1.1
-[test-url]: https://github.com/stdlib-js/fs-read-json/actions/workflows/test.yml?query=branch:v0.1.1
+[test-image]: https://github.com/stdlib-js/fs-read-json/actions/workflows/test.yml/badge.svg?branch=v0.2.1
+[test-url]: https://github.com/stdlib-js/fs-read-json/actions/workflows/test.yml?query=branch:v0.2.1
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/fs-read-json/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/fs-read-json?branch=main
@@ -243,8 +243,11 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 
 [deno-url]: https://github.com/stdlib-js/fs-read-json/tree/deno
+[deno-readme]: https://github.com/stdlib-js/fs-read-json/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/fs-read-json/tree/umd
+[umd-readme]: https://github.com/stdlib-js/fs-read-json/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/fs-read-json/tree/esm
+[esm-readme]: https://github.com/stdlib-js/fs-read-json/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/fs-read-json/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/fs-read-json/main/LICENSE

package/SECURITY.md

@@ -0,0 +1,5 @@
+# Security
+
+> Policy for reporting security vulnerabilities.
+
+See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).

package/docs/types/index.d.ts

@@ -74,7 +74,7 @@ interface ReadJSON {
 	* @param clbk - callback
 	*
 	* @example
-	* var resolve = require( `path` ).resolve;
+	* var resolve = require( 'path' ).resolve;
 	*
 	* readJSON( resolve( __dirname, '..', 'package.json' ), 'utf-8', onJSON );
 	*
@@ -85,7 +85,7 @@ interface ReadJSON {
 	*     console.dir( data );
 	* }
 	*/
-	( file: string | Buffer | number, options: Options | string, clbk: Callback ): void; // tslint-disable-line max-line-length
+	( file: string | Buffer | number, options: Options | string, clbk: Callback ): void;
 
 	/**
 	* Asynchronously reads a file as JSON.
@@ -94,7 +94,7 @@ interface ReadJSON {
 	* @param clbk - callback
 	*
 	* @example
-	* var resolve = require( `path` ).resolve;
+	* var resolve = require( 'path' ).resolve;
 	*
 	* readJSON( resolve( __dirname, '..', 'package.json' ), onJSON );
 	*
@@ -118,8 +118,8 @@ interface ReadJSON {
 	* @returns JSON or an error
 	*
 	* @example
-	* var resolve = require( `path` ).resolve;
-	* var instanceOf = require( `@stdlib/assert/instance-of` );
+	* var resolve = require( 'path' ).resolve;
+	* var instanceOf = require( '@stdlib/assert-instance-of' );
 	*
 	* var out = readJSON.sync( resolve( __dirname, '..', 'package.json' ) );
 	* if ( instanceOf( out, Error ) ) {
@@ -127,7 +127,7 @@ interface ReadJSON {
 	* }
 	* console.dir( out );
 	*/
-	sync( file: string | Buffer | number, options?: Options | string ): string | Error; // tslint-disable-line max-line-length
+	sync( file: string | Buffer | number, options?: Options | string ): string | Error;
 }
 
 /**
@@ -141,7 +141,7 @@ interface ReadJSON {
 * @param clbk - callback
 *
 * @example
-* var resolve = require( `path` ).resolve;
+* var resolve = require( 'path' ).resolve;
 *
 * readJSON( resolve( __dirname, '..', 'package.json' ), 'utf-8', onJSON );
 *
@@ -153,8 +153,8 @@ interface ReadJSON {
 * }
 *
 * @example
-* var resolve = require( `path` ).resolve;
-* var instanceOf = require( `@stdlib/assert/instance-of` );
+* var resolve = require( 'path' ).resolve;
+* var instanceOf = require( '@stdlib/assert-instance-of' );
 *
 * var out = readJSON.sync( resolve( __dirname, '..', 'package.json' ) );
 * if ( instanceOf( out, Error ) ) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/fs-read-json",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "Read a file as JSON.",
   "license": "Apache-2.0",
   "author": {
@@ -15,19 +15,12 @@
   ],
   "main": "./lib",
   "directories": {
-    "benchmark": "./benchmark",
     "doc": "./docs",
-    "example": "./examples",
     "lib": "./lib",
-    "test": "./test"
+    "dist": "./dist"
   },
   "types": "./docs/types",
-  "scripts": {
-    "test": "make test",
-    "test-cov": "make test-cov",
-    "examples": "make examples",
-    "benchmark": "make benchmark"
-  },
+  "scripts": {},
   "homepage": "https://stdlib.io",
   "repository": {
     "type": "git",
@@ -37,25 +30,17 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-instance-of": "^0.1.1",
-    "@stdlib/assert-is-function": "^0.1.1",
-    "@stdlib/assert-is-plain-object": "^0.1.1",
-    "@stdlib/assert-is-string": "^0.1.1",
-    "@stdlib/fs-read-file": "^0.1.1",
-    "@stdlib/string-format": "^0.1.1",
-    "@stdlib/string-remove-utf8-bom": "^0.1.1",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1",
-    "@stdlib/utils-parse-json": "^0.1.1",
-    "@stdlib/error-tools-fmtprodmsg": "^0.1.0"
-  },
-  "devDependencies": {
-    "@stdlib/assert-is-browser": "^0.1.0",
-    "@stdlib/bench": "^0.1.0",
-    "@stdlib/utils-noop": "^0.1.1",
-    "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
-    "istanbul": "^0.4.1",
-    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
+    "@stdlib/assert-instance-of": "^0.2.1",
+    "@stdlib/assert-is-function": "^0.2.1",
+    "@stdlib/assert-is-plain-object": "^0.2.1",
+    "@stdlib/assert-is-string": "^0.2.1",
+    "@stdlib/fs-read-file": "^0.2.1",
+    "@stdlib/string-format": "^0.2.1",
+    "@stdlib/string-remove-utf8-bom": "^0.2.1",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1",
+    "@stdlib/utils-parse-json": "^0.2.1"
   },
+  "devDependencies": {},
   "engines": {
     "node": ">=0.10.0",
     "npm": ">2.7.0"

package/CITATION.cff

@@ -1,30 +0,0 @@
-cff-version: 1.2.0
-title: stdlib
-message: >-
-  If you use this software, please cite it using the
-  metadata from this file.
-
-type: software
-
-authors:
-  - name: The Stdlib Authors
-    url: https://github.com/stdlib-js/stdlib/graphs/contributors
-
-repository-code: https://github.com/stdlib-js/stdlib
-url: https://stdlib.io
-
-abstract: |
-  Standard library for JavaScript and Node.js.
-
-keywords:
-  - JavaScript
-  - Node.js
-  - TypeScript
-  - standard library
-  - scientific computing
-  - numerical computing
-  - statistical computing
-
-license: Apache-2.0 AND BSL-1.0
-
-date-released: 2016