@ttsc/lint 0.14.0-dev.20260529.1 → 0.14.0

package/src/structures/rules/ITtscLintJestRules.ts

@@ -4,62 +4,58 @@ import type { TtscLintRuleSetting } from "../TtscLintRuleSetting";
  * Jest test source rules from `eslint-plugin-jest`.
  *
  * Apply to TypeScript test files that use the Jest runner (`describe`,
- * `test`/`it`, `expect`, lifecycle hooks). They guard test-quality
- * patterns the type system cannot detect — unended assertions, focused
- * tests left behind, duplicate hook calls.
+ * `test`/`it`, `expect`, lifecycle hooks). They guard test-quality patterns the
+ * type system cannot detect — unended assertions, focused tests left behind,
+ * duplicate hook calls.
  *
  * @reference https://github.com/jest-community/eslint-plugin-jest
  */
 export interface ITtscLintJestRules {
   /**
-   * Require every Jest test body to contain at least one
-   * `expect(...)` call. A test with no expectations passes silently.
+   * Require every Jest test body to contain at least one `expect(...)` call. A
+   * test with no expectations passes silently.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/expect-expect.md
    */
   "jest/expect-expect"?: TtscLintRuleSetting;
 
   /**
-   * Limit the number of `expect(...)` calls inside a single Jest test
-   * body.
+   * Limit the number of `expect(...)` calls inside a single Jest test body.
    *
-   * A test packed with assertions usually verifies several behaviors
-   * at once, making failures ambiguous — splitting per scenario keeps
-   * each case diagnostic.
+   * A test packed with assertions usually verifies several behaviors at once,
+   * making failures ambiguous — splitting per scenario keeps each case
+   * diagnostic.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/max-expects.md
    */
   "jest/max-expects"?: TtscLintRuleSetting;
 
   /**
-   * Reject `expect(...)` calls under `if`/`try`/`catch` or other
-   * conditional branches in Jest tests.
+   * Reject `expect(...)` calls under `if`/`try`/`catch` or other conditional
+   * branches in Jest tests.
    *
-   * A branch that never executes turns the assertion into a silent
-   * no-op, so the test passes without verifying anything.
+   * A branch that never executes turns the assertion into a silent no-op, so
+   * the test passes without verifying anything.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-conditional-expect.md
    */
   "jest/no-conditional-expect"?: TtscLintRuleSetting;
 
   /**
-   * Reject conditional logic (`if`/`switch`/ternary) inside Jest
-   * test bodies.
+   * Reject conditional logic (`if`/`switch`/ternary) inside Jest test bodies.
    *
-   * Each test should describe a single deterministic scenario;
-   * branching hides which path the runner took when reading a
-   * passing log.
+   * Each test should describe a single deterministic scenario; branching hides
+   * which path the runner took when reading a passing log.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-conditional-in-test.md
    */
   "jest/no-conditional-in-test"?: TtscLintRuleSetting;
 
   /**
-   * Reject `test.skip`, `xit`, `xdescribe`, and other disabled Jest
-   * tests.
+   * Reject `test.skip`, `xit`, `xdescribe`, and other disabled Jest tests.
    *
-   * Skipped tests appear green in CI but quietly drop coverage for
-   * the feature they were meant to pin, so they rot unseen.
+   * Skipped tests appear green in CI but quietly drop coverage for the feature
+   * they were meant to pin, so they rot unseen.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-disabled-tests.md
    */
@@ -68,21 +64,20 @@ export interface ITtscLintJestRules {
   /**
    * Reject `done` callback parameters in Jest tests and hooks.
    *
-   * The callback style predates async/await and makes error
-   * propagation easy to miss — forgetting `done()` hangs the test
-   * until timeout. Use `async`/`await` or return a Promise instead.
+   * The callback style predates async/await and makes error propagation easy to
+   * miss — forgetting `done()` hangs the test until timeout. Use
+   * `async`/`await` or return a Promise instead.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-done-callback.md
    */
   "jest/no-done-callback"?: TtscLintRuleSetting;
 
   /**
-   * Reject duplicate setup/teardown hook calls
-   * (`beforeEach`/`beforeAll`/etc.) within the same `describe`
-   * block.
+   * Reject duplicate setup/teardown hook calls (`beforeEach`/`beforeAll`/etc.)
+   * within the same `describe` block.
    *
-   * Jest runs both copies in declaration order, which is almost
-   * always a copy-paste mistake.
+   * Jest runs both copies in declaration order, which is almost always a
+   * copy-paste mistake.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-duplicate-hooks.md
    */
@@ -91,21 +86,19 @@ export interface ITtscLintJestRules {
   /**
    * Reject `export` declarations in Jest test files.
    *
-   * Tests are leaf consumers and should not expose helpers; the
-   * runner silently skips test files with any export, so a stray
-   * `export` can make a whole file disappear from the suite.
+   * Tests are leaf consumers and should not expose helpers; the runner silently
+   * skips test files with any export, so a stray `export` can make a whole file
+   * disappear from the suite.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-export.md
    */
   "jest/no-export"?: TtscLintRuleSetting;
 
   /**
-   * Reject `test.only`, `fit`, `fdescribe`, and other focused Jest
-   * tests.
+   * Reject `test.only`, `fit`, `fdescribe`, and other focused Jest tests.
    *
-   * A focused test silently skips every other test in the file, so
-   * a stray `.only` left from debugging hides the rest of the suite
-   * in CI.
+   * A focused test silently skips every other test in the file, so a stray
+   * `.only` left from debugging hides the rest of the suite in CI.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-focused-tests.md
    */
@@ -114,42 +107,39 @@ export interface ITtscLintJestRules {
   /**
    * Reject Jest setup/teardown hooks altogether.
    *
-   * Promotes the style where each test arranges and tears down its
-   * own state inline, so a reader can understand it in isolation
-   * without scrolling to a distant `beforeEach`.
+   * Promotes the style where each test arranges and tears down its own state
+   * inline, so a reader can understand it in isolation without scrolling to a
+   * distant `beforeEach`.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-hooks.md
    */
   "jest/no-hooks"?: TtscLintRuleSetting;
 
   /**
-   * Reject duplicate test or `describe` titles at the same suite
-   * level — the runner cannot distinguish two tests with the same
-   * name in error output.
+   * Reject duplicate test or `describe` titles at the same suite level — the
+   * runner cannot distinguish two tests with the same name in error output.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-identical-title.md
    */
   "jest/no-identical-title"?: TtscLintRuleSetting;
 
   /**
-   * Reject `expect(...)` calls outside the body of a Jest test or
-   * lifecycle hook.
+   * Reject `expect(...)` calls outside the body of a Jest test or lifecycle
+   * hook.
    *
-   * Top-level assertions execute at module load before any test
-   * starts, so failures never attach to a named case in the runner's
-   * report.
+   * Top-level assertions execute at module load before any test starts, so
+   * failures never attach to a named case in the runner's report.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-standalone-expect.md
    */
   "jest/no-standalone-expect"?: TtscLintRuleSetting;
 
   /**
-   * Reject `xit`, `fit`, `xdescribe`, `fdescribe`, and the rest of
-   * the single-letter Jest test prefix aliases.
+   * Reject `xit`, `fit`, `xdescribe`, `fdescribe`, and the rest of the
+   * single-letter Jest test prefix aliases.
    *
-   * They duplicate the `.only`/`.skip` variants but read as typos at
-   * a glance, making accidental focus or disable harder to spot in
-   * review.
+   * They duplicate the `.only`/`.skip` variants but read as typos at a glance,
+   * making accidental focus or disable harder to spot in review.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-test-prefixes.md
    */
@@ -158,28 +148,28 @@ export interface ITtscLintJestRules {
   /**
    * Reject non-Promise `return` statements from Jest test bodies.
    *
-   * Jest only awaits returned thenables, so a plain `return` value
-   * is dropped and following code becomes dead — usually a symptom
-   * of a missing `await` or an accidental early exit.
+   * Jest only awaits returned thenables, so a plain `return` value is dropped
+   * and following code becomes dead — usually a symptom of a missing `await` or
+   * an accidental early exit.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-test-return-statement.md
    */
   "jest/no-test-return-statement"?: TtscLintRuleSetting;
 
   /**
-   * Prefer `expect(value).toHaveLength(n)` over asserting on
-   * `value.length` directly with `toBe`.
+   * Prefer `expect(value).toHaveLength(n)` over asserting on `value.length`
+   * directly with `toBe`.
    *
-   * The dedicated matcher reports the actual length on failure
-   * instead of a bare number mismatch with no context.
+   * The dedicated matcher reports the actual length on failure instead of a
+   * bare number mismatch with no context.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-to-have-length.md
    */
   "jest/prefer-to-have-length"?: TtscLintRuleSetting;
 
   /**
-   * Require a message argument on `expect(...).toThrow(...)` so a
-   * regression with a different error type still surfaces clearly.
+   * Require a message argument on `expect(...).toThrow(...)` so a regression
+   * with a different error type still surfaces clearly.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/require-to-throw-message.md
    */
@@ -188,21 +178,20 @@ export interface ITtscLintJestRules {
   /**
    * Validate the shape of Jest `describe` callbacks.
    *
-   * The callback must be synchronous and take no arguments — Jest
-   * ignores returned Promises and `done`-style parameters at the
-   * describe level, silently swallowing setup errors.
+   * The callback must be synchronous and take no arguments — Jest ignores
+   * returned Promises and `done`-style parameters at the describe level,
+   * silently swallowing setup errors.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/valid-describe-callback.md
    */
   "jest/valid-describe-callback"?: TtscLintRuleSetting;
 
   /**
-   * Validate `expect(...)` arity and matcher chaining: exactly one
-   * argument, terminated by a matcher call, and async matchers
-   * properly awaited.
+   * Validate `expect(...)` arity and matcher chaining: exactly one argument,
+   * terminated by a matcher call, and async matchers properly awaited.
    *
-   * Malformed expects either throw at runtime or pass without
-   * asserting anything.
+   * Malformed expects either throw at runtime or pass without asserting
+   * anything.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/valid-expect.md
    */
@@ -211,8 +200,8 @@ export interface ITtscLintJestRules {
   /**
    * Require non-empty static Jest test and `describe` titles.
    *
-   * Empty or dynamically-built titles produce unreadable failure
-   * output and break filter-by-name flags like `--testNamePattern`.
+   * Empty or dynamically-built titles produce unreadable failure output and
+   * break filter-by-name flags like `--testNamePattern`.
    *
    * @reference https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/valid-title.md
    */

package/src/structures/rules/ITtscLintJsdocRules.ts

@@ -3,30 +3,30 @@ import type { TtscLintRuleSetting } from "../TtscLintRuleSetting";
 /**
  * Documentation-comment validation rules.
  *
- * Bundles `eslint-plugin-jsdoc` content checks (tag names, parameter
- * coverage, descriptions) with the lone `eslint-plugin-tsdoc` syntax
- * check (`jsdoc/tsdoc-syntax`) — both target `/** ... *\/` comments and
- * are too small in upstream-tsdoc's case to justify a dedicated family.
+ * Bundles `eslint-plugin-jsdoc` content checks (tag names, parameter coverage,
+ * descriptions) with the lone `eslint-plugin-tsdoc` syntax check
+ * (`jsdoc/tsdoc-syntax`) — both target `/** ... *\/` comments and are too small
+ * in upstream-tsdoc's case to justify a dedicated family.
  *
- * Formatting concerns (alignment, indentation) are configured through
- * the top-level `format` block, not here.
+ * Formatting concerns (alignment, indentation) are configured through the
+ * top-level `format` block, not here.
  *
  * @reference https://github.com/gajus/eslint-plugin-jsdoc
  */
 export interface ITtscLintJsdocRules {
   /**
-   * Reject unknown JSDoc block-tag names. Catches typos like
-   * `@returs` or `@parm`.
+   * Reject unknown JSDoc block-tag names. Catches typos like `@returs` or
+   * `@parm`.
    *
    * @reference https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-tag-names.md
    */
   "jsdoc/check-tag-names"?: TtscLintRuleSetting;
 
   /**
-   * Validate `@access` values against the closed set `public`,
-   * `protected`, `private`, `package`. (Upstream extends to
-   * `@version`/`@since`/`@license`/`@kind`/`@import` value checks;
-   * those shapes are not yet implemented in the native engine.)
+   * Validate `@access` values against the closed set `public`, `protected`,
+   * `private`, `package`. (Upstream extends to
+   * `@version`/`@since`/`@license`/`@kind`/`@import` value checks; those shapes
+   * are not yet implemented in the native engine.)
    *
    * Catches typos and stale enum members that slip past doc tooling.
    *
@@ -35,24 +35,24 @@ export interface ITtscLintJsdocRules {
   "jsdoc/check-values"?: TtscLintRuleSetting;
 
   /**
-   * Reject content on marker-only JSDoc tags (`@async`, `@public`,
-   * `@override`, ...) — these tags take no value.
+   * Reject content on marker-only JSDoc tags (`@async`, `@public`, `@override`,
+   * ...) — these tags take no value.
    *
    * @reference https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/empty-tags.md
    */
   "jsdoc/empty-tags"?: TtscLintRuleSetting;
 
   /**
-   * Reject JSDoc type braces in TypeScript sources, since the
-   * surrounding TypeScript already carries the type.
+   * Reject JSDoc type braces in TypeScript sources, since the surrounding
+   * TypeScript already carries the type.
    *
    * @reference https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-types.md
    */
   "jsdoc/no-types"?: TtscLintRuleSetting;
 
   /**
-   * Reject `any` and `*` inside JSDoc type braces — these escape
-   * the documented type system the same way TypeScript `any` does.
+   * Reject `any` and `*` inside JSDoc type braces — these escape the documented
+   * type system the same way TypeScript `any` does.
    *
    * @reference https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/reject-any-type.md
    */
@@ -69,83 +69,76 @@ export interface ITtscLintJsdocRules {
   "jsdoc/reject-function-type"?: TtscLintRuleSetting;
 
   /**
-   * Require JSDoc blocks to include a leading block-level
-   * description — every documented identifier should explain itself.
+   * Require JSDoc blocks to include a leading block-level description — every
+   * documented identifier should explain itself.
    *
    * @reference https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description.md
    */
   "jsdoc/require-description"?: TtscLintRuleSetting;
 
   /**
-   * Require every `@param` tag that names a parameter to also
-   * carry a description after the name.
+   * Require every `@param` tag that names a parameter to also carry a
+   * description after the name.
    *
-   * A name-only `@param` adds nothing beyond the signature, so the
-   * rule pushes authors to either describe the parameter or drop
-   * the tag.
+   * A name-only `@param` adds nothing beyond the signature, so the rule pushes
+   * authors to either describe the parameter or drop the tag.
    *
    * @reference https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-description.md
    */
   "jsdoc/require-param-description"?: TtscLintRuleSetting;
 
   /**
-   * Require every `@param` tag to include the parameter name it
-   * documents.
+   * Require every `@param` tag to include the parameter name it documents.
    *
-   * A bare `@param` cannot be linked to a signature position, so
-   * doc tooling silently drops it.
+   * A bare `@param` cannot be linked to a signature position, so doc tooling
+   * silently drops it.
    *
    * @reference https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-name.md
    */
   "jsdoc/require-param-name"?: TtscLintRuleSetting;
 
   /**
-   * Require every `@property` tag that names a property to also
-   * carry a description.
+   * Require every `@property` tag that names a property to also carry a
+   * description.
    *
-   * Mirrors `require-param-description` for typedef and object-shape
-   * comments, where a name-only entry adds nothing the surrounding
-   * type doesn't convey.
+   * Mirrors `require-param-description` for typedef and object-shape comments,
+   * where a name-only entry adds nothing the surrounding type doesn't convey.
    *
    * @reference https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-description.md
    */
   "jsdoc/require-property-description"?: TtscLintRuleSetting;
 
   /**
-   * Require every `@property` tag to include the property name it
-   * documents.
+   * Require every `@property` tag to include the property name it documents.
    *
-   * Without the name the tag cannot be linked to a member of the
-   * surrounding typedef, and doc generators discard it.
+   * Without the name the tag cannot be linked to a member of the surrounding
+   * typedef, and doc generators discard it.
    *
    * @reference https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-name.md
    */
   "jsdoc/require-property-name"?: TtscLintRuleSetting;
 
   /**
-   * Require every `@returns` tag to carry a description of the
-   * returned value.
+   * Require every `@returns` tag to carry a description of the returned value.
    *
-   * The TypeScript signature already states the return type, so the
-   * tag earns its keep only when it explains what the value means,
-   * not its shape.
+   * The TypeScript signature already states the return type, so the tag earns
+   * its keep only when it explains what the value means, not its shape.
    *
    * @reference https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-description.md
    */
   "jsdoc/require-returns-description"?: TtscLintRuleSetting;
 
   /**
-   * Detect structural TSDoc problems in documentation comments:
-   * malformed top-level block tags (`@` followed by non-letter) and
-   * malformed or unclosed inline tags (`{@link ...}`). The broader
-   * TSDoc grammar — closed-set tag names, escape sequences,
-   * `{Type}`-annotation rejection, fenced-code rules — is not yet
-   * implemented.
-   *
-   * TSDoc is Microsoft's curated dialect that powers API Extractor and
-   * the rest of the Microsoft TypeScript documentation pipeline.
-   * Upstream `eslint-plugin-tsdoc` ships exactly one rule; it lives
-   * here rather than in a one-rule `tsdoc/*` family.
+   * Detect structural TSDoc problems in documentation comments: malformed
+   * top-level block tags (`@` followed by non-letter) and malformed or unclosed
+   * inline tags (`{@link ...}`). The broader TSDoc grammar — closed-set tag
+   * names, escape sequences, `{Type}`-annotation rejection, fenced-code rules —
+   * is not yet implemented.
+   *
+   * TSDoc is Microsoft's curated dialect that powers API Extractor and the rest
+   * of the Microsoft TypeScript documentation pipeline. Upstream
+   * `eslint-plugin-tsdoc` ships exactly one rule; it lives here rather than in
+   * a one-rule `tsdoc/*` family.
    *
    * @reference https://github.com/microsoft/tsdoc/blob/main/eslint-plugin/README.md
    */