Skip to main content

Interface: JsoncRuleDocs

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

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

Propertiesโ€‹

descriptionโ€‹

description: string;

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

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:58

Whether the rule is included in the recommended preset.

requiresTypeCheckingโ€‹

requiresTypeChecking: false;

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

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

ruleId?โ€‹

optional ruleId?: string;

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

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:76

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

tsconfigConfigsโ€‹

tsconfigConfigs:
  | "all"
  | "emit-config"
  | "include-hygiene"
  | "jsconfig"
  | "lib-target"
  | "module-resolution"
  | "project-references"
  | "recommended"
  | "strict"
  | "strict-mode"
  | "strictest"
  | readonly (
  | "all"
  | "emit-config"
  | "include-hygiene"
  | "jsconfig"
  | "lib-target"
  | "module-resolution"
  | "project-references"
  | "recommended"
  | "strict"
  | "strict-mode"
  | "strictest")[];

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

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:95

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.