eslint-plugin-constructors 1.6.0 → 1.7.0

package/README.md

@@ -7,7 +7,7 @@
 <a href="https://codeberg.org/adamlui/eslint-plugin-constructors/src/branch/main/docs/LICENSE.md">
     <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>
+    <img alt="[Monthly npm downloads]" src="https://img.shields.io/npm/dm/eslint-plugin-constructors?style=for-the-badge&logo=npm&color=black"></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>
@@ -44,7 +44,7 @@ import constructors from 'eslint-plugin-constructors'
 export default [
     // other configs
     {
-        files: ['**/*.js'], plugins: { constructors },
+        files: ['**/*.{cjs,cts,js,jsx,mjs,mts,ts,tsx}'], ...constructors.configs.recommended,
         rules: {
             ...constructors.configs.recommended.rules,
             'constructors/no-explicit-return': 'off',  // selectively disable rule
@@ -60,7 +60,7 @@ export default [
 
 ### <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`:
+Add a bundled config to your `oxlint.config.*ts`:
 
 ```ts
 ...
@@ -70,7 +70,7 @@ export default defineConfig({
     overrides: [
         // other overrides
         {
-            files: ['**/*.js'],
+            files: ['**/*.{cjs,cts,js,jsx,mjs,mts,ts,tsx}'],
             jsPlugins: ['eslint-plugin-constructors'],
             rules: {
                 ...constructors.configs.recommended.rules,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-constructors",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "ESLint rules for constructor usage",
   "keywords": [
     "code-quality",
@@ -67,6 +67,7 @@
     "@eslint/json": "^2.1.1",
     "@eslint/markdown": "^7.5.1",
     "@stylistic/eslint-plugin": "^5.10.0",
+    "@typescript-eslint/parser": "^8.72.1",
     "eslint": "^10.13.0",
     "eslint-plugin-eslint-plugin": "^7.6.2",
     "eslint-plugin-import-x": "^4.17.1",
@@ -82,6 +83,7 @@
     "oxlint": "^1.89.0"
   },
   "peerDependencies": {
+    "@typescript-eslint/parser": ">=8.0.0",
     "eslint": ">=9.0.0"
   },
   "engines": {

package/src/index.d.ts

@@ -8,6 +8,7 @@ type ConfigName =
 
 interface PluginConfig {
     plugins: Record<string, unknown>
+    languageOptions: { parser?: unknown, [key: string]: unknown }
     rules: Record<string, RuleSetting>
 }
 

package/src/rules/no-constructor-bind.js

@@ -1,4 +1,5 @@
-import ast from '../utils/ast.js'
+import nodeUtils from '../utils/node.js'
+import source from '../utils/source.js'
 
 const re = { superOrArguments: /\bsuper\b|\barguments\b/u }
 
@@ -7,7 +8,7 @@ export default {
         type: 'suggestion',
         docs: {
             description: 'Disallow binding methods to `this` in class constructors',
-            category: 'Best Practices',
+            category: 'Stylistic Issues',
             recommended: true
         },
         fixable: 'code',
@@ -20,37 +21,40 @@ export default {
         return {
             AssignmentExpression(node) {
                 if (node.operator != '=') return
-                const { left, right } = node
+                const left = node.left,
+                      right = nodeUtils.unwrapTS(node.right)
                 if (left.type != 'MemberExpression' || left.computed || left.object.type != 'ThisExpression') return
                 const methodName = left.property.name ; if (!methodName) return
                 if (right.type != 'CallExpression'
                     || right.arguments.length != 1
-                    || right.arguments[0].type != 'ThisExpression'
+                    || nodeUtils.unwrapTS(right.arguments[0]).type != 'ThisExpression'
                 ) return
-                const bindCallee = right.callee
+                const bindCallee = nodeUtils.unwrapTS(right.callee)
                 if (bindCallee.type != 'MemberExpression'
                     || bindCallee.computed
                     || bindCallee.property.name != 'bind'
-                    || bindCallee.object.type != 'MemberExpression'
-                    || bindCallee.object.computed
-                    || bindCallee.object.object.type != 'ThisExpression'
-                    || bindCallee.object.property.name != methodName
-                    || !ast.isInsideConstructor(node)
+                ) return
+                const bindTarget = nodeUtils.unwrapTS(bindCallee.object)
+                if (bindTarget.type != 'MemberExpression'
+                    || bindTarget.computed
+                    || bindTarget.property.name != methodName
+                    || nodeUtils.unwrapTS(bindTarget.object).type != 'ThisExpression'
+                    || !nodeUtils.isInsideConstructor(node)
                 ) return
                 context.report({
                     node, messageId: 'unexpectedBind', data: { name: methodName },
                     fix(fixer) {
                         const stmt = node.parent ; if (stmt?.type != 'ExpressionStatement') return
-                        const classBody = ast.getEnclosingClassBody(node)
+                        const classBody = nodeUtils.getEnclosingClassBody(node)
                         if (!classBody || classBody.loc.start.line == classBody.loc.end.line) return
-                        const method = ast.findUniqueMethod(classBody, methodName)
+                        const method = nodeUtils.findUniqueMethod(classBody, methodName)
                         if (!method || re.superOrArguments.test(sourceCode.getText(method.value))) return
                         const params = method.value.params.map(param => sourceCode.getText(param)).join(', ')
                         return [
                             fixer.replaceText(method,
                                 `${sourceCode.getText(method.key)} = (${params}) => ${
                                    sourceCode.getText(method.value.body)}`),
-                            fixer.removeRange(ast.getLineAwareRemovalRange(sourceCode, stmt))
+                            fixer.removeRange(source.getLineAwareRemovalRange(sourceCode, stmt))
                         ]
                     }
                 })

package/src/rules/no-constructor-state.js

@@ -1,4 +1,5 @@
-import ast from '../utils/ast.js'
+import nodeUtils from '../utils/node.js'
+import source from '../utils/source.js'
 
 const simpleIdentifierValues = new Set(['Infinity', 'NaN', 'undefined']),
       simpleUnaryOperators = new Set(['!', '+', '-', '~', 'typeof', 'void'])
@@ -7,9 +8,13 @@ function getStateAssignment(stmt) {
     if (stmt.type != 'ExpressionStatement') return
     const assignment = stmt.expression
     if (assignment.type != 'AssignmentExpression' || assignment.operator != '=') return
-    const { left, right } = assignment
-    if (left.type != 'MemberExpression' || left.computed || left.object.type != 'ThisExpression') return
-    if (!left.property.name || !isSimpleValue(right)) return
+    const { left } = assignment
+    if (left.type != 'MemberExpression'
+        || left.computed
+        || left.object.type != 'ThisExpression'
+        || !left.property.name
+        || !isSimpleValue(nodeUtils.unwrapTS(assignment.right))
+    ) return
     return assignment
 }
 
@@ -46,7 +51,7 @@ export default {
         type: 'suggestion',
         docs: {
             description: 'Disallow assigning simple initial state to `this` in class constructors',
-            category: 'Best Practices',
+            category: 'Stylistic Issues',
             recommended: true
         },
         fixable: 'code',
@@ -74,9 +79,9 @@ export default {
                             if (!safePrefix) return
                             const closeBrace = sourceCode.getLastToken(classBody)
                             return [
-                                fixer.insertTextBefore(closeBrace, `${ast.getLineIndent(sourceCode, node)}${name} = ${
+                                fixer.insertTextBefore(closeBrace, `${source.getLineIndent(sourceCode, node)}${name} = ${
                                     sourceCode.getText(assignment.right)}\n`),
-                                fixer.removeRange(ast.getLineAwareRemovalRange(sourceCode, stmt))
+                                fixer.removeRange(source.getLineAwareRemovalRange(sourceCode, stmt))
                             ]
                         }
                     })

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

@@ -1,9 +1,11 @@
+import nodeUtils from '../utils/node.js'
+
 export default {
     meta: {
         type: 'suggestion',
         docs: {
             description: 'Require that classes extending Error have names ending in "Error"',
-            category: 'Best Practices',
+            category: 'Stylistic Issues',
             recommended: true
         },
         schema: [],
@@ -12,7 +14,8 @@ export default {
 
     create(context) {
         function checkClassNode(node) {
-            if (!node.id || !node.superClass?.name?.endsWith('Error')) return
+            const superClass = nodeUtils.unwrapTS(node.superClass)
+            if (!node.id || !superClass?.name?.endsWith('Error')) return
             checkName(node.id.name, node.id)
         }
         function checkName(name, node) {
@@ -20,11 +23,10 @@ export default {
             context.report({ node, messageId: 'endWithError' })
         }
         function checkVariableDeclarator(node) {
-            const classExpr = node.init
-            if (classExpr?.type != 'ClassExpression'
-                || !classExpr.superClass?.name?.endsWith('Error')
-                || classExpr.id // named class expression, already checked
-            ) return
+            const classExpr = nodeUtils.unwrapTS(node.init)
+            if (classExpr?.type != 'ClassExpression' || classExpr.id) return
+            const superClass = nodeUtils.unwrapTS(classExpr.superClass)
+            if (!superClass?.name?.endsWith('Error')) return
             checkName(node.id.name, node.id)
         }
         return {

package/src/rules/require-new.js

@@ -1,5 +1,8 @@
+import nodeUtils from '../utils/node.js'
 import globals from 'globals'
 
+const defaultOptions = { mode: 'throwing' }
+
 const constructors = {
     errors: new Set(Object.keys(globals.builtin).filter(name => name.endsWith('Error'))),
     lenient: new Set(['Array', 'Date', 'Function', 'Object', 'RegExp']),
@@ -25,17 +28,17 @@ export default {
                 mode: {
                     type: 'string',
                     enum: ['errors', 'throwing', 'all'],
-                    description: 'Constructor category to check (default: errors)'
+                    description: 'Constructor category to check'
                 }
             },
             additionalProperties: false
         }],
-        defaultOptions: [{ mode: 'throwing' }],
+        defaultOptions: [defaultOptions],
         messages: { requireNew: 'Use `new {{name}}()` instead of `{{name}}()`.' }
     },
 
     create(context) {
-        const mode = context.options[0]?.mode ?? 'throwing'
+        const { mode } = { ...defaultOptions, ...context.options[0] }
         function shouldReportName(name) {
             return mode == 'errors' ? constructors.errors.has(name)
                  : mode == 'throwing' ? constructors.errors.has(name) || constructors.throwing.has(name)
@@ -46,7 +49,7 @@ export default {
         return {
             CallExpression(node) {
                 if (node.new) return
-                const calleeName = node.callee.name ; if (!calleeName) return
+                const calleeName = nodeUtils.unwrapTS(node.callee)?.name ; if (!calleeName) return
                 if (shouldReportName(calleeName))
                     context.report({
                         node, messageId: 'requireNew', data: { name: calleeName },

package/src/utils/init.js

@@ -1,6 +1,7 @@
 import deprecationsUtils from './deprecations.js'
 import pkg from './pkg.js'
 import rulesUtils from './rules.js'
+import tsParser from '@typescript-eslint/parser'
 
 import noConstructorBind from '../rules/no-constructor-bind.js'
 import noConstructorState from '../rules/no-constructor-state.js'
@@ -17,9 +18,9 @@ export default {
     configs(plugin) {
         const plugins = { [namespace]: plugin },
               rules = plugin.rules,
-              createConfig = (predicate, { language, plugins: extraPlugins = {} } = {}) => ({
-                  plugins: { ...plugins, ...extraPlugins },
-                  ...(language ? { language } : {}),
+              createConfig = predicate => ({
+                  plugins,
+                  languageOptions: { parser: tsParser },
                   rules: rulesUtils.bundle(rules, predicate, namespace)
               })
         plugin.configs = {

package/src/utils/{ast.js → node.js}

@@ -1,5 +1,4 @@
-const funcTypes = new Set(['ArrowFunctionExpression', 'FunctionDeclaration', 'FunctionExpression']),
-      re = { wsOnly: /^\s*$/ }
+const funcTypes = new Set(['ArrowFunctionExpression', 'FunctionDeclaration', 'FunctionExpression'])
 
 export default {
     findUniqueMethod(classBody, methodName) {
@@ -20,19 +19,6 @@ export default {
         }
     },
 
-    getLineAwareRemovalRange(sourceCode, node) {
-        const text = sourceCode.text,
-              start = node.range[0],
-              lineStart = text.lastIndexOf('\n', start - 1) + 1
-        if (!re.wsOnly.test(text.slice(lineStart, start))) return node.range
-        return [lineStart > 0 ? lineStart - 1 : 0, node.range[1]]
-    },
-
-    getLineIndent(sourceCode, node) {
-        const line = sourceCode.lines[node.loc.start.line - 1] ?? ''
-        return line.slice(0, line.length - line.trimStart().length)
-    },
-
     isInsideConstructor(node) {
         let current = node.parent
         while (current) {
@@ -45,5 +31,10 @@ export default {
             current = current.parent
         }
         return false
+    },
+
+    unwrapTS(node) {
+        while (node?.type?.startsWith('TS') && node.expression) node = node.expression
+        return node
     }
 }

package/src/utils/source.js

@@ -0,0 +1,16 @@
+const re = { wsOnly: /^\s*$/ }
+
+export default {
+    getLineAwareRemovalRange(sourceCode, node) {
+        const text = sourceCode.text,
+              start = node.range[0],
+              lineStart = text.lastIndexOf('\n', start - 1) + 1
+        if (!re.wsOnly.test(text.slice(lineStart, start))) return node.range
+        return [lineStart > 0 ? lineStart - 1 : 0, node.range[1]]
+    },
+
+    getLineIndent(sourceCode, node) {
+        const line = sourceCode.lines[node.loc.start.line - 1] ?? ''
+        return line.slice(0, line.length - line.trimStart().length)
+    }
+}