eslint-plugin-constructors 1.5.0 → 1.6.0

package/README.md

@@ -8,8 +8,8 @@
     <img alt="[License: MIT]" src="https://img.shields.io/badge/License-MIT-f1f20a.svg?logo=internetarchive&logoColor=white&labelColor=464646&style=for-the-badge"></a>
 <a target="_blank" href="https://getnpmstats.com/?package=eslint-plugin-constructors&range=last-year&interval=monthly">
     <img src="https://img.shields.io/npm/dm/eslint-plugin-constructors?style=for-the-badge&logo=npm&color=black"></a>
-<a target="_blank" href="https://eslint.org/">
-    <img alt="[Requires ESLint >=9.0.0]" src="https://img.shields.io/badge/Requires-ESLint_%3E%3D9.0.0-4B32C3?style=for-the-badge&logo=eslint"></a>
+<a href="#usage">
+    <img alt="[Supports ESLint >=9.0.0 / Oxlint >=1.65.0]" src="https://img.shields.io/badge/Supports-ESLint_%3E%3D9.0.0_%2F_Oxlint_%3E%3D1.65.0-4B32C3?style=for-the-badge&logo=eslint"></a>
 <br><br>
 
 ESLint rules to enforce best practices for constructor usage.
@@ -33,6 +33,8 @@ npm i -D eslint-plugin-constructors
     Usage
 </h2>
 
+### <img height=15 width=auto src="https://www.google.com/s2/favicons?domain=eslint.org&sz=64"> ESLint
+
 Add a bundled config to your `eslint.config.*js`:
 
 ```js
@@ -52,12 +54,44 @@ export default [
 ]
 ```
 
-Available bundles: `recommended`, `problem` (deterministic bugs only)
-
 **Note:** Rule config is either a severity string (`'off'`, `'warn'`, `'error'`) or an array `[severity, options]` when the rule accepts options.
 
 ---
 
+### <img height=15 width=auto src="https://www.google.com/s2/favicons?domain=oxc.rs&sz=64"> Oxlint
+
+Add a bundled config to your `oxlint.config.ts`:
+
+```ts
+...
+import constructors from 'eslint-plugin-constructors'
+
+export default defineConfig({
+    overrides: [
+        // other overrides
+        {
+            files: ['**/*.js'],
+            jsPlugins: ['eslint-plugin-constructors'],
+            rules: {
+                ...constructors.configs.recommended.rules,
+                'constructors/no-explicit-return': 'allow',  // selectively disable rule
+                'constructors/require-new': ['deny', { mode: 'throwing' }]  // selectively tweak rule
+            }
+        }
+    ]
+})
+```
+
+**Note:** Rule config is either a severity string (`'allow'`, `'warn'`, `'deny'`) or an array `[severity, options]` when the rule accepts options.
+
+**Note:** Oxlint is typically **6-20× faster than ESLint** w/ this plugin (due to its Rust core and parallel file processing).
+
+---
+
+*Available bundles:* `recommended`, `problem` (deterministic bugs only), `stylistic`
+
+---
+
 <h2 id="supported-rules">
     <img height=30 width=27 align="top" src="https://api.iconify.design/mdi/format-list-checks.svg?color=%232b2b2a">
     Supported rules
@@ -65,8 +99,6 @@ Available bundles: `recommended`, `problem` (deterministic bugs only)
 
 <h3 id="no-constructor-bind">
     <code>no-constructor-bind</code>
-    <a title="Introduced in recent release" target="_blank" href="https://codeberg.org/adamlui/eslint-plugin-constructors/releases/tag/v1.5.0">
-        <img height=16 align="middle" src="https://api.iconify.design/mdi/sprout.svg?color=%234a4a4a"></a>
     <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">
@@ -129,8 +161,6 @@ If you target environments that do not support class fields.
 
 <h3 id="no-constructor-state">
     <code>no-constructor-state</code>
-    <a title="Introduced in recent release" target="_blank" href="https://codeberg.org/adamlui/eslint-plugin-constructors/releases/tag/v1.5.0">
-        <img height=16 align="middle" src="https://api.iconify.design/mdi/sprout.svg?color=%234a4a4a"></a>
     <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">

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-constructors",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "ESLint rules for constructor usage",
   "keywords": [
     "code-quality",
@@ -57,29 +57,29 @@
     "demo": "eslint demo",
     "lint": "pre-commit run",
     "lint:all": "pre-commit run --all-files",
-    "test": "node tests/run.js"
+    "test": "node tests/run"
   },
   "dependencies": {
     "globals": "^17.13.0"
   },
   "devDependencies": {
     "@e18e/eslint-plugin": "^0.8.1",
-    "@eslint/js": "^10.0.1",
     "@eslint/json": "^2.1.1",
     "@eslint/markdown": "^7.5.1",
     "@stylistic/eslint-plugin": "^5.10.0",
-    "eslint": "^10.12.0",
+    "eslint": "^10.13.0",
     "eslint-plugin-eslint-plugin": "^7.6.2",
     "eslint-plugin-import-x": "^4.17.1",
-    "eslint-plugin-n": "^18.4.1",
+    "eslint-plugin-n": "^18.5.0",
     "eslint-plugin-no-secrets": "^2.3.3",
     "eslint-plugin-no-unsanitized": "^4.1.5",
-    "eslint-plugin-package-json": "^1.10.1",
+    "eslint-plugin-package-json": "^1.11.0",
     "eslint-plugin-promise": "^7.3.0",
     "eslint-plugin-regexp": "^3.3.1",
     "eslint-plugin-security": "^4.2.0",
     "eslint-plugin-sonarjs": "^4.2.2",
-    "eslint-plugin-woodpecker": "^1.0.1"
+    "eslint-plugin-woodpecker": "^1.1.1",
+    "oxlint": "^1.89.0"
   },
   "peerDependencies": {
     "eslint": ">=9.0.0"

package/src/index.d.ts

@@ -4,6 +4,7 @@ type RuleSetting = RuleSeverity | [RuleSeverity, ...unknown[]]
 type ConfigName =
     | 'recommended'
     | 'problem'
+    | 'stylistic'
 
 interface PluginConfig {
     plugins: Record<string, unknown>
@@ -23,6 +24,7 @@ interface PluginRule {
 }
 
 declare const plugin: {
+    meta: { name: string }
     rules: Record<string, PluginRule>
     configs: Record<ConfigName, PluginConfig>
 }

package/src/utils/deprecations.js

@@ -1,4 +1,4 @@
-/* eslint-disable security/detect-object-injection */
+// oxlint-disable security/detect-object-injection
 
 export default {
     initAlias(plugin, [ruleId, { default: defaultOpts, wrapKey, renames = {} }]) {

package/src/utils/init.js

@@ -1,4 +1,5 @@
 import deprecationsUtils from './deprecations.js'
+import pkg from './pkg.js'
 import rulesUtils from './rules.js'
 
 import noConstructorBind from '../rules/no-constructor-bind.js'
@@ -9,7 +10,8 @@ import requireNew from '../rules/require-new.js'
 
 import deprecations from '../data/deprecations.js'
 
-const namespace = 'constructors'
+const pkgName = pkg.getName(),
+      namespace = pkgName.replace(/^@[^/]+\//, '').replace(/^eslint-plugin-/, '')
 
 export default {
     configs(plugin) {
@@ -22,7 +24,8 @@ export default {
               })
         plugin.configs = {
             recommended: createConfig(rule => rule.meta.docs.recommended),
-            problem: createConfig(rule => rule.meta.type == 'problem')
+            problem: createConfig(rule => rule.meta.type == 'problem'),
+            stylistic: createConfig(rule => rule.meta.docs.category == 'Stylistic Issues')
         }
     },
 
@@ -31,7 +34,7 @@ export default {
             deprecationsUtils.initAlias(plugin, entry)
     },
 
-    plugin() { return { rules: {}, configs: {} }},
+    plugin() { return { meta: { name: pkgName }, rules: {}, configs: {} }},
 
     rules(plugin) {
         plugin.rules = {
@@ -42,6 +45,6 @@ export default {
             'require-new': requireNew
         }
         for (const [ruleId, rule] of Object.entries(plugin.rules))
-            rule.meta.docs.url = `https://codeberg.org/adamlui/eslint-plugin-${namespace}/#${ruleId}`
+            rule.meta.docs.url = `https://codeberg.org/adamlui/${pkgName}/#${ruleId}`
     }
 }

package/src/utils/pkg.js

@@ -0,0 +1,21 @@
+import { fileURLToPath } from 'node:url'
+import fs from 'node:fs'
+import path from 'node:path'
+
+export default {
+    getName() { // oxlint-disable security/detect-non-literal-fs-filename
+        let current = path.dirname(fileURLToPath(import.meta.url))
+        while (current) {
+            const pkgPath = path.join(current, 'package.json')
+            if (fs.existsSync(pkgPath))
+                try {
+                    const { name } = JSON.parse(fs.readFileSync(pkgPath, 'utf8'))
+                    if (name) return name
+                } catch { /* malformed, keep walking */ }
+            const parent = path.dirname(current)
+            if (parent === current) return null
+            current = parent
+        }
+        return null
+    } // oxlint-enable security/detect-non-literal-fs-filename
+}