Add comments and missing private annotations

Planeshifter · Planeshifter · commit 8cfd17890f95 · 2021-06-05T21:31:15.000-04:00
diff --git a/lib/node_modules/@stdlib/cli/lib/is_integer.js b/lib/node_modules/@stdlib/cli/lib/is_integer.js
@@ -23,6 +23,7 @@
 /**
 * Tests if a finite double-precision floating-point number is an integer.
 *
+* @private
 * @param {number} x - value to test
 * @returns {boolean} boolean indicating whether the value is an integer
 *
@@ -35,6 +36,7 @@
 * // returns false
 */
 function isInteger( x ) {
+	// NOTE: we explicitly avoid using `@stdlib/math/base/special` here in order to avoid circular dependencies.
 	return ( Math.floor( x ) === x ); // eslint-disable-line stdlib/no-builtin-math
 }
 
diff --git a/lib/node_modules/@stdlib/utils/library-manifest/bin/cli b/lib/node_modules/@stdlib/utils/library-manifest/bin/cli
@@ -23,6 +23,8 @@
 // MODULES //
 
 var resolve = require( 'path' ).resolve;
+
+// NOTE: we explicitly avoid using `@stdlib/fs/read-file` in this particular package in order to avoid circular dependencies. This should not be problematic as this command-line utility will be executed via Node.js.
 var readFileSync = require( 'fs' ).readFileSync; // eslint-disable-line no-sync
 var CLI = require( '@stdlib/cli' );
 var manifest = require( './../lib' );
diff --git a/lib/node_modules/@stdlib/utils/library-manifest/lib/is_object.js b/lib/node_modules/@stdlib/utils/library-manifest/lib/is_object.js
@@ -23,6 +23,7 @@
 /**
 * Tests if a value is an object; e.g., `{}`.
 *
+* @private
 * @param {*} value - value to test
 * @returns {boolean} boolean indicating whether value is an object
 *
@@ -38,7 +39,7 @@ function isObject( value ) {
 	return (
 		typeof value === 'object' &&
 		value !== null &&
-		!Array.isArray( value )
+		!Array.isArray( value )	// NOTE: we inline the `isObject` function from `@stdlib/assert/is-object` and use the built-in `isArray` method in this particular package in order to avoid circular dependencies. This should not be problematic as (1) this package is unlikely to be used outside of Node.js and, thus, in environments lacking support for the built-in APIs, and (2) most of the historical bugs for the respective APIs were in environments such as IE and not the versions of V8 included in Node.js >= v0.10.x.
 	);
 }
 
diff --git a/lib/node_modules/@stdlib/utils/library-manifest/lib/manifest.js b/lib/node_modules/@stdlib/utils/library-manifest/lib/manifest.js
@@ -24,7 +24,6 @@ var path = require( 'path' );
 var cwd = require( 'process' ).cwd;
 var logger = require( 'debug' );
 var resolve = require( 'resolve' ).sync;
-var hasOwnProp = require( '@stdlib/assert/has-own-property' );
 var parentPath = require( '@stdlib/fs/resolve-parent-path' ).sync;
 var convertPath = require( '@stdlib/utils/convert-path' );
 var isObject = require( './is_object.js' );
@@ -37,6 +36,10 @@ var DEFAULTS = require( './defaults.json' );
 
 var debug = logger( 'library-manifest:main' );
 
+// NOTE: for the following, we explicitly avoid using stdlib packages in this particular package in order to avoid circular dependencies. This should not be problematic as (1) this package is unlikely to be used outside of Node.js and, thus, in environments lacking support for the built-in APIs, and (2) most of the historical bugs for the respective APIs were in environments such as IE and not the versions of V8 included in Node.js >= v0.10.x.
+var hasOwnProp = Object.prototype.hasOwnProperty;
+var objectKeys = Object.keys;
+
 
 // MAIN //
 
@@ -95,6 +98,8 @@ function manifest( fpath, conditions, options ) {
 	debug( 'Manifest file path: %s', fpath );
 
 	conf = require( fpath ); // eslint-disable-line stdlib/no-dynamic-require
+
+	// NOTE: Instead of using `@stdlib/utils/copy`, we stringify and then parse the configuration object to create a deep copy in an ES5 environment while avoiding circular dependencies. This assumes that the configuration object is valid JSON.
 	conf = JSON.parse( JSON.stringify( conf ) );
 	debug( 'Manifest: %s', JSON.stringify( conf ) );
 
@@ -105,10 +110,10 @@ function manifest( fpath, conditions, options ) {
 		throw new TypeError( 'invalid argument. Second argument must be an object. Value: `' + conditions + '`.' );
 	}
 	debug( 'Provided conditions: %s', JSON.stringify( conditions ) );
-	coptnames = Object.keys( conf.options );
+	coptnames = objectKeys( conf.options );
 	for ( i = 0; i < coptnames.length; i++ ) {
 		key = coptnames[ i ];
-		if ( hasOwnProp( conditions, key ) ) {
+		if ( hasOwnProp.call( conditions, key ) ) {
 			conf.options[ key ] = conditions[ key ];
 		}
 	}
@@ -123,14 +128,15 @@ function manifest( fpath, conditions, options ) {
 		for ( j = 0; j < coptnames.length; j++ ) {
 			key = coptnames[ j ];
 			if (
-				!hasOwnProp( o, key ) ||
+				!hasOwnProp.call( o, key ) ||
 				o[ key ] !== conf.options[ key ]
 			) {
 				break;
 			}
 		}
 		// If we exhausted all the options, then we found a match...
 		if ( j === coptnames.length ) {
+			// NOTE: Instead of using `@stdlib/utils/copy`, we stringify and then parse the object to create a deep copy in an ES5 environment while avoiding circular dependencies. This assumes that the object is valid JSON.
 			obj = JSON.parse( JSON.stringify( o ) );
 			debug( 'Matching configuration: %s', JSON.stringify( obj ) );
 			break;
@@ -143,7 +149,7 @@ function manifest( fpath, conditions, options ) {
 	// Resolve manifest file paths...
 	for ( i = 0; i < conf.fields.length; i++ ) {
 		key = conf.fields[ i ].field;
-		if ( hasOwnProp( obj, key ) ) {
+		if ( hasOwnProp.call( obj, key ) ) {
 			o = obj[ key ];
 			if ( conf.fields[ i ].resolve ) {
 				for ( j = 0; j < o.length; j++ ) {
@@ -184,7 +190,7 @@ function manifest( fpath, conditions, options ) {
 		debug( 'Merging dependency manifest.' );
 		for ( j = 0; j < conf.fields.length; j++ ) {
 			key = conf.fields[ j ].field;
-			if ( hasOwnProp( o, key ) ) {
+			if ( hasOwnProp.call( o, key ) ) {
 				tmp = o[ key ];
 				if ( conf.fields[ j ].resolve ) {
 					for ( k = 0; k < tmp.length; k++ ) {
@@ -200,7 +206,7 @@ function manifest( fpath, conditions, options ) {
 	debug( 'Removing duplicate entries.' );
 	for ( i = 0; i < conf.fields.length; i++ ) {
 		key = conf.fields[ i ].field;
-		if ( hasOwnProp( obj, key ) ) {
+		if ( hasOwnProp.call( obj, key ) ) {
 			obj[ key ] = unique( obj[ key ] );
 		}
 	}
@@ -209,7 +215,7 @@ function manifest( fpath, conditions, options ) {
 	for ( i = 0; i < conf.fields.length; i++ ) {
 		key = conf.fields[ i ].field;
 		if (
-			hasOwnProp( obj, key ) &&
+			hasOwnProp.call( obj, key ) &&
 			conf.fields[ i ].resolve &&
 			conf.fields[ i ].relative
 		) {
@@ -224,7 +230,7 @@ function manifest( fpath, conditions, options ) {
 		debug( 'Converting paths to specified convention.' );
 		for ( i = 0; i < conf.fields.length; i++ ) {
 			key = conf.fields[ i ].field;
-			if ( hasOwnProp( obj, key ) ) {
+			if ( hasOwnProp.call( obj, key ) ) {
 				tmp = obj[ key ];
 				for ( j = 0; j < tmp.length; j++ ) {
 					tmp[ j ] = convertPath( tmp[ j ], opts.paths );
diff --git a/lib/node_modules/@stdlib/utils/library-manifest/lib/unique.js b/lib/node_modules/@stdlib/utils/library-manifest/lib/unique.js
@@ -18,6 +18,12 @@
 
 'use strict';
 
+// VARIABLES //
+
+// NOTE: for the following, we explicitly avoid using stdlib packages in this particular package in order to avoid circular dependencies. This should not be problematic as (1) this package is unlikely to be used outside of Node.js and, thus, in environments lacking support for the built-in APIs, and (2) most of the historical bugs for the respective APIs were in environments such as IE and not the versions of V8 included in Node.js >= v0.10.x.
+var objectKeys = Object.keys;
+
+
 // MAIN //
 
 /**
@@ -34,7 +40,7 @@ function unique( arr ) {
 	for ( i = 0; i < arr.length; i++ ) {
 		obj[ arr[i] ] = true;
 	}
-	return Object.keys( obj );
+	return objectKeys( obj );
 }
 
 
diff --git a/lib/node_modules/@stdlib/utils/library-manifest/lib/validate.js b/lib/node_modules/@stdlib/utils/library-manifest/lib/validate.js
@@ -20,10 +20,15 @@
 
 // MODULES //
 
-var hasOwnProp = require( '@stdlib/assert/has-own-property' );
+// NOTE: for the following, we explicitly avoid using stdlib packages in this particular package in order to avoid circular dependencies. This should not be problematic as (1) this package is unlikely to be used outside of Node.js and, thus, in environments lacking support for the built-in APIs, and (2) most of the historical bugs for the respective APIs were in environments such as IE and not the versions of V8 included in Node.js >= v0.10.x.
 var isObject = require( './is_object.js' );
 
 
+// VARIABLES //
+
+var hasOwnProp = Object.prototype.hasOwnProperty;
+
+
 // MAIN //
 
 /**
@@ -51,13 +56,13 @@ function validate( opts, options ) {
 	if ( !isObject( options ) ) {
 		return new TypeError( 'invalid argument. Options argument must be an object. Value: `' + options + '`.' );
 	}
-	if ( hasOwnProp( options, 'basedir' ) ) {
+	if ( hasOwnProp.call( options, 'basedir' ) ) {
 		opts.basedir = options.basedir;
 		if ( typeof opts.basedir !== 'string' ) {
 			return new TypeError( 'invalid option. `basedir` option must be a primitive string. Option: `' + opts.basedir + '`.' );
 		}
 	}
-	if ( hasOwnProp( options, 'paths' ) ) {
+	if ( hasOwnProp.call( options, 'paths' ) ) {
 		opts.paths = options.paths;
 		if ( typeof opts.paths !== 'string' ) {
 			return new TypeError( 'invalid option. `paths` option must be a primitive string. Option: `' + opts.paths + '`.' );

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@`
`23`	`23`	`/**`
`24`	`24`	`* Tests if a finite double-precision floating-point number is an integer.`
`25`	`25`	`*`
	`26`	`+* @private`
`26`	`27`	`* @param {number} x - value to test`
`27`	`28`	`* @returns {boolean} boolean indicating whether the value is an integer`
`28`	`29`	`*`
`@@ -35,6 +36,7 @@`
`35`	`36`	`* // returns false`
`36`	`37`	`*/`
`37`	`38`	`function isInteger( x ) {`
	`39`	+ // NOTE: we explicitly avoid using `@stdlib/math/base/special` here in order to avoid circular dependencies.
`38`	`40`	`return ( Math.floor( x ) === x ); // eslint-disable-line stdlib/no-builtin-math`
`39`	`41`	`}`
`40`	`42`