build: support specifying alias via custom comment

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

Author: Planeshifter

lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/README.md

@@ -89,6 +89,7 @@ declare function add( x: number, y: number ): number;
 -   The rule skips validation if the `package.json` file cannot be found or if the resolved implementation cannot be loaded.
 -   Examples are executed in a sandboxed VM context with limited globals for security.
 -   This rule is specifically designed for TypeScript declaration files and will only process files with a `*.d.ts` filename extension.
+-   You can specify a custom alias for the package export in the doctest scope using a comment in the format `// eslint-doctest-alias: <alias>`. This is useful when the TypeScript declaration uses a type name that differs from the exported identifier, or when you want to use a specific identifier in examples for clarity.
 
 </section>
 

lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/lib/add_package_to_scope.js

@@ -35,6 +35,9 @@ var RE_DECLARE_CONST = /declare\s+const\s+([a-zA-Z_$][a-zA-Z0-9_$]*)\s*:/;
 // Regular expression to match variable declarations with interface types such as "declare var ctor: Int32Vector;" (captures variable name and interface name):
 var RE_DECLARE_VAR_INTERFACE = /declare\s+(?:var|const)\s+([a-zA-Z_$][a-zA-Z0-9_$]*)\s*:\s*([A-Z][a-zA-Z0-9_$]*)/;
 
+// Regular expression to match custom alias comment "// eslint-doctest-alias: <alias>" capturing alias name:
+var RE_ALIAS_COMMENT = /\/\/\s*eslint-doctest-alias:\s*([a-zA-Z_$][a-zA-Z0-9_$]*)/;
+
 
 // MAIN //
 
@@ -49,9 +52,16 @@ var RE_DECLARE_VAR_INTERFACE = /declare\s+(?:var|const)\s+([a-zA-Z_$][a-zA-Z0-9_
 function addPackageToScope( scope, pkg, sourceText ) {
 	var interfaceMatch;
 	var namespaceMatch;
+	var aliasMatch;
 	var pkgType;
 	var match;
 
+	// Check for custom alias comment first...
+	aliasMatch = sourceText.match( RE_ALIAS_COMMENT );
+	if ( aliasMatch ) {
+		scope[ aliasMatch[1] ] = pkg;
+	}
+
 	pkgType = typeof pkg;
 	if ( pkgType === 'function' ) {
 		match = sourceText.match( RE_DECLARE_FUNCTION ) || sourceText.match( RE_DECLARE_VAR ) || sourceText.match( RE_DECLARE_CLASS ); // eslint-disable-line max-len

lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/test/fixtures/packages/@stdlib/array/index/_package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@stdlib/array/index",
+  "version": "0.0.0",
+  "description": "Create an array index.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "main": "./lib",
+  "directories": {
+    "doc": "./docs",
+    "example": "./examples",
+    "lib": "./lib",
+    "test": "./test"
+  },
+  "types": "./docs/types",
+  "scripts": {},
+  "homepage": "https://github.com/stdlib-js/stdlib",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/stdlib.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {},
+  "devDependencies": {},
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "keywords": [
+    "stdlib",
+    "array",
+    "index",
+    "indexing"
+  ]
+}

lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/test/fixtures/packages/@stdlib/array/index/lib/index.js

@@ -0,0 +1,30 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+/* eslint-disable stdlib/jsdoc-main-export */
+
+// MODULES //
+
+var ArrayIndex = require( '@stdlib/array/index' );
+
+
+// EXPORTS //
+
+module.exports = ArrayIndex;

lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/test/fixtures/valid.js

@@ -185,6 +185,34 @@ test = {
 };
 valid.push( test );
 
+test = {
+	'code': [
+		'// eslint-doctest-alias: ArrayIndex',
+		'',
+		'/**',
+		'* Array index constructor.',
+		'*',
+		'* @param x - input array',
+		'* @returns ArrayIndex instance',
+		'*',
+		'* @example',
+		'* var x = [ 1, 2, 3, 4 ];',
+		'*',
+		'* var idx = new ArrayIndex( x );',
+		'* // returns <ArrayIndex>',
+		'*/',
+		'interface Constructor {',
+		'    new( x: Array<number> ): any;',
+		'}',
+		'',
+		'declare var ctor: Constructor;',
+		'',
+		'export = ctor;'
+	].join( '\n' ),
+	'filename': join( __dirname, 'packages/@stdlib/array/index/docs/types/index.d.ts' )
+};
+valid.push( test );
+
 
 // EXPORTS //