Skip to content

Commit b4a1c85

Browse files
committed
chore: fix JavaScript lint errors (issue #8586)
1 parent e0b955f commit b4a1c85

File tree

1 file changed

+31
-3
lines changed
  • lib/node_modules/@stdlib/_tools/licenses/insert-header-file-list/lib

1 file changed

+31
-3
lines changed

lib/node_modules/@stdlib/_tools/licenses/insert-header-file-list/lib/index.js

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,22 @@
2424
* @module @stdlib/_tools/licenses/insert-header-file-list
2525
*
2626
* @example
27+
* var join = require( 'path' ).join;
28+
* var readFile = require( '@stdlib/fs/read-file' ).sync;
29+
* var writeFile = require( '@stdlib/fs/write-file' ).sync;
30+
* var unlink = require( '@stdlib/fs/unlink' ).sync;
2731
* var insertHeader = require( '@stdlib/_tools/licenses/insert-header-file-list' );
2832
*
33+
* // Create a temporary file:
34+
* var src = join( __dirname, 'examples', 'fixtures', 'file.js.txt' );
35+
* var tmp = join( __dirname, 'examples', 'fixtures', 'tmp.js.txt' );
36+
* var err = writeFile( tmp, readFile( src ) );
37+
* if ( err ) {
38+
* throw err;
39+
* }
40+
*
2941
* var files = [
30-
* './foo/bar.js'
42+
* tmp
3143
* ];
3244
*
3345
* var header = '// This file is licensed under Apache-2.0.';
@@ -38,21 +50,37 @@
3850
* if ( error ) {
3951
* throw error;
4052
* }
53+
* // Remove the temporary file:
54+
* unlink( tmp );
4155
* }
4256
*
4357
* @example
58+
* var join = require( 'path' ).join;
59+
* var readFile = require( '@stdlib/fs/read-file' ).sync;
60+
* var writeFile = require( '@stdlib/fs/write-file' ).sync;
61+
* var unlink = require( '@stdlib/fs/unlink' ).sync;
4462
* var insertHeader = require( '@stdlib/_tools/licenses/insert-header-file-list' );
4563
*
64+
* // Create a temporary file:
65+
* var src = join( __dirname, 'examples', 'fixtures', 'file.js.txt' );
66+
* var tmp = join( __dirname, 'examples', 'fixtures', 'tmp.js.txt' );
67+
* var err = writeFile( tmp, readFile( src ) );
68+
* if ( err ) {
69+
* throw err;
70+
* }
71+
*
4672
* var files = [
47-
* './foo/bar.js'
73+
* tmp
4874
* ];
4975
*
5076
* var header = '// This file is licensed under Apache-2.0.';
5177
*
52-
* var err = insertHeader.sync( files, header );
78+
* err = insertHeader.sync( files, header );
5379
* if ( err instanceof Error ) {
5480
* throw err;
5581
* }
82+
* // Remove the temporary file:
83+
* unlink( tmp );
5684
*/
5785

5886
// MODULES //

0 commit comments

Comments
 (0)