@pobammer-ts/eslint-cease-nonsense-rules 0.7.0 → 0.8.0

package/README.md

@@ -29,6 +29,7 @@ export default [
       "cease-nonsense/no-print": "error",
       "cease-nonsense/no-shorthand-names": "error",
       "cease-nonsense/no-warn": "error",
+      "cease-nonsense/prefer-sequence-overloads": "error",
       "cease-nonsense/prefer-udim2-shorthand": "error",
       "cease-nonsense/require-named-effect-functions": "error",
       "cease-nonsense/require-react-component-keys": "error",
@@ -348,6 +349,38 @@ UDim2.fromOffset(100, 50);
 new UDim2(0, 0, 0, 0); // Allowed
 ```
 
+#### `prefer-sequence-overloads`
+
+Prefer the optimized `ColorSequence` and `NumberSequence` constructor overloads instead of building an array of `*SequenceKeypoint`s for the 0/1 endpoints. Includes auto-fix.
+
+**❌ Bad:**
+
+```typescript
+new ColorSequence([
+  new ColorSequenceKeypoint(0, Color3.fromRGB(100, 200, 255)),
+  new ColorSequenceKeypoint(1, Color3.fromRGB(255, 100, 200)),
+]);
+
+new NumberSequence([
+  new NumberSequenceKeypoint(0, 0),
+  new NumberSequenceKeypoint(1, 100),
+]);
+```
+
+**✅ Good:**
+
+```typescript
+new ColorSequence(Color3.fromRGB(100, 200, 255), Color3.fromRGB(255, 100, 200));
+
+new ColorSequence(Color3.fromRGB(255, 255, 255));
+
+new NumberSequence(0, 100);
+
+new NumberSequence(42);
+```
+
+Automatically collapses identical 0/1 endpoints to the single-argument overload.
+
 #### `no-shorthand-names`
 
 Bans shorthand variable names in favor of descriptive full names.

package/dist/index.d.ts

@@ -29,6 +29,7 @@ declare const recommended: {
         readonly "cease-nonsense/no-print": "error";
         readonly "cease-nonsense/no-shorthand-names": "error";
         readonly "cease-nonsense/no-warn": "error";
+        readonly "cease-nonsense/prefer-sequence-overloads": "error";
         readonly "cease-nonsense/prefer-udim2-shorthand": "error";
         readonly "cease-nonsense/require-named-effect-functions": "error";
         readonly "cease-nonsense/require-react-component-keys": "error";

package/dist/index.js

@@ -4,6 +4,7 @@ import noPrint from "./rules/no-print";
 import noShorthandNames from "./rules/no-shorthand-names";
 import noWarn from "./rules/no-warn";
 import preferUDim2Shorthand from "./rules/prefer-udim2-shorthand";
+import preferSequenceOverloads from "./rules/prefer-sequence-overloads";
 import requireNamedEffectFunctions from "./rules/require-named-effect-functions";
 import requireReactComponentKeys from "./rules/require-react-component-keys";
 import useExhaustiveDependencies from "./rules/use-exhaustive-dependencies";
@@ -19,6 +20,7 @@ const rules = {
     "no-print": noPrint,
     "no-shorthand-names": noShorthandNames,
     "no-warn": noWarn,
+    "prefer-sequence-overloads": preferSequenceOverloads,
     "prefer-udim2-shorthand": preferUDim2Shorthand,
     "require-named-effect-functions": requireNamedEffectFunctions,
     "require-react-component-keys": requireReactComponentKeys,
@@ -53,6 +55,7 @@ const recommended = {
         "cease-nonsense/no-print": "error",
         "cease-nonsense/no-shorthand-names": "error",
         "cease-nonsense/no-warn": "error",
+        "cease-nonsense/prefer-sequence-overloads": "error",
         "cease-nonsense/prefer-udim2-shorthand": "error",
         "cease-nonsense/require-named-effect-functions": "error",
         "cease-nonsense/require-react-component-keys": "error",

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,uBAAuB,MAAM,oCAAoC,CAAC;AACzE,OAAO,mBAAmB,MAAM,+BAA+B,CAAC;AAChE,OAAO,OAAO,MAAM,kBAAkB,CAAC;AACvC,OAAO,gBAAgB,MAAM,4BAA4B,CAAC;AAC1D,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,oBAAoB,MAAM,gCAAgC,CAAC;AAClE,OAAO,2BAA2B,MAAM,wCAAwC,CAAC;AACjF,OAAO,yBAAyB,MAAM,sCAAsC,CAAC;AAC7E,OAAO,yBAAyB,MAAM,qCAAqC,CAAC;AAC5E,OAAO,iBAAiB,MAAM,+BAA+B,CAAC;AAI9D;;;;GAIG;AACH,MAAM,KAAK,GAA4C;IACtD,4BAA4B,EAAE,uBAAuB;IACrD,uBAAuB,EAAE,mBAAmB;IAC5C,UAAU,EAAE,OAAO;IACnB,oBAAoB,EAAE,gBAAgB;IACtC,SAAS,EAAE,MAAM;IACjB,wBAAwB,EAAE,oBAAoB;IAC9C,gCAAgC,EAAE,2BAA2B;IAC7D,8BAA8B,EAAE,yBAAyB;IACzD,6BAA6B,EAAE,yBAAyB;IACxD,uBAAuB,EAAE,iBAAiB;CACjC,CAAC;AAEX;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,GAAG;IACnB,OAAO,EAAE;QACR,gBAAgB,EAAE;YACjB,KAAK;SACL;KACD;IACD,KAAK,EAAE;QACN,2CAA2C,EAAE,OAAO;QACpD,sCAAsC,EAAE,OAAO;QAC/C,yBAAyB,EAAE,OAAO;QAClC,mCAAmC,EAAE,OAAO;QAC5C,wBAAwB,EAAE,OAAO;QACjC,uCAAuC,EAAE,OAAO;QAChD,+CAA+C,EAAE,OAAO;QACxD,6CAA6C,EAAE,OAAO;QACtD,4CAA4C,EAAE,OAAO;QACrD,sCAAsC,EAAE,OAAO;KAC/C;CACQ,CAAC;AAWX,MAAM,MAAM,GAAW;IACtB,OAAO,EAAE,EAAE,WAAW,EAAE;IACxB,KAAK;CACI,CAAC;AAEX,eAAe,MAAM,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,uBAAuB,MAAM,oCAAoC,CAAC;AACzE,OAAO,mBAAmB,MAAM,+BAA+B,CAAC;AAChE,OAAO,OAAO,MAAM,kBAAkB,CAAC;AACvC,OAAO,gBAAgB,MAAM,4BAA4B,CAAC;AAC1D,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,oBAAoB,MAAM,gCAAgC,CAAC;AAClE,OAAO,uBAAuB,MAAM,mCAAmC,CAAC;AACxE,OAAO,2BAA2B,MAAM,wCAAwC,CAAC;AACjF,OAAO,yBAAyB,MAAM,sCAAsC,CAAC;AAC7E,OAAO,yBAAyB,MAAM,qCAAqC,CAAC;AAC5E,OAAO,iBAAiB,MAAM,+BAA+B,CAAC;AAI9D;;;;GAIG;AACH,MAAM,KAAK,GAA4C;IACtD,4BAA4B,EAAE,uBAAuB;IACrD,uBAAuB,EAAE,mBAAmB;IAC5C,UAAU,EAAE,OAAO;IACnB,oBAAoB,EAAE,gBAAgB;IACtC,SAAS,EAAE,MAAM;IACjB,2BAA2B,EAAE,uBAAuB;IACpD,wBAAwB,EAAE,oBAAoB;IAC9C,gCAAgC,EAAE,2BAA2B;IAC7D,8BAA8B,EAAE,yBAAyB;IACzD,6BAA6B,EAAE,yBAAyB;IACxD,uBAAuB,EAAE,iBAAiB;CACjC,CAAC;AAEX;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,GAAG;IACnB,OAAO,EAAE;QACR,gBAAgB,EAAE;YACjB,KAAK;SACL;KACD;IACD,KAAK,EAAE;QACN,2CAA2C,EAAE,OAAO;QACpD,sCAAsC,EAAE,OAAO;QAC/C,yBAAyB,EAAE,OAAO;QAClC,mCAAmC,EAAE,OAAO;QAC5C,wBAAwB,EAAE,OAAO;QACjC,0CAA0C,EAAE,OAAO;QACnD,uCAAuC,EAAE,OAAO;QAChD,+CAA+C,EAAE,OAAO;QACxD,6CAA6C,EAAE,OAAO;QACtD,4CAA4C,EAAE,OAAO;QACrD,sCAAsC,EAAE,OAAO;KAC/C;CACQ,CAAC;AAWX,MAAM,MAAM,GAAW;IACtB,OAAO,EAAE,EAAE,WAAW,EAAE;IACxB,KAAK;CACI,CAAC;AAEX,eAAe,MAAM,CAAC"}

package/dist/rules/prefer-sequence-overloads.d.ts

@@ -0,0 +1,7 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+interface RuleDocsWithRecommended extends TSESLint.RuleMetaDataDocs {
+    recommended?: boolean;
+}
+declare const preferSequenceOverloads: TSESLint.RuleModuleWithMetaDocs<"preferSingleOverload" | "preferTwoPointOverload", [
+], RuleDocsWithRecommended>;
+export default preferSequenceOverloads;

package/dist/rules/prefer-sequence-overloads.js

@@ -0,0 +1,106 @@
+import { AST_NODE_TYPES } from "@typescript-eslint/types";
+const sequenceDescriptors = [
+    { keypointName: "ColorSequenceKeypoint", sequenceName: "ColorSequence" },
+    { keypointName: "NumberSequenceKeypoint", sequenceName: "NumberSequence" },
+];
+function isSequenceIdentifier(node) {
+    return (node.type === AST_NODE_TYPES.Identifier &&
+        sequenceDescriptors.some((descriptor) => descriptor.sequenceName === node.name));
+}
+function findDescriptor(sequenceName) {
+    return sequenceDescriptors.find((descriptor) => descriptor.sequenceName === sequenceName);
+}
+function isNumericLiteral(argument) {
+    return argument !== undefined && argument.type === AST_NODE_TYPES.Literal && typeof argument.value === "number";
+}
+function isExpressionArgument(argument) {
+    return argument !== undefined && argument.type !== AST_NODE_TYPES.SpreadElement;
+}
+function extractKeypoint(element, descriptor) {
+    if (element === null || element.type !== AST_NODE_TYPES.NewExpression)
+        return undefined;
+    if (element.callee.type !== AST_NODE_TYPES.Identifier || element.callee.name !== descriptor.keypointName) {
+        return undefined;
+    }
+    if (element.arguments.length !== 2)
+        return undefined;
+    const [timeArgument, valueArgument] = element.arguments;
+    if (!isNumericLiteral(timeArgument))
+        return undefined;
+    if (!isExpressionArgument(valueArgument))
+        return undefined;
+    return {
+        time: timeArgument.value,
+        value: valueArgument,
+    };
+}
+const docs = {
+    description: "Prefer the optimized ColorSequence and NumberSequence constructor overloads over passing ColorSequenceKeypoint or NumberSequenceKeypoint arrays when only using endpoints 0 and 1.",
+    recommended: true,
+};
+const preferSequenceOverloads = {
+    create(context) {
+        const sourceCode = context.getSourceCode();
+        return {
+            NewExpression(node) {
+                const callee = node.callee;
+                if (!isSequenceIdentifier(callee))
+                    return;
+                const descriptor = findDescriptor(callee.name);
+                if (descriptor === undefined)
+                    return;
+                if (node.arguments.length !== 1)
+                    return;
+                const [argument] = node.arguments;
+                if (argument === undefined || argument.type !== AST_NODE_TYPES.ArrayExpression)
+                    return;
+                if (argument.elements.length !== 2)
+                    return;
+                const firstElement = argument.elements[0] ?? null;
+                const secondElement = argument.elements[1] ?? null;
+                const firstKeypoint = extractKeypoint(firstElement, descriptor);
+                const secondKeypoint = extractKeypoint(secondElement, descriptor);
+                if (firstKeypoint === undefined || secondKeypoint === undefined)
+                    return;
+                if (firstKeypoint.time !== 0 || secondKeypoint.time !== 1)
+                    return;
+                const firstValueText = sourceCode.getText(firstKeypoint.value);
+                const secondValueText = sourceCode.getText(secondKeypoint.value);
+                const normalizedFirstValue = firstValueText.trim();
+                const normalizedSecondValue = secondValueText.trim();
+                if (normalizedFirstValue === normalizedSecondValue) {
+                    context.report({
+                        fix: (fixer) => fixer.replaceText(node, `new ${descriptor.sequenceName}(${firstValueText})`),
+                        messageId: "preferSingleOverload",
+                        node,
+                        data: {
+                            sequenceName: descriptor.sequenceName,
+                        },
+                    });
+                    return;
+                }
+                context.report({
+                    fix: (fixer) => fixer.replaceText(node, `new ${descriptor.sequenceName}(${firstValueText}, ${secondValueText})`),
+                    messageId: "preferTwoPointOverload",
+                    node,
+                    data: {
+                        sequenceName: descriptor.sequenceName,
+                    },
+                });
+            },
+        };
+    },
+    defaultOptions: [],
+    meta: {
+        docs,
+        fixable: "code",
+        messages: {
+            preferSingleOverload: "Use the single-argument {{sequenceName}} constructor overload instead of redundant keypoints when both endpoints share the same value.",
+            preferTwoPointOverload: "Use the two-argument {{sequenceName}} constructor overload instead of allocating an array of keypoints for endpoints 0 and 1.",
+        },
+        schema: [],
+        type: "problem",
+    },
+};
+export default preferSequenceOverloads;
+//# sourceMappingURL=prefer-sequence-overloads.js.map

package/dist/rules/prefer-sequence-overloads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-sequence-overloads.js","sourceRoot":"","sources":["../../src/rules/prefer-sequence-overloads.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAiB1D,MAAM,mBAAmB,GAAsC;IAC9D,EAAE,YAAY,EAAE,uBAAuB,EAAE,YAAY,EAAE,eAAe,EAAE;IACxE,EAAE,YAAY,EAAE,wBAAwB,EAAE,YAAY,EAAE,gBAAgB,EAAE;CAC1E,CAAC;AAEF,SAAS,oBAAoB,CAC5B,IAA0C;IAE1C,OAAO,CACN,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU;QACvC,mBAAmB,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,YAAY,KAAK,IAAI,CAAC,IAAI,CAAC,CAC/E,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,YAAgD;IACvE,OAAO,mBAAmB,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,YAAY,KAAK,YAAY,CAAC,CAAC;AAC3F,CAAC;AAED,SAAS,gBAAgB,CAAC,QAAqD;IAG9E,OAAO,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,IAAI,KAAK,cAAc,CAAC,OAAO,IAAI,OAAO,QAAQ,CAAC,KAAK,KAAK,QAAQ,CAAC;AACjH,CAAC;AAED,SAAS,oBAAoB,CAAC,QAAqD;IAClF,OAAO,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,IAAI,KAAK,cAAc,CAAC,aAAa,CAAC;AACjF,CAAC;AAED,SAAS,eAAe,CACvB,OAA4D,EAC5D,UAA8B;IAE9B,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,CAAC,IAAI,KAAK,cAAc,CAAC,aAAa;QAAE,OAAO,SAAS,CAAC;IACxF,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,YAAY,EAAE,CAAC;QAC1G,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAErD,MAAM,CAAC,YAAY,EAAE,aAAa,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IACxD,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC;QAAE,OAAO,SAAS,CAAC;IACtD,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC;QAAE,OAAO,SAAS,CAAC;IAE3D,OAAO;QACN,IAAI,EAAE,YAAY,CAAC,KAAK;QACxB,KAAK,EAAE,aAAa;KACpB,CAAC;AACH,CAAC;AAED,MAAM,IAAI,GAA4B;IACrC,WAAW,EACV,oLAAoL;IACrL,WAAW,EAAE,IAAI;CACjB,CAAC;AAEF,MAAM,uBAAuB,GAIzB;IACH,MAAM,CAAC,OAAO;QACb,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;QAE3C,OAAO;YACN,aAAa,CAAC,IAAI;gBACjB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;gBAC3B,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC;oBAAE,OAAO;gBAE1C,MAAM,UAAU,GAAG,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC/C,IAAI,UAAU,KAAK,SAAS;oBAAE,OAAO;gBAErC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;oBAAE,OAAO;gBAExC,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;gBAClC,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe;oBAAE,OAAO;gBACvF,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC;oBAAE,OAAO;gBAE3C,MAAM,YAAY,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;gBAClD,MAAM,aAAa,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;gBAEnD,MAAM,aAAa,GAAG,eAAe,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;gBAChE,MAAM,cAAc,GAAG,eAAe,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;gBAClE,IAAI,aAAa,KAAK,SAAS,IAAI,cAAc,KAAK,SAAS;oBAAE,OAAO;gBAExE,IAAI,aAAa,CAAC,IAAI,KAAK,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,CAAC;oBAAE,OAAO;gBAElE,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;gBAC/D,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;gBACjE,MAAM,oBAAoB,GAAG,cAAc,CAAC,IAAI,EAAE,CAAC;gBACnD,MAAM,qBAAqB,GAAG,eAAe,CAAC,IAAI,EAAE,CAAC;gBAErD,IAAI,oBAAoB,KAAK,qBAAqB,EAAE,CAAC;oBACpD,OAAO,CAAC,MAAM,CAAC;wBACd,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,UAAU,CAAC,YAAY,IAAI,cAAc,GAAG,CAAC;wBAC5F,SAAS,EAAE,sBAAsB;wBACjC,IAAI;wBACJ,IAAI,EAAE;4BACL,YAAY,EAAE,UAAU,CAAC,YAAY;yBACrC;qBACD,CAAC,CAAC;oBACH,OAAO;gBACR,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC;oBACd,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,CACd,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,UAAU,CAAC,YAAY,IAAI,cAAc,KAAK,eAAe,GAAG,CAAC;oBACjG,SAAS,EAAE,wBAAwB;oBACnC,IAAI;oBACJ,IAAI,EAAE;wBACL,YAAY,EAAE,UAAU,CAAC,YAAY;qBACrC;iBACD,CAAC,CAAC;YACJ,CAAC;SACD,CAAC;IACH,CAAC;IACD,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACL,IAAI;QACJ,OAAO,EAAE,MAAM;QACf,QAAQ,EAAE;YACT,oBAAoB,EACnB,wIAAwI;YACzI,sBAAsB,EACrB,+HAA+H;SAChI;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KACf;CACD,CAAC;AAEF,eAAe,uBAAuB,CAAC"}

package/package.json

@@ -65,5 +65,5 @@
 	"sideEffects": false,
 	"type": "module",
 	"types": "./dist/index.d.ts",
-	"version": "0.7.0"
+	"version": "0.8.0"
 }