feat(unbound-method): re-enable rule (#883)

* feat(unbound-method): re-enable rule

* chore: sort rules

* chore: update lockfile

* docs: add unbound-method rule to docs

* docs: update rule docs

* revert: update rule docs

Author: FloEdelmann

README.md

@@ -263,6 +263,7 @@ export default defineConfig({
 | [require-test-timeout](docs/rules/require-test-timeout.md)                                                               | require tests to declare a timeout                                                              |     |       | 🌐  |     |     |     |     |
 | [require-to-throw-message](docs/rules/require-to-throw-message.md)                                                       | require toThrow() to be called with an error message                                            |     | 🌐    |     |     |     |     |     |
 | [require-top-level-describe](docs/rules/require-top-level-describe.md)                                                   | enforce that all tests are in a top-level describe                                              |     | 🌐    |     |     |     |     |     |
+| [unbound-method](docs/rules/unbound-method.md)                                                                           | enforce unbound methods are called with their expected scope                                    |     | 🌐    |     |     |     | 💭  |     |
 | [valid-describe-callback](docs/rules/valid-describe-callback.md)                                                         | enforce valid describe callback                                                                 | ✅  | 🌐    |     |     |     |     |     |
 | [valid-expect](docs/rules/valid-expect.md)                                                                               | enforce valid `expect()` usage                                                                  | ✅  | 🌐    |     | 🔧  |     |     |     |
 | [valid-expect-in-promise](docs/rules/valid-expect-in-promise.md)                                                         | require promises that have expectations in their chain to be valid                              | ✅  | 🌐    |     |     |     |     |     |

docs/rules/unbound-method.md

@@ -1,8 +1,10 @@
-# Enforce unbound methods are called with their expected scope (`vitest/unbound-method`)
+# vitest/unbound-method
+
+📝 Enforce unbound methods are called with their expected scope.
 
 ⚠️ This rule _warns_ in the 🌐 `all` config.
 
-💭 This rule requires type information.
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
 <!-- end auto-generated rule header -->
 

package.json

@@ -72,6 +72,7 @@
     "vitest": "^4.0.18"
   },
   "peerDependencies": {
+    "@typescript-eslint/eslint-plugin": "*",
     "eslint": ">=8.57.0",
     "typescript": ">=5.0.0",
     "vitest": "*"
@@ -82,6 +83,9 @@
     },
     "vitest": {
       "optional": true
+    },
+    "@typescript-eslint/eslint-plugin": {
+      "optional": true
     }
   },
   "packageManager": "pnpm@10.18.3+sha512.bbd16e6d7286fd7e01f6b3c0b3c932cda2965c06a908328f74663f10a9aea51f1129eea615134bf992831b009eabe167ecb7008b597f40ff9bc75946aadfb08d",

pnpm-lock.yaml

@@ -8,13 +8,9 @@ import path from 'node:path'
 import url from 'node:url'
 import prettier from 'prettier'
 
-const IGNORED_RULE_FILES = ['unbound-method.ts']
-
 const rulesDir = path.resolve(import.meta.dirname, '../src/rules')
 const files = await fs.readdir(rulesDir)
-const ruleFiles = files.filter(
-  (fileName) => !['index.ts', ...IGNORED_RULE_FILES].includes(fileName),
-)
+const ruleFiles = files.filter((fileName) => fileName !== 'index.ts')
 
 const imports = []
 const rules = new Map<string, string>()

scripts/export-rules.ts

@@ -23,9 +23,9 @@ const createConfigLegacy = (rules: Record<string, string>) => ({
 })
 
 const allRules = {
+  'consistent-each-for': 'warn',
   'consistent-test-filename': 'warn',
   'consistent-test-it': 'warn',
-  'consistent-each-for': 'warn',
   'consistent-vitest-vi': 'warn',
   'expect-expect': 'warn',
   'hoisted-apis-on-top': 'warn',
@@ -90,25 +90,26 @@ const allRules = {
   'prefer-to-have-length': 'warn',
   'prefer-todo': 'warn',
   'prefer-vi-mocked': 'warn',
+  'require-awaited-expect-poll': 'warn',
   'require-hook': 'warn',
   'require-local-test-context-for-concurrent-snapshots': 'warn',
   'require-mock-type-parameters': 'warn',
+  'require-test-timeout': 'off',
   'require-to-throw-message': 'warn',
   'require-top-level-describe': 'warn',
+  'unbound-method': 'warn',
   'valid-describe-callback': 'warn',
   'valid-expect-in-promise': 'warn',
   'valid-expect': 'warn',
   'valid-title': 'warn',
-  'require-awaited-expect-poll': 'warn',
-  'require-test-timeout': 'off',
 } as const satisfies RuleList
 
 const recommendedRules = {
   'expect-expect': 'error',
+  'no-commented-out-tests': 'error',
   'no-conditional-expect': 'error',
   'no-disabled-tests': 'warn',
   'no-focused-tests': 'error',
-  'no-commented-out-tests': 'error',
   'no-identical-title': 'error',
   'no-import-node-test': 'error',
   'no-interpolation-in-snapshots': 'error',

src/index.ts

@@ -28,6 +28,7 @@ import noRestrictedViMethods from './no-restricted-vi-methods'
 import noStandaloneExpect from './no-standalone-expect'
 import noTestPrefixes from './no-test-prefixes'
 import noTestReturnStatement from './no-test-return-statement'
+import noUnneededAsyncExpectFunction from './no-unneeded-async-expect-function'
 import paddingAroundAfterAllBlocks from './padding-around-after-all-blocks'
 import paddingAroundAfterEachBlocks from './padding-around-after-each-blocks'
 import paddingAroundAll from './padding-around-all'
@@ -63,23 +64,23 @@ import preferToBeObject from './prefer-to-be-object'
 import preferToBeTruthy from './prefer-to-be-truthy'
 import preferToBe from './prefer-to-be'
 import preferToContain from './prefer-to-contain'
+import preferToHaveBeenCalledTimes from './prefer-to-have-been-called-times'
 import preferToHaveLength from './prefer-to-have-length'
 import preferTodo from './prefer-todo'
 import preferViMocked from './prefer-vi-mocked'
 import requireAwaitedExpectPoll from './require-awaited-expect-poll'
 import requireHook from './require-hook'
-import requireTestTimeout from './require-test-timeout'
 import requireLocalTestContextForConcurrentSnapshots from './require-local-test-context-for-concurrent-snapshots'
 import requireMockTypeParameters from './require-mock-type-parameters'
+import requireTestTimeout from './require-test-timeout'
 import requireToThrowMessage from './require-to-throw-message'
 import requireTopLevelDescribe from './require-top-level-describe'
+import unboundMethod from './unbound-method'
 import validDescribeCallback from './valid-describe-callback'
 import validExpectInPromise from './valid-expect-in-promise'
 import validExpect from './valid-expect'
 import validTitle from './valid-title'
 import warnTodo from './warn-todo'
-import noUnneededAsyncExpectFunction from './no-unneeded-async-expect-function'
-import preferToHaveBeenCalledTimes from './prefer-to-have-been-called-times'
 
 export const rules = {
   'consistent-each-for': consistentEachFor,
@@ -153,12 +154,13 @@ export const rules = {
   'prefer-vi-mocked': preferViMocked,
   'require-awaited-expect-poll': requireAwaitedExpectPoll,
   'require-hook': requireHook,
-  'require-test-timeout': requireTestTimeout,
   'require-local-test-context-for-concurrent-snapshots':
     requireLocalTestContextForConcurrentSnapshots,
   'require-mock-type-parameters': requireMockTypeParameters,
+  'require-test-timeout': requireTestTimeout,
   'require-to-throw-message': requireToThrowMessage,
   'require-top-level-describe': requireTopLevelDescribe,
+  'unbound-method': unboundMethod,
   'valid-describe-callback': validDescribeCallback,
   'valid-expect-in-promise': validExpectInPromise,
   'valid-expect': validExpect,

src/rules/index.ts

@@ -1,10 +1,13 @@
+import { createRequire } from 'node:module'
 import { AST_NODE_TYPES, TSESLint, TSESTree } from '@typescript-eslint/utils'
 import { createEslintRule, getAccessorValue, isIdentifier } from '../utils'
 import {
   findTopMostCallExpression,
   parseVitestFnCall,
 } from '../utils/parse-vitest-fn-call'
 
+const require = createRequire(import.meta.url)
+
 const RULE_NAME = 'unbound-method'
 
 const toThrowMatchers = [
@@ -26,17 +29,21 @@ export type Options = [Config]
 
 const baseRule = (() => {
   try {
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
     const TSESLintPlugin = require('@typescript-eslint/eslint-plugin')
 
     return TSESLintPlugin.rules['unbound-method'] as TSESLint.RuleModule<
       MESSAGE_IDS,
       Options
     >
-  } catch (e: unknown) {
-    const error = e as { code: string }
-
-    if (error.code === 'MODULE_NOT_FOUND') return null
+  } catch (error: unknown) {
+    const errorCode =
+      typeof error === 'object' && error !== null && 'code' in error
+        ? error.code
+        : undefined
+
+    if (errorCode === 'MODULE_NOT_FOUND' || errorCode === 'ERR_REQUIRE_ESM') {
+      return null
+    }
 
     throw error
   }