Skip to content

Commit

Permalink
Revert "fix: export the "unbound-method" rule (#286)"
Browse files Browse the repository at this point in the history
This reverts commit 62240e5.
  • Loading branch information
veritem authored Nov 12, 2023
1 parent 211ca12 commit cd947d4
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 24 deletions.
19 changes: 1 addition & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,27 +170,10 @@ 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 || | | |

#### Requires Type Checking

| Name | Description | 💼 | ⚠️ | 🔧 | 💡 ||
| :--------------------------------------------- | :----------------------------------------------------------- | :-- | :-- | :-- | :-- | :-- |
| [unbound-method](docs/rules/unbound-method.md) | Enforce unbound methods are called with their expected scope | | | | | |
| [valid-title](docs/rules/valid-title.md) | Enforce valid titles || | 🔧 | |

<!-- end auto-generated rules list -->

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)
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/unbound-method.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<!-- end auto-generated rule header -->

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]
This rule extends the base [`@typescript-eslint/unbound-method`][original-rule]
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.
Expand Down
6 changes: 3 additions & 3 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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<string, string>) => ({
plugins: ['vitest'],
Expand Down Expand Up @@ -165,8 +165,8 @@ export default {
[preferTodoName]: preferTodo,
[preferSpyOnName]: preferSpyOn,
[preferComparisonMatcherName]: preferComparisonMatcher,
[preferToContainName]: preferToContain,
[unboundMethodName]: unboundMethod
[preferToContainName]: preferToContain
// [unboundMethodName]: unboundMethod
},
configs: {
all: createConfig(allRules),
Expand Down
4 changes: 2 additions & 2 deletions tests/unbound-method.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ ruleTester.run('unbound-method', unboundMethod, {
logArrowBound();
logManualBind();`,
skip: false
skip: true
}
],
invalid: [
Expand All @@ -48,7 +48,7 @@ ruleTester.run('unbound-method', unboundMethod, {
Promise.resolve().then(console.log);
`,
skip: false,
skip: true,
errors: [
{
line: 10,
Expand Down

0 comments on commit cd947d4

Please sign in to comment.