Apply suggestions from code review

Signed-off-by: Athan <[email protected]>

Author: kgryte

lib/node_modules/@stdlib/_tools/remark/plugins/remark-lint-html-section-structure/lib/main.js

@@ -73,7 +73,7 @@ function reportErr( file, node, message, errorCode ) {
 * @param {Object} node - AST node containing comment
 * @param {RegExp} matchRegex - regular expression for matching comment
 * @param {RegExp} simpleMatchRegex - alternative regular expression for matching comment
-* @returns {string|null} extracted class name or null if no match
+* @returns {(string|null)} extracted class name or null if no match
 */
 function extractCommentClass( node, matchRegex, simpleMatchRegex ) {
 	var simpleMatch;
@@ -239,7 +239,7 @@ function linter( tree, file, options, clbk ) {
 			return;
 		}
 
-		// Check if this is a section start tag
+		// Check if this is a section start tag:
 		sectionMatch = SECTION_START.exec( node.value );
 		if ( sectionMatch ) {
 			debug( 'Found a section start tag with class: %s', sectionMatch[1] || '[none]' );
@@ -281,15 +281,15 @@ function linter( tree, file, options, clbk ) {
 
 			// Special handling for direct closing tag followed by a comment (no text node between)...
 			if ( index + 1 < parent.children.length ) {
-				nextNode = parent.children[index + 1];
+				nextNode = parent.children[ index + 1 ];
 
 				// Look at the next node to check if it's a comment:
 				if ( nextNode.type === 'html' ) {
 					// Check if the next node is a comment but NOT on the same line
 					commentClass = extractCommentClass( nextNode, END_COMMENT, END_COMMENT_SIMPLE );
 
 					if ( commentClass ) {
-						// Check if there are at least 2 line breaks between them
+						// Check if there are at least 2 line breaks between them:
 						if ( !hasValidWhitespace( node, nextNode ) ) {
 							msg = 'Missing proper empty line after closing section tag. There should be an empty line between </section> and the closing comment.';
 							errCode = 'missing-empty-line-after-section';
@@ -311,8 +311,8 @@ function linter( tree, file, options, clbk ) {
 
 			// Standard handling for other cases with whitespace between section end and comment...
 			if ( index + 2 < parent.children.length ) {
-				nextNode = parent.children[index + 1];
-				commentNode = parent.children[index + 2];
+				nextNode = parent.children[ index + 1 ];
+				commentNode = parent.children[ index + 2 ];
 
 				// Check if the next node is a proper whitespace with empty line:
 				if ( !hasEmptyLine( nextNode ) ) {
@@ -333,21 +333,21 @@ function linter( tree, file, options, clbk ) {
 					} else {
 						// The HTML node exists but it's not a proper closing comment...
 						debug( 'Invalid closing comment format' );
-						msg = 'Invalid section closing comment format. Expected <!-- /.' + sectionStack[sectionStack.length - 1].className + ' -->';
+						msg = 'Invalid section closing comment format. Expected <!-- /.' + sectionStack[ sectionStack.length - 1 ].className + ' -->';
 						errCode = 'invalid-closing-comment';
 						reportErr( file, commentNode, msg, errCode );
 					}
 				} else {
 					// The node after whitespace is not an HTML node (comment)...
 					debug( 'Node after whitespace is not an HTML comment' );
-					msg = 'Missing section closing comment. Section closing tag should be followed by <!-- /.' + sectionStack[sectionStack.length - 1].className + ' --> comment.';
+					msg = 'Missing section closing comment. Section closing tag should be followed by <!-- /.' + sectionStack[ sectionStack.length - 1 ].className + ' --> comment.';
 					errCode = 'missing-section-comment';
 					reportErr( file, node, msg, errCode );
 				}
 			} else {
 				// There's not enough nodes after the section closing tag...
 				debug( 'Not enough nodes after section end' );
-				msg = 'Missing section closing comment. Section closing tag should be followed by <!-- /.' + sectionStack[sectionStack.length - 1].className + ' --> comment on a separate line.';
+				msg = 'Missing section closing comment. Section closing tag should be followed by <!-- /.' + sectionStack[ sectionStack.length - 1 ].className + ' --> comment on a separate line.';
 				errCode = 'missing-section-comment';
 				reportErr( file, node, msg, errCode );
 			}