From b4a1c85d18783ecb68f5bf4aa80c6288b5382073 Mon Sep 17 00:00:00 2001 From: Aman Singh Date: Mon, 24 Nov 2025 15:48:06 +0530 Subject: [PATCH 1/2] chore: fix JavaScript lint errors (issue #8586) --- .../insert-header-file-list/lib/index.js | 34 +++++++++++++++++-- 1 file changed, 31 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/_tools/licenses/insert-header-file-list/lib/index.js b/lib/node_modules/@stdlib/_tools/licenses/insert-header-file-list/lib/index.js index 9e8c55bece9b..b8d2b6e6a311 100644 --- a/lib/node_modules/@stdlib/_tools/licenses/insert-header-file-list/lib/index.js +++ b/lib/node_modules/@stdlib/_tools/licenses/insert-header-file-list/lib/index.js @@ -24,10 +24,22 @@ * @module @stdlib/_tools/licenses/insert-header-file-list * * @example +* var join = require( 'path' ).join; +* var readFile = require( '@stdlib/fs/read-file' ).sync; +* var writeFile = require( '@stdlib/fs/write-file' ).sync; +* var unlink = require( '@stdlib/fs/unlink' ).sync; * var insertHeader = require( '@stdlib/_tools/licenses/insert-header-file-list' ); * +* // Create a temporary file: +* var src = join( __dirname, 'examples', 'fixtures', 'file.js.txt' ); +* var tmp = join( __dirname, 'examples', 'fixtures', 'tmp.js.txt' ); +* var err = writeFile( tmp, readFile( src ) ); +* if ( err ) { +* throw err; +* } +* * var files = [ -* './foo/bar.js' +* tmp * ]; * * var header = '// This file is licensed under Apache-2.0.'; @@ -38,21 +50,37 @@ * if ( error ) { * throw error; * } +* // Remove the temporary file: +* unlink( tmp ); * } * * @example +* var join = require( 'path' ).join; +* var readFile = require( '@stdlib/fs/read-file' ).sync; +* var writeFile = require( '@stdlib/fs/write-file' ).sync; +* var unlink = require( '@stdlib/fs/unlink' ).sync; * var insertHeader = require( '@stdlib/_tools/licenses/insert-header-file-list' ); * +* // Create a temporary file: +* var src = join( __dirname, 'examples', 'fixtures', 'file.js.txt' ); +* var tmp = join( __dirname, 'examples', 'fixtures', 'tmp.js.txt' ); +* var err = writeFile( tmp, readFile( src ) ); +* if ( err ) { +* throw err; +* } +* * var files = [ -* './foo/bar.js' +* tmp * ]; * * var header = '// This file is licensed under Apache-2.0.'; * -* var err = insertHeader.sync( files, header ); +* err = insertHeader.sync( files, header ); * if ( err instanceof Error ) { * throw err; * } +* // Remove the temporary file: +* unlink( tmp ); */ // MODULES // From 02244fbbbeeff3a066aa5bf6bab29146abf47cbb Mon Sep 17 00:00:00 2001 From: Aman Singh Date: Wed, 26 Nov 2025 20:19:24 +0530 Subject: [PATCH 2/2] refactor: improve JSDoc examples with robust error handling --- .../insert-header-file-list/lib/index.js | 45 ++++++++++--------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/lib/node_modules/@stdlib/_tools/licenses/insert-header-file-list/lib/index.js b/lib/node_modules/@stdlib/_tools/licenses/insert-header-file-list/lib/index.js index b8d2b6e6a311..973d7aa7ad62 100644 --- a/lib/node_modules/@stdlib/_tools/licenses/insert-header-file-list/lib/index.js +++ b/lib/node_modules/@stdlib/_tools/licenses/insert-header-file-list/lib/index.js @@ -25,62 +25,63 @@ * * @example * var join = require( 'path' ).join; -* var readFile = require( '@stdlib/fs/read-file' ).sync; * var writeFile = require( '@stdlib/fs/write-file' ).sync; * var unlink = require( '@stdlib/fs/unlink' ).sync; +* var tmpdir = require( '@stdlib/os/tmpdir' ); * var insertHeader = require( '@stdlib/_tools/licenses/insert-header-file-list' ); * -* // Create a temporary file: -* var src = join( __dirname, 'examples', 'fixtures', 'file.js.txt' ); -* var tmp = join( __dirname, 'examples', 'fixtures', 'tmp.js.txt' ); -* var err = writeFile( tmp, readFile( src ) ); +* // Create a temporary file in the system temp directory: +* var tmp = join( tmpdir(), 'example_file.js' ); +* var content = '\'use strict\';\n\nvar x = 3.14;\n'; +* var err = writeFile( tmp, content ); * if ( err ) { * throw err; * } * -* var files = [ -* tmp -* ]; -* +* var files = [ tmp ]; * var header = '// This file is licensed under Apache-2.0.'; * * insertHeader( files, header, done ); * * function done( error ) { +* // Always clean up the temporary file: +* var unlinkErr = unlink( tmp ); * if ( error ) { * throw error; * } -* // Remove the temporary file: -* unlink( tmp ); +* if ( unlinkErr ) { +* throw unlinkErr; +* } * } * * @example * var join = require( 'path' ).join; -* var readFile = require( '@stdlib/fs/read-file' ).sync; * var writeFile = require( '@stdlib/fs/write-file' ).sync; * var unlink = require( '@stdlib/fs/unlink' ).sync; +* var tmpdir = require( '@stdlib/os/tmpdir' ); * var insertHeader = require( '@stdlib/_tools/licenses/insert-header-file-list' ); * -* // Create a temporary file: -* var src = join( __dirname, 'examples', 'fixtures', 'file.js.txt' ); -* var tmp = join( __dirname, 'examples', 'fixtures', 'tmp.js.txt' ); -* var err = writeFile( tmp, readFile( src ) ); +* // Create a temporary file in the system temp directory: +* var tmp = join( tmpdir(), 'example_file.js' ); +* var content = '\'use strict\';\n\nvar x = 3.14;\n'; +* var err = writeFile( tmp, content ); * if ( err ) { * throw err; * } * -* var files = [ -* tmp -* ]; -* +* var files = [ tmp ]; * var header = '// This file is licensed under Apache-2.0.'; * * err = insertHeader.sync( files, header ); +* +* // Always clean up the temporary file: +* var unlinkErr = unlink( tmp ); * if ( err instanceof Error ) { * throw err; * } -* // Remove the temporary file: -* unlink( tmp ); +* if ( unlinkErr ) { +* throw unlinkErr; +* } */ // MODULES //