# nick2bad4u/eslint-plugin-tsdoc-require-2 architecture

> Architecture diagram of the GitHub repository nick2bad4u/eslint-plugin-tsdoc-require-2, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nick2bad4u/eslint-plugin-tsdoc-require-2
- Repository: https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2

## Overview

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: [`src/plugin.ts`](https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/plugin.ts) (Plugin Export), [`src/rules/require.ts`](https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/rules/require.ts) (Comment Requirement), [`src/rules/restrict-tags.ts`](https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/rules/restrict-tags.ts) (Tag Restrictions), [`src/rules/required-tags`](https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/tree/main/src/rules/required-tags) (Required-Tag Rules)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Plugin API"]
  node_plugin["Plugin Export<br/>[plugin.ts]"]
  node_presets["Rule Presets<br/>[plugin.ts]"]
end

subgraph group_rules["Lint Rules"]
  node_registry["Required-Tag Registry"]
  node_require["Comment Requirement<br/>[require.ts]"]
  node_restrict["Tag Restrictions<br/>[restrict-tags.ts]"]
  node_tagrules["Required-Tag Rules"]
end

subgraph group_core["Rule Infrastructure"]
  node_tagfactory["Tag Rule Factory"]
  node_rulecreator["Rule Creator<br/>[create-rule.ts]"]
end

node_user(("Plugin User"))
node_eslint(("ESLint"))

node_user -->|"configures"| node_plugin
node_eslint -->|"loads"| node_plugin
node_plugin -->|"registers"| node_registry
node_plugin -->|"registers"| node_require
node_plugin -->|"registers"| node_restrict
node_plugin -->|"exposes"| node_presets
node_eslint -.->|"runs"| node_require
node_eslint -.->|"runs"| node_restrict
node_eslint -.->|"runs"| node_tagrules
node_registry -->|"maps rules"| node_tagrules
node_tagrules -->|"delegates"| node_tagfactory
node_tagfactory -->|"uses"| node_rulecreator
node_require -->|"uses"| node_rulecreator
node_restrict -->|"uses"| node_rulecreator

click node_plugin "https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/plugin.ts"
click node_presets "https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/plugin.ts"
click node_registry "https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/rules/require-tag-rules.ts"
click node_require "https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/rules/require.ts"
click node_restrict "https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/rules/restrict-tags.ts"
click node_tagrules "https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/tree/main/src/rules/required-tags"
click node_tagfactory "https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/internal/require-tag-factory.ts"
click node_rulecreator "https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/internal/create-rule.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_plugin,node_presets,node_user toneBlue
class node_registry,node_require,node_restrict,node_tagrules toneAmber
class node_tagfactory,node_rulecreator toneMint
class node_eslint toneIndigo
```

## Components

### Plugin API

- [Plugin Export](https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/plugin.ts): `src/plugin.ts`
- [Rule Presets](https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/plugin.ts): `src/plugin.ts`

### Lint Rules

- [Required-Tag Registry](https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/rules/require-tag-rules.ts): `src/rules/require-tag-rules.ts`
- [Comment Requirement](https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/rules/require.ts): `src/rules/require.ts`
- [Tag Restrictions](https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/rules/restrict-tags.ts): `src/rules/restrict-tags.ts`
- [Required-Tag Rules](https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/tree/main/src/rules/required-tags): `src/rules/required-tags`

### Rule Infrastructure

- [Tag Rule Factory](https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/internal/require-tag-factory.ts): `src/internal/require-tag-factory.ts`
- [Rule Creator](https://github.com/nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/src/internal/create-rule.ts): `src/internal/create-rule.ts`

### Other components

- **Plugin User**
- **ESLint**

## Connections

- Plugin User → Plugin Export: configures
- ESLint → Plugin Export: loads
- Plugin Export → Required-Tag Registry: registers (evidence: `src/plugin.ts`)
- Plugin Export → Comment Requirement: registers (evidence: `src/plugin.ts`)
- Plugin Export → Tag Restrictions: registers (evidence: `src/plugin.ts`)
- Plugin Export → Rule Presets: exposes (evidence: `src/plugin.ts`)
- ESLint → Comment Requirement: runs
- ESLint → Tag Restrictions: runs
- ESLint → Required-Tag Rules: runs
- Required-Tag Registry → Required-Tag Rules: maps rules (evidence: `src/rules/require-tag-rules.ts`)
- Required-Tag Rules → Tag Rule Factory: delegates (evidence: `src/rules/required-tags/require-author.ts`)
- Tag Rule Factory → Rule Creator: uses (evidence: `src/internal/require-tag-factory.ts`)
- Comment Requirement → Rule Creator: uses (evidence: `src/rules/require.ts`)
- Tag Restrictions → Rule Creator: uses (evidence: `src/rules/restrict-tags.ts`)
