eslint-plugin-constructors 1.0.2 → 1.0.3

package/README.md

@@ -1,14 +1,19 @@
+<a id="top"></a>
+
 # 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/npm/v/eslint-plugin-constructors?logo=icinga&style=for-the-badge&label=Latest%20Build&color=32fcee)][epc-npm]
+[![](https://img.shields.io/badge/License-MIT-f1f20a.svg?logo=internetarchive&logoColor=white&labelColor=464646&style=for-the-badge)](./#license)
 [![](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.
 
+<img src="https://cdn.staticdelivr.com/gl/adamlui/eslint-plugin-constructors/6eeba7b2cb/assets/images/screenshots/vs-code/squiggles.png">
+
 ## Installation
 
+From your project root:
+
 ```bash
 npm i -D eslint-plugin-constructors
 ```
@@ -27,13 +32,15 @@ export default [
         rules: {
             'constructors/no-explicit-return': 'error',
             'constructors/require-error-subclass-name': 'error',
-            'constructors/require-new': 'error'
+            'constructors/require-new': ['error', 'error-only']
         }
     }
 ]
 ```
 
-Or use the bundled recommended config:
+**Note:** Rule config is either a severity string (`'off'`, `'warn'`, `'error'`) or an array `[severity, options]` when the rule accepts options.
+
+To use the bundled recommended config (enables all 3 rules at `'error'`):
 
 ```js
 import constructors from 'eslint-plugin-constructors'
@@ -43,62 +50,71 @@ export default [
         files: ['**/*.js'],
         ...constructors.configs.recommended
     }
-];
+]
 ```
 
 ## Rules
 
-The plugin has 3 rules:
-
-### `require-new`
+- [`no-explicit-return`](#no-explicit-return)
+- [`require-error-subclass-name`](#require-error-subclass-name)
+- [`require-new`](#require-new)
 
-Requires `new` when calling error constructors (and optionally other built‑in constructors).
+---
 
-#### Options
+### `no-explicit-return`
 
-- `"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`
+> Disallows explicit `return` statements inside class constructors.
 
-#### Example incorrect code
+#### Incorrect code
 
 ```js
-throw Error('boom')
-throw TypeError('bad')
+class A {
+    constructor() {
+        return
+    }
+}
 
-// w/ builtins:
-const arr = Array(),
-      m = Map()
+class B {
+    constructor() {
+        return this
+    }
+}
 ```
 
-#### Example correct code
+#### Correct code
 
 ```js
-throw new Error('boom')
-throw new TypeError('bad')
-
-// w/ builtins:
-const arr = new Array(),
-      m = new Map()
+class A {
+    constructor() {
+        this.x = 1
+    }
+}
 ```
 
 #### When not to use it
 
-If you prefer the convenience of calling built‑ins without `new` (which is allowed by the spec).
+If you need to return a different object from a constructor.
+
+<div align="center">
+
+[Back to index ↑][epc-rules]
+
+</div>
 
 ---
 
 ### `require-error-subclass-name`
 
-Requires classes extending `Error` have a name ending in `Error`.
+> Requires classes extending `Error` have a name ending in `Error`.
 
-#### Example incorrect code
+#### Incorrect code
 
 ```js
 class My extends Error {}
 const Custom = class extends Error {}
 ```
 
-#### Example correct code
+#### Correct code
 
 ```js
 class MyError extends Error {}
@@ -109,42 +125,90 @@ const CustomError = class extends Error {}
 
 If you don't follow the convention of suffixing custom error classes w/ `Error`.
 
+<div align="center">
+
+[Back to index ↑][epc-rules]
+
+</div>
+
 ---
 
-### `no-explicit-return`
+### `require-new`
+
+> Requires `new` when calling error constructors (and optionally other built‑in constructors).
+
+#### Options
 
-Disallows explicit `return` statements inside class constructors.
+- `'error-only'` (default) – only error constructors (`AggregateError`, `Error`, `EvalError`, `RangeError`, `ReferenceError`, `SyntaxError`, `TypeError`, `URIError`)
+- `'builtins'` – also includes `Array`, `BigInt`, `Boolean`, `Date`, `Function`, `Map`, `Number`, `Object`, `RegExp`, `Set`, `String`, `Symbol`, `WeakMap`, `WeakSet`
 
-#### Incorrect Code
+#### Incorrect code
 
 ```js
-class A {
-    constructor() {
-        return
-    }
-}
+throw Error('boom')
+throw TypeError('bad')
 
-class B {
-    constructor() {
-        return this
-    }
-}
+// w/ builtins:
+const arr = Array(),
+      m = Map()
 ```
 
-#### Correct Code
+#### Correct code
 
 ```js
-class A {
-    constructor() {
-        this.x = 1
-    }
-}
+throw new Error('boom')
+throw new TypeError('bad')
+
+// w/ builtins:
+const arr = new Array(),
+      m = new Map()
 ```
 
 #### When not to use it
 
-If you need to return a different object from a constructor.
+If you prefer the convenience of calling built‑ins without `new` (which is allowed by the spec).
+
+<div align="center">
+
+[Back to index ↑][epc-rules]
+
+</div>
+
+---
 
 ## License
 
-Copyright © 2026 [Adam Lui](https://codeberg.org/adamlui).
+> Copyright © 2026 [Adam Lui][adamlui-cb] under the [MIT license](./docs/LICENSE.md).
+
+## Related
+
+ <!-- eslint-plugin-greasemonkey -->
+
+### [<img width=16 src="https://www.google.com/s2/favicons?domain=eslint.org&sz=16">][epg-readme] [eslint-plugin-greasemonkey][epg-readme]
+
+<details>
+
+<summary>ESLint rules for Greasemonkey userscripts.</summary><br>
+
+> [<img width=555 src="https://cdn.staticdelivr.com/gl/adamlui/eslint-plugin-greasemonkey/c9ac2985bb/assets/images/screenshots/vs-code/squiggles.png">][epg-readme]
+
+> [**Install**][epg-install] / [Readme][epg-readme] / [Report bug][epg-issues]
+
+</details>
+
+---
+
+<div align="center">
+
+[**Latest releases**][epc-releases] / [More packages by author][adamlui-npmx] / [Back to top ↑](#top)
+
+</div>
+
+[adamlui-cb]: https://codeberg.org/adamlui
+[adamlui-npmx]: https://npmx.dev/org/adamlui
+[epc-npm]: https://www.npmjs.com/package/eslint-plugin-constructors
+[epc-rules]: #rules
+[epc-releases]: https://codeberg.org/adamlui/eslint-plugin-constructors/releases
+[epg-install]: https://codeberg.org/adamlui/eslint-plugin-greasemonkey/#installation
+[epg-readme]: https://codeberg.org/adamlui/eslint-plugin-greasemonkey/#readme
+[epg-issues]: https://codeberg.org/adamlui/eslint-plugin-greasemonkey/issues/new

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-constructors",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "ESLint rules for constructor usage",
   "type": "module",
   "engines": {
@@ -12,12 +12,27 @@
     "url": "https://codeberg.org/adamlui"
   },
   "homepage": "https://codeberg.org/adamlui/eslint-plugin-constructors/#readme",
+  "bugs": {
+    "url": "https://codeberg.org/adamlui/eslint-plugin-constructors/issues",
+    "email": "support@adamlui.com"
+  },
   "license": "MIT",
+  "funding": [
+    {
+      "type": "ko-fi",
+      "url": "https://ko-fi.com/adamlui"
+    },
+    {
+      "type": "paypal",
+      "url": "https://paypal.me/adamlui"
+    }
+  ],
   "main": "src/index.js",
   "files": [
     "docs/",
     "src/"
   ],
+  "types": "src/index.d.ts",
   "scripts": {
     "prepare": "husky",
     "lint": "eslint . --cache && yamllint .",
@@ -31,6 +46,10 @@
     "bump:feat": "npm run bump:minor",
     "bump:major": "bash utils/bump.sh major"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://codeberg.org/adamlui/eslint-plugin-constructors.git"
+  },
   "keywords": [
     "code-quality",
     "constructor",
@@ -40,6 +59,9 @@
     "eslintplugin",
     "security"
   ],
+  "peerDependencies": {
+    "eslint": ">=9.0.0"
+  },
   "devDependencies": {
     "@e18e/eslint-plugin": "^0.8.0",
     "@eslint/js": "^10.0.1",
@@ -49,6 +71,7 @@
     "eslint": "^10.10.0",
     "eslint-plugin-eslint-plugin": "^7.6.2",
     "eslint-plugin-import-x": "^4.17.1",
+    "eslint-plugin-n": "^18.3.0",
     "eslint-plugin-no-secrets": "^2.3.3",
     "eslint-plugin-no-unsanitized": "^4.1.5",
     "eslint-plugin-promise": "^7.3.0",
@@ -56,8 +79,5 @@
     "globals": "^17.12.0",
     "husky": "^9.1.7",
     "yamllint-js": "^0.2.4"
-  },
-  "peerDependencies": {
-    "eslint": ">=9.0.0"
   }
 }

package/src/index.d.ts

@@ -0,0 +1,6 @@
+declare const plugin: {
+    rules: Record<string, unknown>
+    configs: { recommended: Record<string, unknown> }
+}
+
+export default plugin

package/src/rules/require-new.js

@@ -2,7 +2,7 @@ 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',
+    'Array', 'BigInt', 'Boolean', 'Date', 'Function', 'Map', 'Number', 'Object', 'RegExp', 'Set', 'String', 'Symbol',
     'WeakMap', 'WeakSet'
 ])