eslint-plugin-hex-under 0.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 0xflotus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,38 @@
+# eslint-plugin-hex-under
+
+## hex-under
+
+This ESLint plugin proves, if you use hexadecimal numbers in your variable declaration code, that its value is less than or equal a specified value (default: 255). If you use a hexadecimal number greater than this specified value, it will be transformed to its decimal value.
+
+### Example
+
+```js
+// valid with { limit: 255 }
+const signal = 0xef;
+
+// invalid with { limit: 255 }
+const signal = 0x21b;
+
+// This will be transformed to:
+const signal = 539;
+```
+
+## Integration
+
+```js
+// eslint.config.js
+
+const eslintPluginHexUnder = require("./eslint-plugin-hex-under");
+
+module.exports = [
+  {
+    files: ["*.js"],
+    plugins: {
+      "hex-under": eslintPluginHexUnder,
+    },
+    rules: {
+      "hex-under/hex-under-256": ["error", { limit: 255 }],
+    },
+  },
+];
+```

package/eslint-plugin-hex-under.js

@@ -0,0 +1,3 @@
+const hexUnderRule = require("./hex-under");
+const plugin = { rules: { "hex-under": hexUnderRule } };
+module.exports = plugin;

package/eslint.config.js

@@ -0,0 +1,15 @@
+"use strict";
+
+const eslintPluginHexUnder = require("./eslint-plugin-hex-under");
+
+module.exports = [
+  {
+    files: ["*.js"],
+    plugins: {
+      "hex-under": eslintPluginHexUnder,
+    },
+    rules: {
+      "hex-under/hex-under-256": ["error", { limit: 255 }],
+    },
+  },
+];

package/hex-under.js

@@ -0,0 +1,58 @@
+module.exports = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Proves that a hexadecimal number must be less than a specified value. Default is 255.",
+    },
+    fixable: "code",
+    schema: [
+      {
+        type: "object",
+        properties: {
+          limit: {
+            type: "integer",
+            minimum: 1,
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+    messages: {
+      valueOver:
+        "Value of '{{ variableName }}' must be less than {{ limitPlusOne }}. {{ over255Raw }} is greater than {{ limit }}.",
+    },
+  },
+  create(context) {
+    const limit = context.options[0]?.limit || 255;
+    return {
+      VariableDeclarator(node) {
+        if (["const", "let", "var"].some((el) => el === node.parent.kind)) {
+          if (
+            node.init &&
+            node.init.type === "Literal" &&
+            node.init.raw.startsWith("0x")
+          ) {
+            if (parseInt(node.init.value) > limit) {
+              context.report({
+                node,
+                messageId: "valueOver",
+                data: {
+                  limit: limit,
+                  limitPlusOne: limit + 1,
+                  over255Raw: node.init.raw,
+                  variableName: node.id.name,
+                },
+                fix(fixer) {
+                  return fixer.replaceText(
+                    node.init,
+                    parseInt(node.init.value),
+                  );
+                },
+              });
+            }
+          }
+        }
+      },
+    };
+  },
+};

package/hex-under.test.js

@@ -0,0 +1,60 @@
+const { RuleTester } = require("eslint");
+const hexUnder256Rule = require("./hex-under");
+
+const ruleTester = new RuleTester({
+  languageOptions: { ecmaVersion: 2015 },
+});
+
+ruleTester.run("hex-under-256", hexUnder256Rule, {
+  valid: [
+    {
+      options: [{ limit: 255 }],
+      code: "const foo = 0xff;",
+    },
+    {
+      options: [{ limit: 256 }],
+      code: "const foo = 0x100;",
+    },
+  ],
+  invalid: [
+    {
+      code: "const foo = 0x100;",
+      output: "const foo = 256;",
+      errors: 1,
+    },
+  ],
+});
+
+ruleTester.run("hex-under-256", hexUnder256Rule, {
+  valid: [
+    {
+      options: [{ limit: 255 }],
+      code: "let foo = 0xff;",
+    },
+  ],
+  invalid: [
+    {
+      code: "let foo = 0x100;",
+      output: "let foo = 256;",
+      errors: 1,
+    },
+  ],
+});
+
+ruleTester.run("hex-under-256", hexUnder256Rule, {
+  valid: [
+    {
+      options: [{ limit: 256 }],
+      code: "var foo = 0xff;",
+    },
+  ],
+  invalid: [
+    {
+      code: "var foo = 0x100;",
+      output: "var foo = 256;",
+      errors: 1,
+    },
+  ],
+});
+
+console.log("All tests passed!");

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "eslint-plugin-hex-under",
+  "version": "0.0.3",
+  "main": "eslint-plugin-hex-under.js",
+  "scripts": {
+    "lint": "prettier . --check && eslint .",
+    "test": "node hex-under-256.test.js"
+  },
+  "keywords": [],
+  "author": "0xflotus",
+  "license": "MIT",
+  "description": "This ESLint rule proves that hex numbers are less than 256",
+  "devDependencies": {
+    "eslint": "9.20.1",
+    "prettier": "3.5.1"
+  }
+}