Merge branch 'develop' into find-last-index

Signed-off-by: Aayush Khanna <[email protected]>

Author: aayush0325

.github/workflows/generate_pr_commit_message.yml

@@ -70,10 +70,21 @@ jobs:
         id: commit_message
         run: |
           COMMIT_MESSAGE=$($GITHUB_WORKSPACE/.github/workflows/scripts/generate_pr_commit_message $PR_NUMBER)
+          EXIT_CODE=$?
+
           echo "commit_message<<EOF" >> $GITHUB_OUTPUT
           echo "$COMMIT_MESSAGE" >> $GITHUB_OUTPUT
           echo "EOF" >> $GITHUB_OUTPUT
 
+          if [ $EXIT_CODE -eq 200 ]; then
+            echo "has_tracking_issue=true" >> $GITHUB_OUTPUT
+          else
+            echo "has_tracking_issue=false" >> $GITHUB_OUTPUT
+          fi
+
+          # Ensure the script itself doesn't fail the workflow:
+          exit 0
+
       # Post commit message as PR comment:
       - name: 'Post commit message as PR comment'
         uses: peter-evans/create-or-update-comment@v4
@@ -88,3 +99,5 @@ jobs:
             ```
 
             *Please review the above commit message and make any necessary adjustments.*
+
+            ${{ steps.commit_message.outputs.has_tracking_issue == 'true' && '⚠️ **Action Required**: This PR references tracking issues. Please update the PR description to replace any "Closes", "Fixes", or "Resolves" keywords with "Ref" when referencing these issues.' || '' }}

.github/workflows/scripts/generate_pr_commit_message

@@ -45,6 +45,11 @@ GITHUB_API_URL="https://api.github.com"
 REPO_OWNER="stdlib-js"
 REPO_NAME="stdlib"
 
+# Exit codes
+SUCCESS=0
+ERROR=1
+TRACKING_ISSUE_FOUND=200
+
 
 # FUNCTIONS #
 
@@ -126,12 +131,12 @@ github_api() {
 			else
 				# Handle cases where POST data is required but not provided:
 				echo "POST request requires data."
-				on_error 1
+				on_error $ERROR
 			fi
 			;;
 		*)
 			echo "Invalid HTTP method: $method"
-			on_error 1
+			on_error $ERROR
 			;;
 	esac
 }
@@ -226,8 +231,17 @@ main() {
 	# Create a regex pattern from the keywords:
 	keywords_pattern=$(IFS='|'; echo "${closing_keywords[*]}")
 
+	EXIT_CODE=$SUCCESS
 	for issue in $issue_numbers; do
-		if echo "$pr_body" | grep -Eiq "(${keywords_pattern})([[:space:]]+|:)[[:space:]]*#${issue}\b"; then
+		# Fetch issue labels:
+		issue_details=$(github_api "GET" "/repos/$REPO_OWNER/$REPO_NAME/issues/$issue")
+		issue_labels=$(echo "$issue_details" | jq -r '.labels[].name')
+
+		# Check if the issue is a tracking issue:
+		if echo "$issue_labels" | grep -q "Tracking Issue"; then
+			EXIT_CODE=$TRACKING_ISSUE_FOUND
+			ref_issues+="Ref: https://github.com/$REPO_OWNER/$REPO_NAME/issues/$issue\n"
+		elif echo "$pr_body" | grep -Eiq "(${keywords_pattern})([[:space:]]+|:)[[:space:]]*#${issue}\b"; then
 			closes_issues+="Closes: https://github.com/$REPO_OWNER/$REPO_NAME/issues/$issue\n"
 		else
 			ref_issues+="Ref: https://github.com/$REPO_OWNER/$REPO_NAME/issues/$issue\n"
@@ -265,6 +279,9 @@ main() {
 
 	# Output the commit message:
 	echo -e "$commit_message"
+
+	# Return successful exit code (200 if a tracking issue was found, 0 otherwise):
+    return $EXIT_CODE
 }
 
 # Call main with all command-line arguments:

lib/node_modules/@stdlib/_tools/eslint/rules/vars-order/lib/main.js

@@ -81,19 +81,88 @@ function main( context ) {
 		break;
 	}
 
+	/**
+	* Sorts the variable declarations by name length.
+	*
+	* @private
+	* @param {Object} a - input object
+	* @param {Object} b - comparison object
+	* @returns {number} number indicating sort order
+	*/
+	function sortVars( a, b ) {
+		if ( fun( a.name.length, b.name.length ) ) {
+			return 1;
+		}
+		return -1;
+	}
+
 	/**
 	* Reports the error message.
 	*
 	* @private
 	* @param {string} msg - error message
-	* @param {Object} loc - lines of code (object with `start` and `end` properties)
+	* @param {ASTNode} node - node to fix
 	*/
-	function report( msg, loc ) {
+	function report( msg, node ) {
 		context.report({
 			'node': null,
 			'message': msg,
-			'loc': loc
+			'loc': node.loc,
+			'fix': fix
 		});
+
+		/**
+		* Fixes the lint error by reordering the variable declarations inside of the function.
+		*
+		* @private
+		* @param {Function} fixer - ESLint fixer
+		* @returns {(Object|null)} fix or null
+		*/
+		function fix( fixer ) {
+			var replacingText;
+			var declarations;
+			var startRange;
+			var endRange;
+			var source;
+			var elem;
+			var body;
+			var i;
+			var j;
+
+			declarations = [];
+			replacingText = '';
+			body = node.body.body;
+			source = context.getSourceCode();
+
+			for ( i = 0; i < body.length; i++ ) {
+				elem = body[ i ];
+				if ( elem.type === 'VariableDeclaration' && elem.kind === 'var' ) {
+					declarations.push({
+						'text': source.getText( elem ),
+						'name': elem.declarations[ 0 ].id.name,
+						'col': elem.loc.start.column
+					});
+					if ( declarations.length === 1 ) {
+						startRange = elem.range[ 0 ] - elem.loc.start.column;
+					}
+					endRange = elem.range[ 1 ];
+				}
+			}
+
+			declarations.sort( sortVars );
+
+			for ( i = 0; i < declarations.length; i++ ) {
+				for ( j = 0; j < declarations[ i ].col; j++ ) {
+					replacingText += '\t';
+				}
+				replacingText += declarations[ i ].text;
+				if ( i !== declarations.length -1 ) {
+					replacingText += '\n';
+				}
+			}
+
+			return fixer.replaceTextRange( [ startRange, endRange ], replacingText ); // eslint-disable-line max-len
+		}
 	}
 
 	/**
@@ -117,7 +186,7 @@ function main( context ) {
 			if ( elem.type === 'VariableDeclaration' && elem.kind === 'var' ) {
 				name = elem.declarations[ 0 ].id.name;
 				if ( prevLength && !fun( name.length, prevLength ) ) {
-					return report( 'Variable declarations inside of function are not ordered by length (in '+ order +' order)', node.loc );
+					return report( 'Variable declarations inside of function are not ordered by length (in '+ order +' order)', node );
 				}
 				prevLength = name.length;
 			}
@@ -135,9 +204,11 @@ function main( context ) {
 
 rule = {
 	'meta': {
+		'type': 'layout',
 		'docs': {
 			'description': 'require variable declarations inside of functions to be ordered by length'
 		},
+		'fixable': 'code',
 		'schema': [
 			{
 				'order': [ 'increasing', 'decreasing' ]