eslint-plugin-constructors 1.0.0 → 1.0.2

package/README.md

@@ -1,148 +1,150 @@
-# 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/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.
-
-## Installation
-
-```bash
-npm i -D eslint-plugin-constructors
-```
-
-## Usage
-
-Add `constructors` to your flat config:
-
-```js
-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'
-		}
-	}
-]
-```
-
-Or use the bundled recommended config:
-
-```js
-import constructors from 'eslint-plugin-constructors'
-
-export default [
-	{
-		files: ['**/*.js'],
-		...constructors.configs.recommended
-	}
-];
-```
-
-## Rules
-
-The plugin has 3 rules.
-
-### `require-new`
-
-Requires `new` when calling error constructors (and optionally other built‑in constructors).
-
-#### Options
-
-- `"error-only"` (default) – only error constructors (`Error`, `TypeError`, `RangeError`, `SyntaxError`, `ReferenceError`, `URIError`, `EvalError`, `AggregateError`)
-- `"builtins"` – also includes `Array`, `Boolean`, `Date`, `Function`, `Number`, `Object`, `RegExp`, `String`, `Symbol`, `BigInt`, `Map`, `Set`, `WeakMap`, `WeakSet`
-
-#### Example incorrect code
-
-```js
-throw Error('boom')
-throw TypeError('bad')
-
-// w/ builtins:
-const arr = Array(),
-      m = Map()
-```
-
-#### Example correct code
-
-```js
-throw new Error('boom')
-throw new TypeError('bad')
-
-// w/ builtins:
-const arr = new Array(),
-      m = new Map()
-```
-
-#### When Not To Use It
-
-If you prefer the convenience of calling built‑ins without `new` (which is allowed by the spec).
-
----
-
-### `require-error-subclass-name`
-
-Requires classes extending `Error` have a name ending in `Error`.
-
-#### Example incorrect Code
-
-```js
-class My extends Error {}
-const Custom = class extends Error {}
-```
-
-#### Example correct Code
-
-```js
-class MyError extends Error {}
-const CustomError = class extends Error {}
-```
-
-#### When Not To Use It
-
-If you don't follow the common convention of suffixing custom error classes w/ `Error`.
-
----
-
-### `no-explicit-return`
-
-Disallows explicit `return` statements inside class constructors.
-
-#### Incorrect Code
-
-```js
-class A {
-	constructor() {
-		return
-	}
-}
-
-class B {
-	constructor() {
-		return this
-	}
-}
-```
-
-#### Correct Code
-
-```js
-class A {
-	constructor() {
-		this.x = 1
-	}
-}
-```
-
-#### When Not To Use It
-
-If you need to return a different object from a constructor (a rare but valid pattern).
-
-## License
-
-Copyright © 2026 [Adam Lui](https://codeberg.org/adamlui).
+# 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 rules to enforce best practices for constructor usage.
+
+## Installation
+
+```bash
+npm i -D eslint-plugin-constructors
+```
+
+## Usage
+
+Add `constructors` to your flat config:
+
+```js
+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'
+        }
+    }
+]
+```
+
+Or use the bundled recommended config:
+
+```js
+import constructors from 'eslint-plugin-constructors'
+
+export default [
+    {
+        files: ['**/*.js'],
+        ...constructors.configs.recommended
+    }
+];
+```
+
+## Rules
+
+The plugin has 3 rules:
+
+### `require-new`
+
+Requires `new` when calling error constructors (and optionally other built‑in constructors).
+
+#### Options
+
+- `"error-only"` (default) – only error constructors (`Error`, `TypeError`, `RangeError`, `SyntaxError`, `ReferenceError`, `URIError`, `EvalError`, `AggregateError`)
+- `"builtins"` – also includes `Array`, `Boolean`, `Date`, `Function`, `Number`, `Object`, `RegExp`, `String`, `Symbol`, `BigInt`, `Map`, `Set`, `WeakMap`, `WeakSet`
+
+#### Example incorrect code
+
+```js
+throw Error('boom')
+throw TypeError('bad')
+
+// w/ builtins:
+const arr = Array(),
+      m = Map()
+```
+
+#### Example correct code
+
+```js
+throw new Error('boom')
+throw new TypeError('bad')
+
+// w/ builtins:
+const arr = new Array(),
+      m = new Map()
+```
+
+#### When not to use it
+
+If you prefer the convenience of calling built‑ins without `new` (which is allowed by the spec).
+
+---
+
+### `require-error-subclass-name`
+
+Requires classes extending `Error` have a name ending in `Error`.
+
+#### Example incorrect code
+
+```js
+class My extends Error {}
+const Custom = class extends Error {}
+```
+
+#### Example correct code
+
+```js
+class MyError extends Error {}
+const CustomError = class extends Error {}
+```
+
+#### When not to use it
+
+If you don't follow the convention of suffixing custom error classes w/ `Error`.
+
+---
+
+### `no-explicit-return`
+
+Disallows explicit `return` statements inside class constructors.
+
+#### Incorrect Code
+
+```js
+class A {
+    constructor() {
+        return
+    }
+}
+
+class B {
+    constructor() {
+        return this
+    }
+}
+```
+
+#### Correct Code
+
+```js
+class A {
+    constructor() {
+        this.x = 1
+    }
+}
+```
+
+#### When not to use it
+
+If you need to return a different object from a constructor.
+
+## License
+
+Copyright © 2026 [Adam Lui](https://codeberg.org/adamlui).

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.0",
+  "version": "1.0.2",
   "description": "ESLint rules for constructor usage",
   "type": "module",
   "engines": {
@@ -15,16 +15,21 @@
   "license": "MIT",
   "main": "src/index.js",
   "files": [
-    "src"
+    "docs/",
+    "src/"
   ],
   "scripts": {
     "prepare": "husky",
-    "lint": "eslint . --cache",
-    "lint:all": "eslint .",
-    "lint:fix": "eslint . --fix --cache",
-    "lint:fix-all": "eslint . --fix",
+    "lint": "eslint . --cache && yamllint .",
+    "lint:all": "eslint . && yamllint .",
+    "lint:fix": "eslint . --fix --cache && yamllint .",
+    "lint:fix-all": "eslint . --fix && yamllint .",
     "test": "node tests/run.js",
-    "demo": "eslint --config demo/eslint.config.js demo/buggy-script.js"
+    "demo": "eslint --config demo/eslint.config.js demo/buggy-script.js",
+    "bump:patch": "bash utils/bump.sh patch",
+    "bump:minor": "bash utils/bump.sh minor",
+    "bump:feat": "npm run bump:minor",
+    "bump:major": "bash utils/bump.sh major"
   },
   "keywords": [
     "code-quality",
@@ -42,13 +47,15 @@
     "@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",
     "eslint-plugin-promise": "^7.3.0",
     "eslint-plugin-regexp": "^3.3.0",
     "globals": "^17.12.0",
-    "husky": "^9.1.7"
+    "husky": "^9.1.7",
+    "yamllint-js": "^0.2.4"
   },
   "peerDependencies": {
     "eslint": ">=9.0.0"

package/src/index.js

@@ -1,26 +1,24 @@
-import requireNew from './rules/require-new.js'
-import requireErrorSubclassName from './rules/require-error-subclass-name.js'
-import noExplicitReturn from './rules/no-explicit-return.js'
-
-const plugin = {
-    rules: {
-        'require-new': requireNew,
-        'require-error-subclass-name': requireErrorSubclassName,
-        'no-explicit-return': noExplicitReturn
-    }
-}
-
-plugin.configs = {
-    recommended: [
-        {
-            plugins: { constructors: plugin },
-            rules: {
-                'constructors/require-new': 'error',
-                'constructors/require-error-subclass-name': 'error',
-                'constructors/no-explicit-return': 'error'
-            }
-        }
-    ]
-}
-
-export default plugin
+import requireNew from './rules/require-new.js'
+import requireErrorSubclassName from './rules/require-error-subclass-name.js'
+import noExplicitReturn from './rules/no-explicit-return.js'
+
+const plugin = {
+    rules: {
+        'require-new': requireNew,
+        'require-error-subclass-name': requireErrorSubclassName,
+        'no-explicit-return': noExplicitReturn
+    }
+}
+
+plugin.configs = {
+    recommended: {
+        plugins: { constructors: plugin },
+        rules: {
+            'constructors/require-new': 'error',
+            'constructors/require-error-subclass-name': 'error',
+            'constructors/no-explicit-return': 'error'
+        }
+    }
+}
+
+export default plugin

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

@@ -1,37 +1,37 @@
-const reFuncNodeType = /^(?:Arrow)?Function(?:Declaration|Expression)$/
-
-export default {
-    meta: {
-        type: 'problem',
-        docs: {
-            description: 'Disallow explicit return statements in class constructors',
-            category: 'Best Practices',
-            recommended: true
-        },
-        schema: [],
-        messages: { unexpectedReturn: 'Unexpected return statement in constructor' }
-    },
-
-    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))
-                    context.report({ node, messageId: 'unexpectedReturn' })
-            }
-        }
-    }
-}
+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',
+        docs: {
+            description: 'Disallow explicit return statements in class constructors',
+            category: 'Best Practices',
+            recommended: true
+        },
+        schema: [],
+        messages: { unexpectedReturn: 'Unexpected return statement in constructor' }
+    },
+
+    create(context) {
+        return {
+            ReturnStatement(node) {
+                if (isInsideConstructorFunc(node))
+                    context.report({ node, messageId: 'unexpectedReturn' })
+            }
+        }
+    }
+}

package/src/rules/require-error-subclass-name.js

@@ -1,39 +1,39 @@
-export default {
-    meta: {
-        type: 'suggestion',
-        docs: {
-            description: 'Require that classes extending Error have names ending in "Error"',
-            category: 'Best Practices',
-            recommended: true
-        },
-        schema: [],
-        messages: { endWithError: 'Class extending Error must have a name ending in "Error"' }
-    },
-
-    create(context) {
-        function checkName(name, node) {
-            if (!name || name.endsWith('Error')) return
-            context.report({ node, messageId: 'endWithError' })
-        }
-
-        function checkClassNode(node) {
-            if (!node.id || !node.superClass?.name?.endsWith('Error')) return
-            checkName(node.id.name, node.id)
-        }
-
-        function checkVariableDeclarator(node) {
-            const classExpr = node.init
-            if (classExpr?.type != 'ClassExpression'
-                || !classExpr.superClass?.name?.endsWith('Error')
-                || classExpr.id // named class expression, already checked
-            ) return
-            checkName(node.id.name, node.id)
-        }
-
-        return {
-            ClassDeclaration: checkClassNode,
-            ClassExpression: checkClassNode,
-            VariableDeclarator: checkVariableDeclarator
-        }
-    }
-}
+export default {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Require that classes extending Error have names ending in "Error"',
+            category: 'Best Practices',
+            recommended: true
+        },
+        schema: [],
+        messages: { endWithError: 'Class extending Error must have a name ending in "Error"' }
+    },
+
+    create(context) {
+        function checkName(name, node) {
+            if (!name || name.endsWith('Error')) return
+            context.report({ node, messageId: 'endWithError' })
+        }
+
+        function checkClassNode(node) {
+            if (!node.id || !node.superClass?.name?.endsWith('Error')) return
+            checkName(node.id.name, node.id)
+        }
+
+        function checkVariableDeclarator(node) {
+            const classExpr = node.init
+            if (classExpr?.type != 'ClassExpression'
+                || !classExpr.superClass?.name?.endsWith('Error')
+                || classExpr.id // named class expression, already checked
+            ) return
+            checkName(node.id.name, node.id)
+        }
+
+        return {
+            ClassDeclaration: checkClassNode,
+            ClassExpression: checkClassNode,
+            VariableDeclarator: checkVariableDeclarator
+        }
+    }
+}

package/src/rules/require-new.js

@@ -1,49 +1,45 @@
-const ERR_CONSTRUCTORS = new Set([
-    'Error',
-    'TypeError',
-    'RangeError',
-    'SyntaxError',
-    'ReferenceError',
-    'URIError',
-    'EvalError',
-    'AggregateError'
-])
-
-const BUILTIN_CONSTRUCTORS = new Set([
-    'Array', 'Boolean', 'Date', 'Function', 'Number', 'Object',
-    'RegExp', 'String', 'Symbol', 'BigInt', 'Map', 'Set',
-    'WeakMap', 'WeakSet'
-])
-
-function isErrConstructor(name) { return ERR_CONSTRUCTORS.has(name) }
-
-export default {
-    meta: {
-        type: 'problem',
-        docs: {
-            description: 'Require `new` when calling constructor functions',
-            category: 'Best Practices',
-            recommended: true
-        },
-        fixable: 'code',
-        schema: [{ enum: ['error-only', 'builtins'] }],
-        messages: { requireNew: 'Use `new {{name}}()` instead of `{{name}}()`' }
-    },
-
-    create(context) {
-        const mode = context.options[0] || 'error-only'
-        return {
-            CallExpression(node) {
-                if (node.new) return
-                const calleeName = node.callee.name ; if (!calleeName) return
-                const shouldReport = mode == 'error-only' ? isErrConstructor(calleeName)
-                                   : isErrConstructor(calleeName) || BUILTIN_CONSTRUCTORS.has(calleeName)
-                if (shouldReport)
-                    context.report({
-                        node, messageId: 'requireNew', data: { name: calleeName },
-                        fix(fixer) { return fixer.insertTextBefore(node, 'new ') }
-                    })
-            }
-        }
-    }
-}
+const ERR_CONSTRUCTORS = new Set([
+    'AggregateError', 'Error', 'EvalError', 'RangeError', 'ReferenceError', 'SyntaxError', 'TypeError', 'URIError'])
+
+const BUILTIN_CONSTRUCTORS = new Set([
+    'Array', 'BigInt', 'Boolean', 'Date', 'Function', 'Number', 'Object', 'RegExp', 'String', 'Symbol', 'Map', 'Set',
+    'WeakMap', 'WeakSet'
+])
+
+function isErrConstructor(name) { return ERR_CONSTRUCTORS.has(name) }
+
+export default {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Require `new` when calling constructor functions',
+            category: 'Best Practices',
+            recommended: true
+        },
+        fixable: 'code',
+        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}}()`' }
+    },
+
+    create(context) {
+        const mode = context.options[0] || 'error-only'
+        return {
+            CallExpression(node) {
+                if (node.new) return
+                const calleeName = node.callee.name ; if (!calleeName) return
+                const shouldReport = mode == 'error-only' ? isErrConstructor(calleeName)
+                                   : isErrConstructor(calleeName) || BUILTIN_CONSTRUCTORS.has(calleeName)
+                if (shouldReport)
+                    context.report({
+                        node, messageId: 'requireNew', data: { name: calleeName },
+                        fix(fixer) { return fixer.insertTextBefore(node, 'new ') }
+                    })
+            }
+        }
+    }
+}