How nick2bad4u/eslint-plugin-tsdoc-require-2 works
This is an ESLint plugin that checks TSDoc/JSDoc comments on TypeScript declarations. The user configures the plugin and selects rules or presets; ESLint loads it and runs rules against source files, reporting missing required comments or tags and restricted tags. The main rule handles comment presence, a shared factory powers individual required-tag rules, and the plugin module assembles rules and presets. Relationships are limited to those shown in the README or source index/excerpts; individual tag-rule implementations are grouped because most were not sampled.
Main entry points: plugin.ts Plugin Export · require.ts Comment Requirement · restrict-tags.ts Tag Restrictions · required-tags Required-Tag Rules
Components 10
Plugin API
- Plugin Export
src/plugin.ts - Rule Presets
src/plugin.ts
Lint Rules
- Required-Tag Registry
src/rules/require-tag-rules.ts - Comment Requirement
src/rules/require.ts - Tag Restrictions
src/rules/restrict-tags.ts - Required-Tag Rules
src/rules/required-tags
Rule Infrastructure
- Tag Rule Factory
src/internal/require-tag-factory.ts - Rule Creator
src/internal/create-rule.ts
Other components
- Plugin User
- ESLint
Connections 14
- Plugin User → Plugin Export: configures
- ESLint → Plugin Export: loads
- Plugin Export → Required-Tag Registry: registers
src/plugin.ts - Plugin Export → Comment Requirement: registers
src/plugin.ts - Plugin Export → Tag Restrictions: registers
src/plugin.ts - Plugin Export → Rule Presets: exposes
src/plugin.ts - ESLint → Comment Requirement: runs
- ESLint → Tag Restrictions: runs
- ESLint → Required-Tag Rules: runs
- Required-Tag Registry → Required-Tag Rules: maps rules
src/rules/require-tag-rules.ts - Required-Tag Rules → Tag Rule Factory: delegates
src/rules/required-tags/require-author.ts - Tag Rule Factory → Rule Creator: uses
src/internal/require-tag-factory.ts - Comment Requirement → Rule Creator: uses
src/rules/require.ts - Tag Restrictions → Rule Creator: uses
src/rules/restrict-tags.ts