eslint-plugin-constructors 1.0.1 → 1.0.2

package/README.md

@@ -1,9 +1,11 @@
 # eslint-plugin-constructors
 
-[![](https://img.shields.io/npm/v/eslint-plugin-constructors?style=for-the-badge&label=Latest%20Build)](https://www.npmjs.com/package/eslint-plugin-constructors)
+[![](https://img.shields.io/npm/v/eslint-plugin-constructors?style=for-the-badge&label=Latest%20Build&color=32fcee)](https://www.npmjs.com/package/eslint-plugin-constructors)
+<a href="./#license">
+    <img src="https://img.shields.io/badge/License-MIT-f99b27.svg?logo=internetarchive&logoColor=white&labelColor=464646&style=for-the-badge"></a>
 [![](https://img.shields.io/badge/Requires-ESLint_%3E%3D9.0.0-4B32C3?style=for-the-badge&logo=eslint)](https://eslint.org/)
 
-ESLint plugin to enforce best practices for constructor usage.
+ESLint rules to enforce best practices for constructor usage.
 
 ## Installation
 
@@ -19,15 +21,15 @@ Add `constructors` to your flat config:
 import constructors from 'eslint-plugin-constructors'
 
 export default [
-	{
-		files: ['**/*.js'],
-		plugins: { constructors },
-		rules: {
-			'constructors/no-explicit-return': 'error',
-			'constructors/require-error-subclass-name': 'error',
-			'constructors/require-new': 'error'
-		}
-	}
+    {
+        files: ['**/*.js'],
+        plugins: { constructors },
+        rules: {
+            'constructors/no-explicit-return': 'error',
+            'constructors/require-error-subclass-name': 'error',
+            'constructors/require-new': 'error'
+        }
+    }
 ]
 ```
 
@@ -37,10 +39,10 @@ Or use the bundled recommended config:
 import constructors from 'eslint-plugin-constructors'
 
 export default [
-	{
-		files: ['**/*.js'],
-		...constructors.configs.recommended
-	}
+    {
+        files: ['**/*.js'],
+        ...constructors.configs.recommended
+    }
 ];
 ```
 
@@ -117,15 +119,15 @@ Disallows explicit `return` statements inside class constructors.
 
 ```js
 class A {
-	constructor() {
-		return
-	}
+    constructor() {
+        return
+    }
 }
 
 class B {
-	constructor() {
-		return this
-	}
+    constructor() {
+        return this
+    }
 }
 ```
 
@@ -133,9 +135,9 @@ class B {
 
 ```js
 class A {
-	constructor() {
-		this.x = 1
-	}
+    constructor() {
+        this.x = 1
+    }
 }
 ```
 

package/docs/LICENSE.md

@@ -0,0 +1,9 @@
+# 🏛️ MIT License
+
+**Copyright © 2026 [Adam Lui](https://codeberg.org/adamlui).**
+
+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/docs/SECURITY.md

@@ -0,0 +1,3 @@
+# Security Policy
+
+If you find a vulnerability, please e-mail <security@kudoai.org>.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-constructors",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "ESLint rules for constructor usage",
   "type": "module",
   "engines": {
@@ -15,7 +15,8 @@
   "license": "MIT",
   "main": "src/index.js",
   "files": [
-    "src"
+    "docs/",
+    "src/"
   ],
   "scripts": {
     "prepare": "husky",
@@ -46,6 +47,7 @@
     "@eslint/markdown": "^8.0.3",
     "@stylistic/eslint-plugin": "^5.10.0",
     "eslint": "^10.10.0",
+    "eslint-plugin-eslint-plugin": "^7.6.2",
     "eslint-plugin-import-x": "^4.17.1",
     "eslint-plugin-no-secrets": "^2.3.3",
     "eslint-plugin-no-unsanitized": "^4.1.5",

package/src/index.js

@@ -12,9 +12,7 @@ const plugin = {
 
 plugin.configs = {
     recommended: {
-        plugins: {
-            constructors: plugin
-        },
+        plugins: { constructors: plugin },
         rules: {
             'constructors/require-new': 'error',
             'constructors/require-error-subclass-name': 'error',

package/src/rules/no-explicit-return.js

@@ -1,5 +1,19 @@
 const reFuncNodeType = /^(?:Arrow)?Function(?:Declaration|Expression)$/
 
+function isInsideConstructorFunc(node) {
+    let current = node.parent
+    while (current) {
+        if (reFuncNodeType.test(current.type))
+            return ( // whether this func is constructor's val
+                   current.parent?.type == 'MethodDefinition'
+                && current.parent.kind == 'constructor'
+                && !current.parent.static
+            )
+        current = current.parent
+    }
+    return false
+}
+
 export default {
     meta: {
         type: 'problem',
@@ -13,20 +27,6 @@ export default {
     },
 
     create(context) {
-        function isInsideConstructorFunc(node) {
-            let current = node.parent
-            while (current) {
-                if (reFuncNodeType.test(current.type))
-                    return ( // whether this func is constructor's val
-                            current.parent?.type == 'MethodDefinition'
-                         && current.parent.kind == 'constructor'
-                         && !current.parent.static
-                    )
-                current = current.parent
-            }
-            return false
-        }
-
         return {
             ReturnStatement(node) {
                 if (isInsideConstructorFunc(node))

package/src/rules/require-new.js

@@ -1,17 +1,8 @@
 const ERR_CONSTRUCTORS = new Set([
-    'Error',
-    'TypeError',
-    'RangeError',
-    'SyntaxError',
-    'ReferenceError',
-    'URIError',
-    'EvalError',
-    'AggregateError'
-])
+    'AggregateError', 'Error', 'EvalError', 'RangeError', 'ReferenceError', 'SyntaxError', 'TypeError', 'URIError'])
 
 const BUILTIN_CONSTRUCTORS = new Set([
-    'Array', 'Boolean', 'Date', 'Function', 'Number', 'Object',
-    'RegExp', 'String', 'Symbol', 'BigInt', 'Map', 'Set',
+    'Array', 'BigInt', 'Boolean', 'Date', 'Function', 'Number', 'Object', 'RegExp', 'String', 'Symbol', 'Map', 'Set',
     'WeakMap', 'WeakSet'
 ])
 
@@ -26,7 +17,12 @@ export default {
             recommended: true
         },
         fixable: 'code',
-        schema: [{ enum: ['error-only', 'builtins'] }],
+        schema: [{
+            type: 'string',
+            enum: ['error-only', 'builtins'],
+            description: 'Constructor categories to check: "error-only" (default) or "builtins".'
+        }],
+        defaultOptions: ['error-only'],
         messages: { requireNew: 'Use `new {{name}}()` instead of `{{name}}()`' }
     },