feat: enforce primary header filenames

docs/contributing/packages.md

@@ -34,6 +34,7 @@ Every package in stdlib has, at minimum, the following structure:
 
 ```text
 benchmark/         benchmarks
+include/            public C/C++ header files
 docs/              documentation (excluding README)
 examples/          examples
 lib/               package implementation

lib/node_modules/@stdlib/_tools/lint/header-filenames/lib/lint.js

@@ -20,7 +20,7 @@
 
 // MODULES //
 
 var basename = require( 'path' ).basename; // TODO: use stdlib module
 var objectKeys = require( '@stdlib/utils/keys' );
 var extname = require( '@stdlib/utils/extname' );
 var hasOwnProp = require( '@stdlib/assert/has-own-property' );
@@ -39,21 +39,50 @@
 * @returns {(ObjectArray|EmptyArray)} array of lint errors
 */
 function lint( arr ) {
+	var packageNames;
+	var packagePath;
+	var expected;
+	var packages;
 	var headers;
+	var include;
 	var fnames;
 	var fname;
-	var list;
 	var exts;
+	var name;
+	var list;
 	var ext;
 	var tmp;
 	var out;
+	var pkg;
 	var i;
 	var j;
 	var k;
 
 	headers = {};
+	packages = {};
 	out = [];
 	for ( i = 0; i < arr.length; i++ ) {
+		name = arr[ i ].replace( /\\/g, '/' );
+		if ( name.indexOf( '/include/' ) !== -1 ) {
+			include = name.substring( 0, name.indexOf( '/include/' )+9 );
+			pkg = basename( include.substring( 0, include.length-9 ) );
+			if ( pkg !== '.' && pkg !== '..' && !/^[A-Za-z]:\//.test( name ) ) {
+				expected = pkg.replace( /-/g, '_' )+'.h';
+				if ( include.indexOf( '/@stdlib/' ) !== -1 ) {
+					packagePath = include.substring( include.indexOf( '/@stdlib/' )+9, include.length-9 );
+					expected = 'stdlib/'+packagePath.slice( 0, -pkg.length )+pkg.replace( /-/g, '_' )+'.h';
+				}
+				if ( !packages[ include ] ) {
+					packages[ include ] = {
+						'path': include+expected,
+						'found': false
+					};
+				}
+				if ( name === packages[ include ].path || name === packages[ include ].path.replace( /\\.h$/, '.hpp' ) ) {
+					packages[ include ].found = true;
+				}
+			}
+		}
 		fname = basename( arr[ i ] );
 		ext = extname( fname );
 		fname = fname.substring( 0, fname.length-ext.length );
@@ -81,6 +110,16 @@
 			headers[ ext ][ fname ] = [ arr[ i ] ];
 		}
 	}
+	// Ensure every package has a primary header file...
+	packageNames = objectKeys( packages );
+	for ( i = 0; i < packageNames.length; i++ ) {
+		if ( !packages[ packageNames[ i ] ].found ) {
+			out.push({
+				'name': packages[ packageNames[ i ] ].path,
+				'error': 'missing primary header file.'
+			});
+		}
+	}
 	// For every basename found multiple times, log a lint error...
 	exts = objectKeys( headers );
 	for ( i = 0; i < exts.length; i++ ) {

lib/node_modules/@stdlib/_tools/lint/header-filenames/test/test.cli.js

@@ -56,7 +56,7 @@
 	var expected;
 	var cmd;
 
 	expected = readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
 		'encoding': 'utf8'
 	});
 	cmd = [
@@ -82,7 +82,7 @@
 	var expected;
 	var cmd;
 
 	expected = readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
 		'encoding': 'utf8'
 	});
 	cmd = [
@@ -191,7 +191,7 @@
 			t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
 
 			results = stderr.toString().split( RE_EOL );
-			t.strictEqual( results.length, 3, 'returns expected number of errors' );
+			t.strictEqual( results.length, 4, 'returns expected number of errors' );
 			for ( i = 0; i < results.length-1; i++ ) {
 				t.strictEqual( isJSON( results[i] ), true, 'returns JSON' );
 			}
@@ -273,7 +273,7 @@
 	var opts;
 	var cmd;
 
 	script = readFileSync( resolve( __dirname, 'fixtures', 'stdin_error.js.txt' ), {
 		'encoding': 'utf8'
 	});
 

lib/node_modules/@stdlib/_tools/lint/header-filenames/test/test.lint.js

@@ -118,3 +118,63 @@ tape( 'the function returns an empty array if all header base filenames are vali
 	t.strictEqual( names.length, 0, 'returns expected value' );
 	t.end();
 });
+
+tape( 'the function returns an error if a package is missing its primary header file', function test( t ) {
+	var names;
+
+	names = lint([
+		'foo/include/private.h'
+	]);
+
+	t.strictEqual( names.length, 1, 'returns one error' );
+	t.strictEqual( names[ 0 ].name, 'foo/include/foo.h', 'returns expected filename' );
+	t.strictEqual( names[ 0 ].error, 'missing primary header file.', 'returns expected error' );
+	t.end();
+});
+
+tape( 'the function allows additional header files with arbitrary names', function test( t ) {
+	var names;
+
+	names = lint([
+		'foo/include/foo.h',
+		'foo/include/private.h'
+	]);
+
+	t.strictEqual( names.length, 0, 'returns an empty array' );
+	t.end();
+});
+
+tape( 'the function converts hyphens in a package path to underscores when resolving the primary header file', function test( t ) {
+	var names;
+
+	names = lint([
+		'lib/node_modules/@stdlib/math/base/assert/int32-is-even/include/stdlib/math/base/assert/int32_is_even.h'
+	]);
+
+	t.strictEqual( names.length, 0, 'returns an empty array' );
+	t.end();
+});
+
+tape( 'the function does not convert hyphens in parent package directories when resolving the primary header file', function test( t ) {
+	var names;
+
+	names = lint([
+		'lib/node_modules/@stdlib/foo-bar/my-package/include/stdlib/foo-bar/my_package.h'
+	]);
+
+	t.strictEqual( names.length, 0, 'returns an empty array' );
+	t.end();
+});
+
+tape( 'the function returns an error if the primary header filename is invalid', function test( t ) {
+	var names;
+
+	names = lint([
+		'lib/node_modules/@stdlib/foo-bar/my-package/include/stdlib/foo-bar/wrong_name.h'
+	]);
+
+	t.strictEqual( names.length, 1, 'returns one error' );
+	t.strictEqual( names[ 0 ].name, 'lib/node_modules/@stdlib/foo-bar/my-package/include/stdlib/foo-bar/my_package.h', 'returns expected filename' );
+	t.strictEqual( names[ 0 ].error, 'missing primary header file.', 'returns expected error' );
+	t.end();
+});