airbnb/jest-wrap

docs need a note that built-in wrap plugins work with "each", not "all"

Open

#18 opened on Oct 10, 2018

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (14 forks)github user discovery
help wanted

Repository metrics

Stars
 (40 stars)
PR merge metrics
 (PR metrics pending)

Description

When attempting to override a global specified in the jest.config.js we've found it isn't overriden.

We have a set of globals which are basically stubs (in jest.config.js) e.g.

module.exports = {
    globals: {
        YJ: {
            i18n: {
                react: {}
            }
        }
    },
    ...

Then when using jest-wrap to override the i18n key in that global we attempt to do:

const mockYJ = () => ({
    i18n: {
        old_components: {
            form: "1234"
        }
    }
});

wrap()
    .withGlobal("YJ", () => mockYJ)
    .describe("Forms tests", function() {
        beforeAll(function() {
            console.log(YJ.i18n); // { react: {} } 
			// expected { i18n: { old_components: { form: "1234" } } }

But using beforeEach works as expected

wrap()
    .withGlobal("YJ", () => mockYJ)
    .describe("Forms tests", function() {
        beforeEach(function() {
            console.log(YJ.i18n); // { i18n: { old_components: { form: "1234" } } }

Contributor guide

Research direction
Investigate why withGlobal works with beforeEach but not beforeAll in jest wrap. Check if the plugin design intends to only work with per test setup or if it's a bug. Consider adding a note to the documentation clarifying this limitation.
Tech stack
javascript
Domain
testing
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Clear
Prerequisites
JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70