Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -24,35 +24,64 @@
* @module @stdlib/_tools/licenses/insert-header-file-list
*
* @example
* var join = require( 'path' ).join;
* 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' );
*
* var files = [
* './foo/bar.js'
* ];
* // 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 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;
* }
* if ( unlinkErr ) {
* throw unlinkErr;
* }
* }
*
* @example
* var join = require( 'path' ).join;
* 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' );
*
* var files = [
* './foo/bar.js'
* ];
* // 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 header = '// This file is licensed under Apache-2.0.';
*
* var err = insertHeader.sync( files, header );
* err = insertHeader.sync( files, header );
*
* // Always clean up the temporary file:
* var unlinkErr = unlink( tmp );
* if ( err instanceof Error ) {
* throw err;
* }
* if ( unlinkErr ) {
* throw unlinkErr;
* }
*/

// MODULES //
Expand Down