sindresorhus/eslint-plugin-unicorn

consistent-function-scoping should ignore jest mocks

Closed

#805 opened on Aug 4, 2020

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)JavaScript (468 forks)user submission
enhancementhelp wanted

Repository metrics

Stars
 (5,022 stars)
PR merge metrics
 (Avg merge 1d 16h) (399 merged PRs in 30d)

Description

Using jest.mock() does not work properly with consistent-function-scoping as it's not allowed to reference any out of scope variables as mocked function.

ReferenceError: /__tests__/search.spec.tsx: The module factory of `jest.mock()` is not allowed to reference any out-of-scope variables.

jest.mock("next/dynamic", () => () => "dynamic-drawer");

Contributor guide

Research direction
Locate the consistent function scoping rule implementation in rules/consistent function scoping.js. Understand how it checks for out of scope variables. The issue is that jest.mock factory functions are allowed to reference variables that are actually in scope (module level), but the rule incorrectly flags them. Look for where the rule evaluates function expressions or callbacks and add an exception for jest.mock() calls. Check existing tests for this rule to understand expected behavior.
Tech stack
javascripttypescript
Domain
toolingtesting
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
understanding of ESLint plugin developmentfamiliarity with jest.mock()
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60