chore: rename lint rule

---
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: passed
  - 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: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

Author: Planeshifter

etc/eslint/rules/typescript.js

@@ -2715,13 +2715,13 @@ rules[ 'expect-type/expect' ] = 'error';
 /**
 * Ensures return annotations in TSDoc examples match the actual output.
 *
-* @name stdlib/tsdoc-doctest
+* @name stdlib/tsdoc-declarations-doctest
 * @memberof rules
 * @type {string}
 * @default 'error'
-* @see {@link module:@stdlib/_tools/eslint/rules/tsdoc-doctest}
+* @see {@link module:@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest}
 */
-rules[ 'stdlib/tsdoc-doctest' ] = 'error';
+rules[ 'stdlib/tsdoc-declarations-doctest' ] = 'error';
 
 
 // EXPORTS //

lib/node_modules/@stdlib/_tools/eslint/rules/lib/index.js

@@ -1072,13 +1072,13 @@ setReadOnly( rules, 'section-headers', require( '@stdlib/_tools/eslint/rules/sec
 setReadOnly( rules, 'ternary-condition-parentheses', require( '@stdlib/_tools/eslint/rules/ternary-condition-parentheses' ) );
 
 /**
-* @name tsdoc-doctest
+* @name tsdoc-declarations-doctest
 * @memberof rules
 * @readonly
 * @type {Function}
-* @see {@link module:@stdlib/_tools/eslint/rules/tsdoc-doctest}
+* @see {@link module:@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest}
 */
-setReadOnly( rules, 'tsdoc-doctest', require( '@stdlib/_tools/eslint/rules/tsdoc-doctest' ) );
+setReadOnly( rules, 'tsdoc-declarations-doctest', require( '@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest' ) );
 
 /**
 * @name uppercase-required-constants

…ols/eslint/rules/tsdoc-doctest/README.md …les/tsdoc-declarations-doctest/README.mdlib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-doctest/README.md renamed to lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/README.md lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-doctest/README.md renamed to lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/README.md

@@ -18,9 +18,9 @@ limitations under the License.
 
 -->
 
-# tsdoc-doctest
+# tsdoc-declarations-doctest
 
-> [ESLint rule][eslint-rules] to ensure that return annotations in TSDoc examples match the actual output.
+> [ESLint rule][eslint-rules] to ensure that return annotations in TSDoc examples match the actual output in TypeScript declaration files (`.d.ts`).
 
 <section class="intro">
 
@@ -33,16 +33,16 @@ limitations under the License.
 ## Usage
 
 ```javascript
-var rule = require( '@stdlib/_tools/eslint/rules/tsdoc-doctest' );
+var rule = require( '@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest' );
 ```
 
 #### rule
 
-[ESLint rule][eslint-rules] to ensure that return annotations in TSDoc examples match the actual output. Return annotations may start with `returns`, `throws`, or `=>`. `returns` follow variable declarations or assignment expressions, whereas `=>` follow expression-only forms including `console.log` calls. The rule validates `@example` blocks in TSDoc comments within `.d.ts` files by automatically resolving the corresponding implementation via the nearest `package.json` file.
+[ESLint rule][eslint-rules] to ensure that return annotations in TSDoc examples match the actual output in TypeScript declaration files (`.d.ts`). Return annotations may start with `returns`, `throws`, or `=>`. `returns` follow variable declarations or assignment expressions, whereas `=>` follow expression-only forms including `console.log` calls. The rule validates `@example` blocks in TSDoc comments within `.d.ts` files by automatically resolving the corresponding implementation via the nearest `package.json` file.
 
 **Bad**:
 
-<!-- eslint-disable stdlib/tsdoc-doctest -->
+<!-- eslint-disable stdlib/tsdoc-declarations-doctest -->
 
 ```typescript
 /**
@@ -93,13 +93,13 @@ export = add;
 ```javascript
 var Linter = require( 'eslint' ).Linter;
 var parser = require( '@typescript-eslint/parser' );
-var rule = require( '@stdlib/_tools/eslint/rules/tsdoc-doctest' );
+var rule = require( '@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest' );
 
 var linter = new Linter();
 
 // Register the TypeScript parser and ESLint rule:
 linter.defineParser( '@typescript-eslint/parser', parser );
-linter.defineRule( 'tsdoc-doctest', rule );
+linter.defineRule( 'tsdoc-declarations-doctest', rule );
 
 // Generate our source code with incorrect return annotation:
 var code = [
@@ -126,15 +126,15 @@ var result = linter.verify( code, {
         'sourceType': 'module'
     },
     'rules': {
-        'tsdoc-doctest': 'error'
+        'tsdoc-declarations-doctest': 'error'
     }
 }, {
     'filename': '/path/to/project/lib/node_modules/@stdlib/math/base/special/abs/docs/types/index.d.ts'
 });
 /* returns
     [
         {
-            'ruleId': 'tsdoc-doctest',
+            'ruleId': 'tsdoc-declarations-doctest',
             'severity': 2,
             'message': 'Displayed return value is `2`, but expected `3` instead',
             'line': 9,
@@ -158,6 +158,7 @@ var result = linter.verify( code, {
 -   The rule automatically resolves the implementation path by traversing up the directory tree to find the nearest `package.json` file and using its `main` field.
 -   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` extension.
 
 </section>
 

…nt/rules/tsdoc-doctest/examples/index.js …c-declarations-doctest/examples/index.jslib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-doctest/examples/index.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/examples/index.js lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-doctest/examples/index.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/examples/index.js

@@ -26,7 +26,7 @@ var linter = new Linter();
 
 // Register the TypeScript parser and ESLint rule:
 linter.defineParser( '@typescript-eslint/parser', parser );
-linter.defineRule( 'tsdoc-doctest', rule );
+linter.defineRule( 'tsdoc-declarations-doctest', rule );
 
 // Generate our source code with incorrect return annotation:
 var code = [
@@ -53,7 +53,7 @@ var result = linter.verify( code, {
 		'sourceType': 'module'
 	},
 	'rules': {
-		'tsdoc-doctest': 'error'
+		'tsdoc-declarations-doctest': 'error'
 	}
 }, {
 	'filename': 'lib/node_modules/@stdlib/math/base/special/abs/docs/types/index.d.ts'
@@ -63,7 +63,7 @@ console.log( result );
 /* =>
 	[
 		{
-			'ruleId': 'tsdoc-doctest',
+			'ruleId': 'tsdoc-declarations-doctest',
 			'severity': 2,
 			'message': 'Displayed return value is `2`, but expected `3` instead',
 			'line': 9,

…sdoc-doctest/lib/add_package_to_scope.js …ions-doctest/lib/add_package_to_scope.jslib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-doctest/lib/add_package_to_scope.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/lib/add_package_to_scope.js lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-doctest/lib/add_package_to_scope.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/lib/add_package_to_scope.js

@@ -21,10 +21,10 @@
 /**
 * ESLint rule to ensure return annotations in TypeScript declaration examples match the actual output.
 *
-* @module @stdlib/_tools/eslint/rules/tsdoc-doctest
+* @module @stdlib/_tools/eslint/rules/tsdoc-declarations-doctest
 *
 * @example
-* var rule = require( '@stdlib/_tools/eslint/rules/tsdoc-doctest' );
+* var rule = require( '@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest' );
 *
 * console.log( rule );
 */