Add a "no-undefined-types" rule #423

kraenhansen · 2024-08-30T13:09:42Z

This fixes #348 and #349 by adding a new "no-undefined-types" rule to the eslint-plugin-tsdoc package.

NOTE: This is currently in draft as I want a bit of feedback before sinking more time into this.

I see two issues with the implementation as is:

Incorrect scoping

Comment are read using sourceCode.getAllComments(), which means the node to which the comment related gets lost and this entails that any identifiers used in {@link } tags gets resolved relative to the global scope (and its decedents). I am contemplating adding more granular "visitors" to to the RuleListener returned from the rule's create method, but that would probably elevate the complexity quite a bit.

Determining if a type is defined, means running the TypeScript type-checker

Take this example

`foo.ts`

class MyClass {
    foo() {}
}

`bar.ts`

/**
 * A {@link MyClass.foo} referencing a member of a class which can't be read out of the AST of the file itself.
 */
const bar = "whatever";

The easiest way would probably be to take an optional peer dependency on @typescript-eslint/utils and implement a typed rule.

Implemented a "no-undefined-types" rule

e395070

This was referenced Aug 30, 2024

eslint-plugin-tsdoc: Rule to mark types referenced through {@link} and {@inheritDoc} as used #348

Open

Refactored eslint-plugin-tsdoc to use typescript-eslint #425

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a "no-undefined-types" rule #423

Add a "no-undefined-types" rule #423

kraenhansen commented Aug 30, 2024 •

edited

Loading

Add a "no-undefined-types" rule #423

Are you sure you want to change the base?

Add a "no-undefined-types" rule #423

Conversation

kraenhansen commented Aug 30, 2024 • edited Loading

Incorrect scoping

Determining if a type is defined, means running the TypeScript type-checker

foo.ts

bar.ts

kraenhansen commented Aug 30, 2024 •

edited

Loading

`foo.ts`

`bar.ts`