eslint-plugin-constructors 1.2.0 → 1.2.2

package/README.md

@@ -22,7 +22,12 @@ npm i -D eslint-plugin-constructors
 
 ---
 
-## Usage
+<h2 id="usage">
+    Usage
+    <a title="Copy section URL" target="_blank"
+       href="https://copy-to-clipboard.onrender.com/copy/https%3A%2F%2Fcodeberg.org%2Fadamlui%2Feslint-plugin-constructors%2F%23usage">
+        <img height=17 width=22 alt="[Copy section URL]" src="https://api.iconify.design/mdi/content-copy.svg?color=%23cccccc" align="bottom"></a>
+</h2>
 
 Add `constructors` to your flat config:
 
@@ -59,44 +64,63 @@ export default [
 
 ---
 
-## Supported rules
+<h2 id="supported-rules">
+    Supported rules
+    <a title="Copy section URL" target="_blank"
+       href="https://copy-to-clipboard.onrender.com/copy/https%3A%2F%2Fcodeberg.org%2Fadamlui%2Feslint-plugin-constructors%2F%23supported-rules">
+        <img height=17 width=22 alt="[Copy section URL]" src="https://api.iconify.design/mdi/content-copy.svg?color=%23cccccc" align="bottom"></a>
+</h2>
 
 | ID | Description | Auto-fixable | Recommended |
 | --- | --- | :-: | :-: |
 | [`no-explicit-return`](#no-explicit-return) | Disallows explicit `return` statements in class constructors | ❌ | ✅ |
 | [`require-error-subclass-name`](#require-error-subclass-name) | Requires classes extending `Error` to have names ending in `Error` | ❌ | ✅ |
-| [`require-new`](#require-new-auto-fixable) | Requires `new` when calling error constructors | ✅ | ✅ |
+| [`require-new`](#require-new) | Requires `new` when calling error constructors | ✅ | ✅ |
 
 ---
 
-### `no-explicit-return`
+<h3 id="no-explicit-return">
+    <code>no-explicit-return</code>
+    <a title="Included in recommended config" href="#usage">
+        <img height=18 alt="[Recommended]" src="https://img.shields.io/badge/Recommended-f1f20a?style=flat-square" align="middle"></a>
+    <a title="Copy rule URL" target="_blank" 
+       href="https://copy-to-clipboard.onrender.com/copy/https%3A%2F%2Fcodeberg.org%2Fadamlui%2Feslint-plugin-constructors%2F%23no-explicit-return">
+        <img height=16 width=21 alt="[Copy rule URL]" src="https://api.iconify.design/mdi/content-copy.svg?color=%23cccccc" align="middle"></a>
+</h3>
 
 > Disallows explicit `return` statements inside class constructors.
 
 #### Incorrect code
 
-```js
-class A {
-    constructor() {
-        return
-    }
-}
-
-class B {
-    constructor() {
-        return this
-    }
-}
+```diff
+  class A {
+      constructor() {
+!         return
+      }
+  }
+
+  class B {
+      constructor() {
+!         return this
+      }
+  }
 ```
 
 #### Correct code
 
-```js
-class A {
-    constructor() {
-        this.x = 1
-    }
-}
+```diff
+  class A {
+      constructor() {
+-         return
++         this.x = 1
+      }
+
+  class B {
+      constructor() {
+-         return this
++         this.x = 1
+      }
+  }
 ```
 
 #### When not to use it
@@ -111,22 +135,31 @@ If you need to return a different object from a constructor.
 
 ---
 
-### `require-error-subclass-name`
+<h3 id="require-error-subclass-name">
+    <code>require-error-subclass-name</code>
+    <a title="Included in recommended config" href="#usage">
+        <img height=18 alt="[Recommended]" src="https://img.shields.io/badge/Recommended-f1f20a?style=flat-square" align="middle"></a>
+    <a title="Copy rule URL" target="_blank" 
+       href="https://copy-to-clipboard.onrender.com/copy/https%3A%2F%2Fcodeberg.org%2Fadamlui%2Feslint-plugin-constructors%2F%23require-error-subclass-name">
+        <img height=16 width=21 alt="[Copy rule URL]" src="https://api.iconify.design/mdi/content-copy.svg?color=%23cccccc" align="middle"></a>
+</h3>
 
 > Requires classes extending `Error` have a name ending in `Error`.
 
 #### Incorrect code
 
-```js
-class My extends Error {}
-const Custom = class extends Error {}
+```diff
+! class My extends Error {}
+! const Custom = class extends Error {}
 ```
 
 #### Correct code
 
-```js
-class MyError extends Error {}
-const CustomError = class extends Error {}
+```diff
+- class My extends Error {}
+- const Custom = class extends Error {}
++ class MyError extends Error {}
++ const CustomError = class extends Error {}
 ```
 
 #### When not to use it
@@ -141,7 +174,16 @@ If you don't follow the convention of suffixing custom error classes w/ `Error`.
 
 ---
 
-### `require-new` (auto-fixable)
+<h3 id="require-new">
+    <code>require-new</code>
+    <a title="Included in recommended config" href="#usage">
+        <img height=18 alt="[Recommended]" src="https://img.shields.io/badge/Recommended-f1f20a?style=flat-square" align="middle"></a>
+    <a title="Accepts eslint --fix" target="_blank" href="https://eslint.org/docs/latest/use/command-line-interface#--fix">
+        <img height=18 alt="[Auto-fixable]" src="https://img.shields.io/badge/Auto--fixable-e8357a?style=flat-square" align="middle"></a>
+    <a title="Copy rule URL" target="_blank" 
+       href="https://copy-to-clipboard.onrender.com/copy/https%3A%2F%2Fcodeberg.org%2Fadamlui%2Feslint-plugin-constructors%2F%23require-new">
+        <img height=16 width=21 alt="[Copy rule URL]" src="https://api.iconify.design/mdi/content-copy.svg?color=%23cccccc" align="middle"></a>
+</h3>
 
 > Requires `new` when calling error constructors (and optionally other built-ins).
 
@@ -155,25 +197,31 @@ Excluded: `Boolean`, `Number`, `String` (calling w/ `new` returns wrapper object
 
 #### Incorrect code
 
-```js
-// 'errors' (default)
-throw Error('boom')
+```diff
+/* eslint constructors/require-new: ['error', 'errors'] */
+! throw Error('boom')
 
-// 'throwing'
-const m = Map()
+/* eslint constructors/require-new: ['error', 'throwing'] */
+! const m = Map()
 
-// 'all'
-const arr = Array()
+/* eslint constructors/require-new: ['error', 'all'] */
+! const arr = Array()
 ```
 
 #### Correct code
 
-```js
-throw new Error('boom')
+```diff
+/* eslint constructors/require-new: ['error', 'errors'] */
+- throw Error('boom')
++ throw new Error('boom')
 
-const m = new Map()
+/* eslint constructors/require-new: ['error', 'throwing'] */
+- const m = Map()
++ const m = new Map()
 
-const arr = new Array()
+/* eslint constructors/require-new: ['error', 'all'] */
+- const arr = Array()
++ const arr = new Array()
 ```
 
 #### When not to use it
@@ -188,22 +236,22 @@ If you prefer calling built-ins w/o `new` (which the runtime allows for some of
 
 ---
 
-## Shield
+## Shield embed
 
 <a href="https://codeberg.org/adamlui/eslint-plugin-constructors/#readme">
-    <img height=32 alt="[Linted by eslint-plugin-constructors]" src="https://img.shields.io/badge/Linted_by-eslint--plugin--constructors-4b32c3?logo=eslint&logoColor=white&labelColor=464646&style=for-the-badge"></a>
+    <img height=32 alt="[Linted by eslint-plugin-constructors]" src="https://img.shields.io/badge/Linted_by-eslint--plugin--constructors-black?logo=eslint&logoColor=white&labelColor=4B32C3&style=for-the-badge"></a>
 
 #### HTML
 
 ```html
 <a href="https://codeberg.org/adamlui/eslint-plugin-constructors/#readme">
-    <img height=32 alt="[Linted by eslint-plugin-constructors]" src="https://img.shields.io/badge/Linted_by-eslint--plugin--constructors-4b32c3?logo=eslint&logoColor=white&labelColor=464646&style=for-the-badge"></a>
+    <img height=32 alt="[Linted by eslint-plugin-constructors]" src="https://img.shields.io/badge/Linted_by-eslint--plugin--constructors-black?logo=eslint&logoColor=white&labelColor=4B32C3&style=for-the-badge"></a>
 ```
 
 #### Markdown
 
 ```md
-[![Linted by eslint-plugin-constructors](https://img.shields.io/badge/Linted_by-eslint--plugin--constructors-4b32c3?logo=eslint&logoColor=white&labelColor=464646&style=for-the-badge)](https://codeberg.org/adamlui/eslint-plugin-constructors/#readme)
+[![Linted by eslint-plugin-constructors](https://img.shields.io/badge/Linted_by-eslint--plugin--constructors-black?logo=eslint&logoColor=white&labelColor=4B32C3&style=for-the-badge)](https://codeberg.org/adamlui/eslint-plugin-constructors/#readme)
 ```
 
 ---
@@ -214,7 +262,7 @@ If you prefer calling built-ins w/o `new` (which the runtime allows for some of
 
 <details>
 
-<summary>Copyright © 2026 <a href="https://codeberg.org/adamlui">Adam Lui</a> under the <a href="https://codeberg.org/adamlui/eslint-plugin-constructors/src/branch/main/docs/LICENSE.md">MIT license</a>.</summary><br>
+<summary>Copyright © 2026 <a href="https://codeberg.org/adamlui"><b>Adam Lui</b></a> under the <a href="https://codeberg.org/adamlui/eslint-plugin-constructors/src/branch/main/docs/LICENSE.md"><b>MIT license</b></a>.</summary><br>
 
 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:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-constructors",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "ESLint rules for constructor usage",
   "type": "module",
   "engines": {

package/src/data/deprecations.js

@@ -0,0 +1,3 @@
+export const options = { 'require-new': { 'error-only': 'errors' }} // 2026-9-13
+
+export default { options }

package/src/index.js

@@ -10,6 +10,9 @@ const plugin = {
     }
 }
 
+for (const [ruleId, rule] of Object.entries(plugin.rules))
+    rule.meta.docs.url = `https://codeberg.org/adamlui/eslint-plugin-constructors/#${ruleId}`
+
 plugin.configs = {
     recommended: {
         plugins: { constructors: plugin },

package/src/rules/require-new.js

@@ -1,3 +1,4 @@
+import deprecations from '../data/deprecations.js'
 import globals from 'globals'
 
 const errorConstructors = new Set(Object.keys(globals.builtin).filter(name => name.endsWith('Error')))
@@ -37,10 +38,15 @@ export default {
     },
 
     create(context) {
-        const rawMode = context.options[0] || 'errors'
-        let mode = rawMode, deprecation
-        if (rawMode == 'error-only') { mode = 'errors' ; deprecation = { old: 'error-only', new: 'errors' }}
-        else if (rawMode == 'builtins') mode = 'legacy-builtins'
+        const optionAliases = deprecations.options['require-new'] || {},
+              rawMode = context.options[0] || 'errors'
+        /* eslint-disable security/detect-object-injection */
+        let mode = optionAliases[rawMode] || rawMode, deprecation
+        if (optionAliases[rawMode])
+            deprecation = { old: rawMode, new: optionAliases[rawMode] }
+        /* eslint-enable security/detect-object-injection */
+        else if (rawMode == 'builtins')
+            mode = 'legacy-builtins'
 
         function shouldReportName(name) {
             return mode == 'errors' ? errorConstructors.has(name)