TypeScript type linting with typescript-eslint plugin

[brettz9]

Motivation

Current behavior

Should take a look at https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin to see if its rules can be adapted for use with JSDoc, and if not, consider a multiple processors approach.

Desired behavior

Be able to lint TypeScript types within TypeScript-style JSDoc, e.g., to use consistent styling of semicolons or commas as separators, etc.

Rules ripe for adaption:

• adjacent-overload-signatures.mdx
• array-type.mdx (good but already possible in other ways)
• consistent-indexed-object-style.mdx
• explicit-function-return-type.mdx (could use for function()
• member-ordering.mdx
• method-signature-style.mdx
• no-deprecated.mdx
• no-duplicate-type-constituents.mdx
• no-empty-object-type.mdx
• no-invalid-void-type.mdx
• no-misused-new.mdx
• no-redundant-type-constituents.mdx
• no-restricted-types (other ways to do)
• no-unnecessary-template-expression.mdx
• prefer-destructuring.mdx (avoid need if a @type annotation precedes the structure)
• prefer-function-type.mdx

Also:

• https://eslint.style/rules/no-extra-parens (for types)
• https://eslint.style/rules/type-annotation-spacing
• https://eslint.style/rules/type-generic-spacing
• https://eslint.style/rules/type-named-tuple-spacing
• A new rule for no-incompatible-jsdoc to forbid the likes of module: and external: namepaths which are not understood by TS even if not rejected by it.
• perfectionist/sort-intersection-types
• perfectionist/sort-union-types

Less likely but possible:

• naming-convention.mdx (could be applied to typedefs)
• no-restricted-imports
• no-unnecessary-type-constraint.mdx
• no-unnecessary-type-parameters.mdx
• no-unsafe-return.mdx (and the other no-unsafe rules related to any types; we currently have a rule which is less granular that forbids any anywhere)
• prefer-as-const.mdx
• prefer-readonly-parameter-types.mdx
• typedef
• unified-signatures.mdx

Alternatives considered

Using typescript-eslint plugin if supported.

---

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.