Require Module Level Instantiation

ErrorRoblox

small-rules/require-module-level-instantiation

Require configured classes to be instantiated at module level only.

Diagnostic Messages

mustBeModuleLevel

'{{className}}' from '{{importSource}}' must be instantiated at module level only.

Configuration

This rule accepts one options object after the severity.

classesOptional

Class names mapped to the import source that must be instantiated at module scope.

Type

Record<string, string>

Default

-

{
  "jsPlugins": [
    "@pobammer-ts/small-rules"
  ],
  "rules": {
    "small-rules/require-module-level-instantiation": [
      "error",
      {
        "classes": {
          "Log": "@rbxts/rbxts-sleitnick-log"
        }
      }
    ]
  }
}

Examples

nested logger instantiation

import Log from "@rbxts/rbxts-sleitnick-log";

function useStoryModesState() {
    const log = new Log();
    log.Info("test");
}

module-level logger instantiation

import Log from "@rbxts/rbxts-sleitnick-log";

const log = new Log();

function useStoryModesState() {
    log.Info("test");
}

Related Rules

No Ianitor In Function BodyRelatedBoth require expensive configured constructions to live at module scope.