Auto-generated commit

Author: stdlib-bot

.editorconfig

@@ -165,6 +165,15 @@ indent_style = tab
 indent_style = space
 indent_size = 2
 
+# Ignore generated lock files for GitHub Agentic Workflows:
+[*.lock.yml]
+charset = unset
+end_of_line = unset
+indent_style = unset
+indent_size = unset
+trim_trailing_whitespace = unset
+insert_final_newline = unset
+
 # Set properties for GYP files:
 [binding.gyp]
 indent_style = space

.gitattributes

@@ -64,3 +64,5 @@ Makefile linguist-vendored
 
 # Configure files which should be included in GitHub language statistics:
 docs/types/*.d.ts -linguist-documentation
+
+.github/workflows/*.lock.yml linguist-generated=true merge=ours

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2026-03-02)
+## Unreleased (2026-03-21)
 
 <section class="features">
 
@@ -20,6 +20,7 @@
 
 ### Bug Fixes
 
+-   [`ebd5886`](https://github.com/stdlib-js/stdlib/commit/ebd5886f97aef9dad8daf7df0d850882a767ca6b) - preserve formatting of original string serialization and rename internal files
 -   [`eab49ad`](https://github.com/stdlib-js/stdlib/commit/eab49ad435f6080ec28a8fbb75de4d9520bdd7e4) - ensure support for elements which are null or undefined
 
 </section>
@@ -32,6 +33,7 @@
 
 <details>
 
+-   [`ebd5886`](https://github.com/stdlib-js/stdlib/commit/ebd5886f97aef9dad8daf7df0d850882a767ca6b) - **fix:** preserve formatting of original string serialization and rename internal files _(by Athan Reines)_
 -   [`eab49ad`](https://github.com/stdlib-js/stdlib/commit/eab49ad435f6080ec28a8fbb75de4d9520bdd7e4) - **fix:** ensure support for elements which are null or undefined _(by Athan Reines)_
 -   [`793a38c`](https://github.com/stdlib-js/stdlib/commit/793a38c29f31677807e0cf6748f1ca54fbbef4ec) - **feat:** add `toLocaleString` method to `ndarray/base/ctor` [(#9435)](https://github.com/stdlib-js/stdlib/pull/9435) _(by Muhammad Haris, Athan Reines)_
 

dist/index.js

@@ -38,10 +38,10 @@ var igetValue = require( './iget.js' );
 var isetValue = require( './iset.js' );
 var setValue = require( './set.js' );
 var getValue = require( './get.js' );
-var valueOf = require( './valueof.js' ); // eslint-disable-line stdlib/no-redeclare
-var toJSON = require( './tojson.js' );
-var toString = require( './tostring.js' ); // eslint-disable-line stdlib/no-redeclare
-var toLocaleString = require( './tolocalestring.js' ); // eslint-disable-line stdlib/no-redeclare
+var valueOf = require( './value_of.js' ); // eslint-disable-line stdlib/no-redeclare
+var toJSON = require( './to_json.js' );
+var toString = require( './to_string.js' ); // eslint-disable-line stdlib/no-redeclare
+var toLocaleString = require( './to_locale_string.js' ); // eslint-disable-line stdlib/no-redeclare
 var meta2dataview = require( './meta2dataview.js' );
 var meta2dataviewPolyfill = require( './meta2dataview.polyfill.js' );
 

dist/index.js.map

@@ -16,15 +16,14 @@
 * limitations under the License.
 */
 
+/* eslint-disable no-underscore-dangle */
+
 'use strict';
 
 // MODULES //
 
 var isComplexDataType = require( '@stdlib/ndarray-base-assert-is-complex-floating-point-data-type' );
-var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
-var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;
 var isUndefinedOrNull = require( '@stdlib/assert-is-undefined-or-null' );
-var isObject = require( '@stdlib/assert-is-plain-object' );
 var format = require( '@stdlib/string-format' );
 var replace = require( '@stdlib/string-replace' );
 var join = require( '@stdlib/array-base-join' );
@@ -52,76 +51,91 @@ var CTORS = {
 };
 
 
+// FUNCTIONS //
+
+/**
+* Serializes a value to a string.
+*
+* @private
+* @param {*} value - input value
+* @returns {string} output string
+*/
+function toStr( value ) {
+	return String( value );
+}
+
+/**
+* Serializes a value to a locale-aware string.
+*
+* @private
+* @param {*} value - input value
+* @param {(string|Array<string>)} [locales] - locale identifier(s)
+* @param {Object} [options] - configuration options
+* @returns {string} output string
+*/
+function toLocaleStr( value, locales, options ) {
+	if ( !isUndefinedOrNull( value ) && value.toLocaleString ) {
+		return value.toLocaleString( locales, options );
+	}
+	return toStr( value );
+}
+
+
 // MAIN //
 
 /**
-* Serializes an ndarray as a locale-aware string.
+* Serializes an ndarray to a string.
 *
 * ## Notes
 *
 * -   The method does **not** serialize data outside of the buffer region defined by the array configuration.
 *
 * @private
-* @param {(string|Array<string>)} [locales] - locale identifier(s)
-* @param {Object} [options] - configuration options
-* @throws {TypeError} first argument must be a string or an array of strings
-* @throws {TypeError} options argument must be an object
+* @param {ndarray} ctx - ndarray object
+* @param {string} method - element serialization method (i.e., `toString` or `toLocaleString`)
+* @param {(string|Array<string>|null)} locales - locale identifier(s)
+* @param {(Object|null)} options - configuration options
 * @returns {string} string representation
 */
-function toLocaleString( locales, options ) { // eslint-disable-line stdlib/no-redeclare
-	/* eslint-disable no-invalid-this */
+function serialize2string( ctx, method, locales, options ) {
 	var isCmplx;
 	var buffer;
 	var ndims;
 	var ctor;
-	var opts;
-	var loc;
 	var str;
 	var dt;
+	var f;
 	var v;
 	var i;
 
-	if ( arguments.length === 0 ) {
-		loc = [];
-	} else if ( isString( locales ) || isStringArray( locales ) ) {
-		loc = locales;
+	if ( method === 'toLocaleString' ) {
+		f = toLocaleStr;
 	} else {
-		throw new TypeError( format( 'invalid argument. First argument must be a string or an array of strings. Value: `%s`.', locales ) );
+		f = toStr;
 	}
-	if ( arguments.length < 2 ) {
-		opts = {};
-	} else if ( isObject( options ) ) {
-		opts = options;
-	} else {
-		throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
-	}
-	ndims = this._shape.length;
-	dt = this._dtype;
+	ndims = ctx._shape.length;
+	dt = ctx._dtype;
 	isCmplx = isComplexDataType( dt );
 
 	// Function to invoke to create an ndarray:
 	str = format( 'ndarray( \'%s\', ', String( dt ) );
 
 	// Data buffer parameter...
 	buffer = '';
-	if ( this._length <= 100 ) {
+	if ( ctx._length <= 100 ) {
 		if ( isCmplx ) {
-			for ( i = 0; i < this._length; i++ ) {
-				v = this.iget( i );
-				buffer += real( v ).toLocaleString( loc, opts ) + ', ' + imag( v ).toLocaleString( loc, opts );
-				if ( i < this._length-1 ) {
+			for ( i = 0; i < ctx._length; i++ ) {
+				v = ctx.iget( i );
+				buffer += f( real( v ), locales, options ) + ', ' + f( imag( v ), locales, options );
+				if ( i < ctx._length-1 ) {
 					buffer += ', ';
 				}
 			}
 		} else {
-			for ( i = 0; i < this._length; i++ ) {
-				v = this.iget( i );
-				if ( !isUndefinedOrNull( v ) && v.toLocaleString ) {
-					buffer += v.toLocaleString( loc, opts );
-				} else {
-					buffer += String( v );
-				}
-				if ( i < this._length-1 ) {
+			for ( i = 0; i < ctx._length; i++ ) {
+				v = ctx.iget( i );
+				buffer += f( v, locales, options );
+				if ( i < ctx._length-1 ) {
 					buffer += ', ';
 				}
 			}
@@ -130,20 +144,16 @@ function toLocaleString( locales, options ) { // eslint-disable-line stdlib/no-r
 		// First three values...
 		if ( isCmplx ) {
 			for ( i = 0; i < 3; i++ ) {
-				v = this.iget( i );
-				buffer += real( v ).toLocaleString( loc, opts ) + ', ' + imag( v ).toLocaleString( loc, opts );
+				v = ctx.iget( i );
+				buffer += f( real( v ), locales, options ) + ', ' + f( imag( v ), locales, options );
 				if ( i < 2 ) {
 					buffer += ', ';
 				}
 			}
 		} else {
 			for ( i = 0; i < 3; i++ ) {
-				v = this.iget( i );
-				if ( !isUndefinedOrNull( v ) && v.toLocaleString ) {
-					buffer += v.toLocaleString( loc, opts );
-				} else {
-					buffer += String( v );
-				}
+				v = ctx.iget( i );
+				buffer += f( v, locales, options );
 				if ( i < 2 ) {
 					buffer += ', ';
 				}
@@ -154,35 +164,31 @@ function toLocaleString( locales, options ) { // eslint-disable-line stdlib/no-r
 		// Last three values...
 		if ( isCmplx ) {
 			for ( i = 2; i >= 0; i-- ) {
-				v = this.iget( this._length-1-i );
-				buffer += real( v ).toLocaleString( loc, opts ) + ', ' + imag( v ).toLocaleString( loc, opts );
+				v = ctx.iget( ctx._length-1-i );
+				buffer += f( real( v ), locales, options ) + ', ' + f( imag( v ), locales, options );
 				if ( i > 0 ) {
 					buffer += ', ';
 				}
 			}
 		} else {
 			for ( i = 2; i >= 0; i-- ) {
-				v = this.iget( this._length-1-i );
-				if ( !isUndefinedOrNull( v ) && v.toLocaleString ) {
-					buffer += v.toLocaleString( loc, opts );
-				} else {
-					buffer += String( v );
-				}
+				v = ctx.iget( ctx._length-1-i );
+				buffer += f( v, locales, options );
 				if ( i > 0 ) {
 					buffer += ', ';
 				}
 			}
 		}
 	}
-	ctor = CTORS[ this.dtype ];
+	ctor = CTORS[ ctx.dtype ];
 	str += replace( ctor, '{{data}}', buffer );
 	str += ', ';
 
 	// Array shape...
 	if ( ndims === 0 ) {
 		str += '[]';
 	} else {
-		str += format( '[ %s ]', join( this._shape, ', ' ) );
+		str += format( '[ %s ]', join( ctx._shape, ', ' ) );
 	}
 	str += ', ';
 
@@ -192,10 +198,10 @@ function toLocaleString( locales, options ) { // eslint-disable-line stdlib/no-r
 		str += '0';
 	} else {
 		for ( i = 0; i < ndims; i++ ) {
-			if ( this._strides[ i ] < 0 ) {
-				str += -this._strides[ i ];
+			if ( ctx._strides[ i ] < 0 ) {
+				str += -ctx._strides[ i ];
 			} else {
-				str += this._strides[ i ];
+				str += ctx._strides[ i ];
 			}
 			if ( i < ndims-1 ) {
 				str += ', ';
@@ -210,16 +216,14 @@ function toLocaleString( locales, options ) { // eslint-disable-line stdlib/no-r
 	str += ', ';
 
 	// Order:
-	str += format( '\'%s\'', this._order );
+	str += format( '\'%s\'', ctx._order );
 
 	// Close the function call:
 	str += ' )';
 	return str;
-
-	/* eslint-enable no-invalid-this */
 }
 
 
 // EXPORTS //
 
-module.exports = toLocaleString;
+module.exports = serialize2string;

lib/main.js

@@ -0,0 +1,80 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
+var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;
+var isObject = require( '@stdlib/assert-is-plain-object' );
+var format = require( '@stdlib/string-format' );
+var serialize2string = require( './serialize2string.js' );
+
+
+// VARIABLES //
+
+var METHOD = 'toLocaleString';
+
+
+// MAIN //
+
+/**
+* Serializes an ndarray as a locale-aware string.
+*
+* ## Notes
+*
+* -   The method does **not** serialize data outside of the buffer region defined by the array configuration.
+*
+* @private
+* @param {(string|Array<string>)} [locales] - locale identifier(s)
+* @param {Object} [options] - configuration options
+* @throws {TypeError} first argument must be a string or an array of strings
+* @throws {TypeError} options argument must be an object
+* @returns {string} string representation
+*/
+function toLocaleString( locales, options ) { // eslint-disable-line stdlib/no-redeclare
+	/* eslint-disable no-invalid-this */
+	var nargs;
+	var opts;
+	var loc;
+
+	nargs = arguments.length;
+	if ( nargs === 0 ) {
+		loc = [];
+	} else if ( isString( locales ) || isStringArray( locales ) ) {
+		loc = locales;
+	} else {
+		throw new TypeError( format( 'invalid argument. First argument must be a string or an array of strings. Value: `%s`.', locales ) );
+	}
+	if ( nargs < 2 ) {
+		opts = {};
+	} else if ( isObject( options ) ) {
+		opts = options;
+	} else {
+		throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
+	}
+	return serialize2string( this, METHOD, loc, opts );
+
+	/* eslint-enable no-invalid-this */
+}
+
+
+// EXPORTS //
+
+module.exports = toLocaleString;