'use strict';

/**
* Lint file license headers.
*
* @module @stdlib/_tools/lint/file-license-header
*
* @example
* var lint = require( '@stdlib/_tools/lint/file-license-header' );
*
* var opts = {
*     'dir': __dirname
* };
*
* lint( opts, onLint );
*
* function onLint( error, errs ) {
*     if ( error ) {
*         throw error;
*     }
*     console.error( errs );
* }
*
* @example
* var lint = require( '@stdlib/_tools/lint/file-license-header' );
*
* var errs = lint.sync();
* // returns [...]
*/

// MODULES //

var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
var lint = require( './main.js' );
var sync = require( './sync.js' );


// MAIN //

setReadOnly( lint, 'sync', sync );


// EXPORTS //

module.exports = lint;

'use strict';

/**
* Lint file license headers.
*
* @module @stdlib/_tools/lint/file-license-header
*
* @example
* var lint = require( '@stdlib/_tools/lint/file-license-header' );
*
* var opts = {
*     'dir': __dirname
* };
*
* lint( opts, onLint );
*
* function onLint( error, errs ) {
*     if ( error ) {
*         throw error;
*     }
*     console.error( errs );
* }
*
* @example
* var lint = require( '@stdlib/_tools/lint/file-license-header' );
*
* var opts = {
*     'dir': __dirname
* };
*
* var errs = lint.sync( opts );
* // returns [...]
*/

// MODULES //

var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
var lint = require( './main.js' );
var sync = require( './sync.js' );


// MAIN //

setReadOnly( lint, 'sync', sync );


// EXPORTS //

module.exports = lint;

Update example