Skip to main content

Type Alias: JsoncRuleDocs

JsoncRuleDocs = { description: string; recommended: boolean; requiresTypeChecking: false; ruleId?: string; ruleNumber?: number; tsconfigConfigs: readonly TsconfigConfigName[] | TsconfigConfigName; url?: string; }

Defined in: _internal/jsonc-rule.ts:42

Typed meta.docs block required on every JSONC rule in this plugin.

Propertiesโ€‹

descriptionโ€‹

description: string

Defined in: _internal/jsonc-rule.ts:50

Short, imperative description of what the rule checks.

Remarksโ€‹

Must be unique across all rules in the plugin and written in imperative mood (e.g. "Require strict: true in compilerOptions").

recommended: boolean

Defined in: _internal/jsonc-rule.ts:55

Whether the rule is included in the recommended preset.

requiresTypeCheckingโ€‹

requiresTypeChecking: false

Defined in: _internal/jsonc-rule.ts:61

Always false for JSONC rules โ€” they do not use the TypeScript type checker.

ruleId?โ€‹

optional ruleId?: string

Defined in: _internal/jsonc-rule.ts:67

Catalog rule identifier in the R### format (injected automatically when the rule is present in the rule catalog).

ruleNumber?โ€‹

optional ruleNumber?: number

Defined in: _internal/jsonc-rule.ts:73

Catalog ordinal for this rule (injected automatically when present in the rule catalog).

tsconfigConfigsโ€‹

tsconfigConfigs: readonly TsconfigConfigName[] | TsconfigConfigName

Defined in: _internal/jsonc-rule.ts:83

One or more tsconfig preset names this rule belongs to.

Remarksโ€‹

Every rule must declare at least one preset. Use the all preset for rules that should appear in every preset, plus the specific category preset for categorized membership.

url?โ€‹

optional url?: string

Defined in: _internal/jsonc-rule.ts:92

Canonical docs page URL (injected automatically by createJsoncRule).

Remarksโ€‹

Do not set this manually; it will be overwritten with the canonical value derived from meta.name.