如何为 TS 类型声明禁用 eslint `require-jsdoc`，或者至少为单个 props

Question

我们喜欢 eslint 规则

require-jsdoc

...大多数时候。但是，每当我们导出 TS 类型（或接口）时，如果我们不仅在类型本身上没有 jsdoc 块，而且在每个及其属性上都没有 jsdoc 块，我们就会收到警告。

我们相信 TypeScript 类型声明是——或者至少应该是——90% 是自记录的。类型本身为使用它们的逻辑提供了大量文档。我们确实记录了某些不明确的类型或属性，但我们认为他们大多不需要它。

所以，例如：

export type I18nProviderProps = {
  locale?: string
  children: React.ReactNode
}

在该示例中，eslint 抛出警告，不仅需要针对类型

I18nProviderProps

，还针对

locale?

和

children

行使用单独的 jsdoc 块。

我们认为这太过分了。但是，我们无法弄清楚如何在这两种情况下关闭它。至少，如果类型上的每个道具都没有警告，我会很高兴。但理想情况下，我也可以在整个类型声明中将其关闭。有什么建议吗？

我已经阅读了插件文档中的 AST 和 Selectors，以及它所引用的 eslint 的 Selectors 文档。要么没有足够具体的选择器来引用这种特殊情况，要么我不够聪明，看不到它是如何工作的。因此，任何帮助将不胜感激。

Answer 1

从上下文中删除

TSPropertySignature

。 文档示例