@pobammer-ts/eslint-cease-nonsense-rules 1.9.2 → 1.11.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",
@@ -838,13 +839,19 @@ const doubled = items.map((x) => x * 2);
 
 Bans shorthand variable names in favor of descriptive full names.
 
+**Features**
+
+- Matches shorthands within compound identifiers (e.g., `plrData` → `playerData`)
+- Supports glob patterns (`*`, `?`) for flexible matching
+- Supports regex patterns (`/pattern/flags`) for advanced matching
+- Automatically ignores import specifiers (external packages control their naming)
+
 **Default mappings**
 
 - `plr` → `player` (or `localPlayer` for `Players.LocalPlayer`)
 - `args` → `parameters`
 - `dt` → `deltaTime`
 - `char` → `character`
-- `btn` → `button`
 
 **Configuration**
 
@@ -853,16 +860,52 @@ Bans shorthand variable names in favor of descriptive full names.
   "cease-nonsense/no-shorthand-names": ["error", {
     "shorthands": {
       "plr": "player",
-      "args": "parameters",
-      "dt": "deltaTime",
-      "char": "character",
-      "btn": "button"
+      "*Props": "*Properties"
     },
-    "allowPropertyAccess": ["char"]  // Allow as property
+    "allowPropertyAccess": ["char", "Props"],  // Allow as property/qualified name
+    "ignoreShorthands": ["PropsWithoutRef"]    // Ignore completely
   }]
 }
 ```
 
+**Options**
+
+- `shorthands`: Map of shorthand patterns to replacements (exact, glob `*`/`?`, or regex `/pattern/flags`)
+- `allowPropertyAccess`: Words allowed in property access (`obj.prop`) or type qualified names (`React.Props`)
+- `ignoreShorthands`: Words to ignore completely, regardless of context (supports same pattern syntax)
+
+**Pattern syntax**
+
+Glob patterns use `*` (any characters) and `?` (single character):
+
+```typescript
+{
+  "shorthands": {
+    "str*": "string*",         // strValue → stringValue
+    "*Props": "*Properties",   // DataProps → DataProperties
+    "*Btn*": "*Button*"        // myBtnClick → myButtonClick
+  }
+}
+```
+
+Regex patterns use `/pattern/flags` syntax:
+
+```typescript
+{
+  "shorthands": {
+    "/^str(.*)$/": "string$1",  // strName → stringName
+    "/^props$/i": "properties"  // Props or props → properties
+  }
+}
+```
+
+**Compound identifier matching**
+
+Identifiers are split at camelCase/PascalCase boundaries, and each word is checked independently:
+
+- `propsData` with `{ "props": "properties" }` → `propertiesData`
+- `UnitBoxBadgeInfoProps` with `{ "Props": "Properties" }` → `UnitBoxBadgeInfoProperties`
+
 **❌ Bad**
 
 ```typescript
@@ -881,6 +924,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": "d84eba40b7747b35f7141d5e4f2ef9ce11db5e57",
-  "time": "2025-12-22T21:43:58.605Z",
-  "version": "1.9.2"
+  "commit": "33b03ad58201aa1a174c1516a9b52a659f746afc",
+  "time": "2025-12-28T16:15:11.008Z",
+  "version": "1.11.0"
 }

package/dist/index.d.ts

@@ -12,7 +12,9 @@ export type { EffectFunctionOptions, EnvironmentMode, HookConfiguration } from "
 export type { PairConfiguration, RequirePairedCallsOptions } from "./rules/require-paired-calls";
 export type { ReactKeysOptions } from "./rules/require-react-component-keys";
 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, 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.
  *

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,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AA+BnC,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,sCAAsC,EACtC,sBAAsB,EACtB,+BAA+B,EAC/B,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;AAuC1D;;;;;;;;;;;;;;;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"}