Do not flag words with special characters

Author: Planeshifter

lib/node_modules/@stdlib/_tools/eslint/rules/capitalized-comments/lib/main.js

@@ -30,6 +30,7 @@ var DEFAULTS = require( './defaults.json' );
 // VARIABLES //
 
 var RE_LETTERS = /^[a-zA-Z]/;
+var RE_SPECIAL_CHARS = /[^a-zA-Z]/;
 var OPTS = {
 	'includeComments': true
 };
@@ -126,7 +127,11 @@ function main( context ) {
 				}
 				if ( scope.set.has( stext ) ) {
 					found = true;
+				} else if ( RE_SPECIAL_CHARS.test( stext ) ) {
+					// Do not flag first word if it contains special characters (e.g., `x-value`):
+					found = true;
 				} else {
+					// Check if the first word is contained in the whitelist (e.g., `ndarray`):
 					for ( i = 0; i < opts.whitelist.length; i++ ) {
 						word = opts.whitelist[ i ];
 						if ( stext === word ) {
@@ -135,7 +140,7 @@ function main( context ) {
 						}
 					}
 				}
-				// If not in whitelist or current scope, raise an error:
+				// If word is not in whitelist, has no special characters, and is not found in current scope, raise an error:
 				if ( !found ) {
 					report( comment );
 				}

lib/node_modules/@stdlib/_tools/eslint/rules/capitalized-comments/test/fixtures/valid.js

@@ -464,6 +464,15 @@ test = {
 };
 valid.push( test );
 
+test = {
+	'code': [
+		'function square( x ) {',
+		'  return x*x; // x-value squared',
+		'}'
+	].join( '\n' )
+};
+valid.push( test );
+
 
 // EXPORTS //