|
24 | 24 | * @module @stdlib/_tools/licenses/insert-header-file-list |
25 | 25 | * |
26 | 26 | * @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; |
27 | 31 | * var insertHeader = require( '@stdlib/_tools/licenses/insert-header-file-list' ); |
28 | 32 | * |
| 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 | +* |
29 | 41 | * var files = [ |
30 | | -* './foo/bar.js' |
| 42 | +* tmp |
31 | 43 | * ]; |
32 | 44 | * |
33 | 45 | * var header = '// This file is licensed under Apache-2.0.'; |
|
38 | 50 | * if ( error ) { |
39 | 51 | * throw error; |
40 | 52 | * } |
| 53 | +* // Remove the temporary file: |
| 54 | +* unlink( tmp ); |
41 | 55 | * } |
42 | 56 | * |
43 | 57 | * @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; |
44 | 62 | * var insertHeader = require( '@stdlib/_tools/licenses/insert-header-file-list' ); |
45 | 63 | * |
| 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 | +* |
46 | 72 | * var files = [ |
47 | | -* './foo/bar.js' |
| 73 | +* tmp |
48 | 74 | * ]; |
49 | 75 | * |
50 | 76 | * var header = '// This file is licensed under Apache-2.0.'; |
51 | 77 | * |
52 | | -* var err = insertHeader.sync( files, header ); |
| 78 | +* err = insertHeader.sync( files, header ); |
53 | 79 | * if ( err instanceof Error ) { |
54 | 80 | * throw err; |
55 | 81 | * } |
| 82 | +* // Remove the temporary file: |
| 83 | +* unlink( tmp ); |
56 | 84 | */ |
57 | 85 |
|
58 | 86 | // MODULES // |
|
0 commit comments