@pobammer-ts/eslint-cease-nonsense-rules 1.10.0 → 1.12.0

package/README.md

@@ -57,6 +57,7 @@ export default [
 			"cease-nonsense/prefer-early-return": "error",
 			"cease-nonsense/prefer-module-scope-constants": "error",
 			"cease-nonsense/prefer-pascal-case-enums": "error",
+			"cease-nonsense/prefer-pattern-replacements": "error",
 			"cease-nonsense/prefer-sequence-overloads": "error",
 			"cease-nonsense/prefer-singular-enums": "error",
 			"cease-nonsense/prefer-udim2-shorthand": "error",
@@ -64,6 +65,7 @@ export default [
 			"cease-nonsense/require-named-effect-functions": "error",
 			"cease-nonsense/require-paired-calls": "error",
 			"cease-nonsense/require-react-component-keys": "error",
+			"cease-nonsense/require-react-display-names": "error",
 			"cease-nonsense/strict-component-boundaries": "error",
 			"cease-nonsense/use-exhaustive-dependencies": "error",
 			"cease-nonsense/use-hook-at-top-level": "error",
@@ -427,6 +429,63 @@ function UserProfile({ userId }) {
 }
 ```
 
+#### `require-react-display-names`
+
+Require `displayName` property on exported `React.memo` components and `React.createContext` contexts for better debugging.
+
+**Configuration**
+
+```typescript
+{
+  "cease-nonsense/require-react-display-names": ["error", {
+    "environment": "roblox-ts"  // or "standard" for regular React
+  }]
+}
+```
+
+**❌ Bad**
+
+```typescript
+import { memo } from "@rbxts/react";
+
+function CoolFrameNoMemo() {
+	return <frame />;
+}
+
+// Direct export without displayName
+export default memo(CoolFrameNoMemo);
+```
+
+```typescript
+import React from "@rbxts/react";
+
+// Missing displayName
+const ErrorBoundaryContext = React.createContext<unknown>(undefined);
+export default ErrorBoundaryContext;
+```
+
+**✅ Good**
+
+```typescript
+import { memo } from "@rbxts/react";
+
+function CoolFrameNoMemo() {
+	return <frame />;
+}
+
+export const CoolFrame = memo(CoolFrameNoMemo);
+CoolFrame.displayName = "CoolFrame";
+export default CoolFrame;
+```
+
+```typescript
+import React from "@rbxts/react";
+
+const ErrorBoundaryContext = React.createContext<unknown>(undefined);
+ErrorBoundaryContext.displayName = "ErrorBoundaryContext";
+export default ErrorBoundaryContext;
+```
+
 #### `react-hooks-strict-return`
 
 React hooks must return a tuple of ≤2 elements or a single object. Prevents unwieldy hook return types.
@@ -923,6 +982,96 @@ const deltaTime = 0.016;
 const model = entity.char; // Property access is allowed
 ```
 
+#### `prefer-pattern-replacements`
+
+Enforces replacement of verbose constructor/method patterns with simpler alternatives.
+
+**Features**
+
+- ✨ Has auto-fix
+- Type-safe `pattern()` API with compile-time capture validation
+- Supports captures (`$x`), optional args (`0?`), wildcards (`_`)
+- Constant expression evaluation (`1 - 1` matches `0`)
+- Same-variable matching (`$x, $x` requires identical arguments)
+- Scope-aware: skips fix if replacement would shadow local variable
+
+**Configuration**
+
+```typescript
+import { pattern } from "@pobammer-ts/eslint-cease-nonsense-rules";
+
+{
+  "cease-nonsense/prefer-pattern-replacements": ["error", {
+    "patterns": [
+      // Simple patterns
+      pattern({
+        match: "UDim2.fromScale(1, 1)",
+        replacement: "oneScale"
+      }),
+
+      // Captures and conditions
+      pattern({
+        match: "new Vector2($x, $x)",
+        replacement: "fromUniform($x)",
+        when: { x: "!= 0" }
+      }),
+
+      // Optional args (0? matches 0 or missing)
+      pattern({
+        match: "new Vector2($x, 0?)",
+        replacement: "fromX($x)"
+      }),
+
+      // Wildcards (match any value, don't capture)
+      pattern({
+        match: "new UDim2(_, 0, _, 0)",
+        replacement: "UDim2.fromScale"
+      })
+    ]
+  }]
+}
+```
+
+**Pattern syntax**
+
+- `$name` - Capture variable, stores value for replacement
+- `0?` - Optional: matches literal `0` or missing argument
+- `_` - Wildcard: matches any value, not captured
+- `when` clause - Conditions on captures (`== 0`, `!= 0`, `> 5`, etc.)
+
+**Replacement types**
+
+- Identifier: `oneScale`
+- Static access: `Vector2.one`
+- Call: `fromUniform($x)` or `Vector2.fromUniform($x, $y)`
+
+**❌ Bad**
+
+```typescript
+const scale = UDim2.fromScale(1, 1);
+const vec = new Vector2(5, 5);
+const offset = new Vector2(10, 0);
+```
+
+**✅ Good**
+
+```typescript
+const scale = oneScale;
+const vec = fromUniform(5);
+const offset = fromX(10);
+```
+
+**Scope awareness**
+
+The rule automatically skips fixes when the replacement would conflict with a local variable:
+
+```typescript
+function example() {
+  const oneScale = 5; // Local variable shadows replacement
+  const scale = UDim2.fromScale(1, 1); // No fix applied (would shadow)
+}
+```
+
 #### `prefer-class-properties`
 
 Prefer class properties over assignment of literals in constructors.

package/dist/build-metadata.json

@@ -1,5 +1,5 @@
 {
-  "commit": "8104213e0676ebea2ce52403f0e6559fb13d576e",
-  "time": "2025-12-23T03:11:07.286Z",
-  "version": "1.10.0"
+  "commit": "0c941c22d06cca23db96491078c85d1b80fb0191",
+  "time": "2026-01-01T05:26:31.863Z",
+  "version": "1.12.0"
 }

package/dist/index.d.ts

@@ -1,6 +1,5 @@
-import type { TSESLint } from "@typescript-eslint/utils";
-import type { Rule } from "eslint";
-type AnyRuleModule = Rule.RuleModule | TSESLint.AnyRuleModuleWithMetaDocs;
+import type { LooseRuleDefinition } from "@typescript-eslint/utils/ts-eslint";
+import type { ReadonlyRecord } from "./types/utility-types.d";
 export type { BanInstancesOptions } from "./rules/ban-instances";
 export type { ComplexityConfiguration } from "./rules/enforce-ianitor-check-type";
 export type { NoGodComponentsOptions } from "./rules/no-god-components";
@@ -11,8 +10,11 @@ export type { NoUselessUseSpringOptions } from "./rules/no-useless-use-spring";
 export type { EffectFunctionOptions, EnvironmentMode, HookConfiguration } from "./rules/require-named-effect-functions";
 export type { PairConfiguration, RequirePairedCallsOptions } from "./rules/require-paired-calls";
 export type { ReactKeysOptions } from "./rules/require-react-component-keys";
+export type { RequireReactDisplayNamesOptions } from "./rules/require-react-display-names";
 export type { HookEntry, UseExhaustiveDependenciesOptions } from "./rules/use-exhaustive-dependencies";
-export { createBanInstancesOptions, createComplexityConfiguration, createEffectFunctionOptions, createHookConfiguration, createNoGodComponentsOptions, createNoInstanceMethodsOptions, createNoShorthandOptions, createNoUselessUseSpringOptions, createPairConfiguration, createReactKeysOptions, createRequirePairedCallsOptions, createUseExhaustiveDependenciesOptions, createUseHookAtTopLevelOptions, defaultRobloxProfilePair, } from "./utilities/configure-utilities";
+export { createBanInstancesOptions, createComplexityConfiguration, createEffectFunctionOptions, createHookConfiguration, createNoGodComponentsOptions, createNoInstanceMethodsOptions, createNoShorthandOptions, createNoUselessUseSpringOptions, createPairConfiguration, createPreferPatternReplacementsOptions, createReactKeysOptions, createRequirePairedCallsOptions, createRequireReactDisplayNamesOptions, createUseExhaustiveDependenciesOptions, createUseHookAtTopLevelOptions, defaultRobloxProfilePair, } from "./utilities/configure-utilities";
+export type { Pattern, PreferPatternReplacementsOptions } from "./utilities/pattern-replacement";
+export { pattern } from "./utilities/pattern-replacement";
 /**
  * Recommended configuration for ESLint flat config.
  *
@@ -32,7 +34,7 @@ export { createBanInstancesOptions, createComplexityConfiguration, createEffectF
 declare const recommended: {
     readonly plugins: {
         readonly "cease-nonsense": {
-            readonly rules: Readonly<Record<string, AnyRuleModule>>;
+            readonly rules: Readonly<Record<string, LooseRuleDefinition>>;
         };
     };
     readonly rules: {
@@ -51,13 +53,14 @@ declare const recommended: {
         readonly "cease-nonsense/prefer-udim2-shorthand": "error";
         readonly "cease-nonsense/require-named-effect-functions": "error";
         readonly "cease-nonsense/require-react-component-keys": "error";
+        readonly "cease-nonsense/require-react-display-names": "error";
         readonly "cease-nonsense/use-exhaustive-dependencies": "error";
         readonly "cease-nonsense/use-hook-at-top-level": "error";
     };
 };
 type PluginConfig = typeof recommended;
 interface Plugin {
-    readonly rules: Readonly<Record<string, AnyRuleModule>>;
+    readonly rules: ReadonlyRecord<string, LooseRuleDefinition>;
     readonly configs: {
         readonly recommended: PluginConfig;
     };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AA8BnC,KAAK,aAAa,GAAG,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,yBAAyB,CAAC;AAE1E,YAAY,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,YAAY,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAClF,YAAY,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACxE,YAAY,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AACpE,YAAY,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AACzF,YAAY,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AACrE,YAAY,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC/E,YAAY,EAAE,qBAAqB,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AACxH,YAAY,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACjG,YAAY,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AAC7E,YAAY,EAAE,SAAS,EAAE,gCAAgC,EAAE,MAAM,qCAAqC,CAAC;AACvG,OAAO,EACN,yBAAyB,EACzB,6BAA6B,EAC7B,2BAA2B,EAC3B,uBAAuB,EACvB,4BAA4B,EAC5B,8BAA8B,EAC9B,wBAAwB,EACxB,+BAA+B,EAC/B,uBAAuB,EACvB,sBAAsB,EACtB,+BAA+B,EAC/B,sCAAsC,EACtC,8BAA8B,EAC9B,wBAAwB,GACxB,MAAM,iCAAiC,CAAC;AAsCzC;;;;;;;;;;;;;;;GAeG;AACH,QAAA,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;CAuBP,CAAC;AAEX,KAAK,YAAY,GAAG,OAAO,WAAW,CAAC;AAEvC,UAAU,MAAM;IACf,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;IACxD,QAAQ,CAAC,OAAO,EAAE;QAAE,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAA;KAAE,CAAC;CACzD;AAED,QAAA,MAAM,MAAM,EAAE,MAGJ,CAAC;AAEX,eAAe,MAAM,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AA+B9E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D,YAAY,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,YAAY,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAClF,YAAY,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACxE,YAAY,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AACpE,YAAY,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AACzF,YAAY,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AACrE,YAAY,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC/E,YAAY,EAAE,qBAAqB,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AACxH,YAAY,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACjG,YAAY,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AAC7E,YAAY,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AAC3F,YAAY,EAAE,SAAS,EAAE,gCAAgC,EAAE,MAAM,qCAAqC,CAAC;AACvG,OAAO,EACN,yBAAyB,EACzB,6BAA6B,EAC7B,2BAA2B,EAC3B,uBAAuB,EACvB,4BAA4B,EAC5B,8BAA8B,EAC9B,wBAAwB,EACxB,+BAA+B,EAC/B,uBAAuB,EACvB,sCAAsC,EACtC,sBAAsB,EACtB,+BAA+B,EAC/B,qCAAqC,EACrC,sCAAsC,EACtC,8BAA8B,EAC9B,wBAAwB,GACxB,MAAM,iCAAiC,CAAC;AACzC,YAAY,EAAE,OAAO,EAAE,gCAAgC,EAAE,MAAM,iCAAiC,CAAC;AACjG,OAAO,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAwC1D;;;;;;;;;;;;;;;GAeG;AACH,QAAA,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;CAwBP,CAAC;AAEX,KAAK,YAAY,GAAG,OAAO,WAAW,CAAC;AAEvC,UAAU,MAAM;IACf,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAC5D,QAAQ,CAAC,OAAO,EAAE;QAAE,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAA;KAAE,CAAC;CACzD;AAED,QAAA,MAAM,MAAM,EAAE,MAGJ,CAAC;AAEX,eAAe,MAAM,CAAC"}