Prefer Modding.inspect

SuggestionAuto-fixableRoblox

small-rules/prefer-modding-inspect

Prefer Modding.inspect over manually enumerating every enum member in a Record<Enum, true>.

Rationale

Writing Record<SomeEnum, true> by hand means listing every enum member as Member: true. Pointless busywork, and you have to touch it every time the enum changes.

Modding.inspect<Record<SomeEnum, true>>() generates that map from the enum automatically whenever a new item is added — so there’s just less to maintain. This catches the hand-written literal form and auto-fixes it.

Diagnostic Messages

preferModdingInspect

Replace manual {{enumType}} enumeration with Modding.inspect<Record<{{enumType}}, true>>().

Configuration

This rule does not accept options.

{
  "jsPlugins": [
    "@pobammer-ts/small-rules"
  ],
  "rules": {
    "small-rules/prefer-modding-inspect": "error"
  }
}

Examples

boolean record literal

const x: ReadonlyRecord<MyEnum, true> = { a: true, b: true };

After auto-fix

const x = Modding.inspect<Record<MyEnum, true>>();

plain object without record type

const x = { a: true, b: true };