From 6ae63745ac01e5b92750049dc024fe306ffc412a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=BCl=C3=B6p=20Kov=C3=A1cs?= Date: Thu, 9 Nov 2023 11:43:49 +0100 Subject: [PATCH 1/2] fix: export the unbound-method rule --- README.md | 19 ++++++++++++++++++- docs/rules/unbound-method.md | 2 +- src/index.ts | 6 +++--- 3 files changed, 22 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3f96e79..0c24383 100644 --- a/README.md +++ b/README.md @@ -170,10 +170,27 @@ export default [ | [require-top-level-describe](docs/rules/require-top-level-describe.md) | Enforce that all tests are in a top-level describe | | 🌐 | | | | [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-title](docs/rules/valid-title.md) | Enforce valid titles | ✅ | | 🔧 | | + +#### Requires Type Checking + +| Name | Description | 💼 | ⚠️ | 🔧 | 💡 | ❌ | +| :--------------------------------------------- | :----------------------------------------------------------- | :-- | :-- | :-- | :-- | :-- | +| [unbound-method](docs/rules/unbound-method.md) | Enforce unbound methods are called with their expected scope | | | | | | +In order to use the rules powered by TypeScript type-checking, you must be using +`@typescript-eslint/parser` & adjust your eslint config as outlined +[here](https://typescript-eslint.io/linting/typed-linting). + +Note that unlike the type-checking rules in `@typescript-eslint/eslint-plugin`, +the rules here will fallback to doing nothing if type information is not +available, meaning it's safe to include them in shared configs that could be +used on JavaScript and TypeScript projects. + +Also note that `unbound-method` depends on `@typescript-eslint/eslint-plugin`, +as it extends the original `unbound-method` rule from that plugin. + #### Credits - [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest) diff --git a/docs/rules/unbound-method.md b/docs/rules/unbound-method.md index 515c6b4..fee527d 100644 --- a/docs/rules/unbound-method.md +++ b/docs/rules/unbound-method.md @@ -6,7 +6,7 @@ -This rule extends the base [`@typescript-eslint/unbound-method`][original-rule] +This rule extends the base [`@typescript-eslint/unbound-method`][https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/unbound-method.md] rule, meaning you must depend on `@typescript-eslint/eslint-plugin` for it to work. It adds support for understanding when it's ok to pass an unbound method to `expect` calls. diff --git a/src/index.ts b/src/index.ts index 839c3fd..1091d7c 100644 --- a/src/index.ts +++ b/src/index.ts @@ -47,7 +47,7 @@ import preferTodo, { RULE_NAME as preferTodoName } from './rules/prefer-todo' import preferSpyOn, { RULE_NAME as preferSpyOnName } from './rules/prefer-spy-on' import preferComparisonMatcher, { RULE_NAME as preferComparisonMatcherName } from './rules/prefer-comparison-matcher' import preferToContain, { RULE_NAME as preferToContainName } from './rules/prefer-to-contain' -// import unboundMethod, { RULE_NAME as unboundMethodName } from './rules/unbound-method' +import unboundMethod, { RULE_NAME as unboundMethodName } from './rules/unbound-method' const createConfig = (rules: Record) => ({ plugins: ['vitest'], @@ -165,8 +165,8 @@ export default { [preferTodoName]: preferTodo, [preferSpyOnName]: preferSpyOn, [preferComparisonMatcherName]: preferComparisonMatcher, - [preferToContainName]: preferToContain - // [unboundMethodName]: unboundMethod + [preferToContainName]: preferToContain, + [unboundMethodName]: unboundMethod }, configs: { all: createConfig(allRules), From 447c30d3ecc46fa0ce48f62cab9e5f4f2e6156d0 Mon Sep 17 00:00:00 2001 From: Verite Mugabo Date: Thu, 9 Nov 2023 23:00:53 -0500 Subject: [PATCH 2/2] chore(tests): enable skippd tests --- tests/unbound-method.test.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/unbound-method.test.ts b/tests/unbound-method.test.ts index 3319d38..31f6c2f 100644 --- a/tests/unbound-method.test.ts +++ b/tests/unbound-method.test.ts @@ -32,7 +32,7 @@ ruleTester.run('unbound-method', unboundMethod, { logArrowBound(); logManualBind();`, - skip: true + skip: false } ], invalid: [ @@ -48,7 +48,7 @@ ruleTester.run('unbound-method', unboundMethod, { Promise.resolve().then(console.log); `, - skip: true, + skip: false, errors: [ { line: 10,