test: move the confirm mock code to its own file

[petebacondarwin]

This commit moves the mocking code for the confirm() helper out of the main test file and into a helper file.

Apart from keeping the main test file simpler, it also will allow reuse in other test files in the future.

NOTE that the following line must still appear in the test file to ensure the module gets mocked before it is first used.

jest.mock("../dialogs");

[changeset-bot]

⚠️ No Changeset found

Latest commit: 4a4df2a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[threepointone]

This can probably be confusing in the future. Suggestion - create a setupFilesAfterEnv.js (https://jestjs.io/docs/configuration#setupfilesafterenv-array) move jest.mock('../dialogs') and confirm.mockImplementation(() => { throw new ... }); into it (so confirm() is mocked for all test files, and probably prompt() too at some point). This removes the need to add jest.mock("../dialogs"); in each file, and mock-confirm.ts contains just the mockConfirm export.

[petebacondarwin]

This can probably be confusing in the future. Suggestion - create a setupFilesAfterEnv.js (https://jestjs.io/docs/configuration#setupfilesafterenv-array) move jest.mock('../dialogs') and confirm.mockImplementation(() => { throw new ... }); into it (so confirm() is mocked for all test files, and probably prompt() too at some point). This removes the need to add jest.mock("../dialogs"); in each file, and mock-confirm.ts contains just the mockConfirm export.

Ooh! TIL...

[threepointone]

tentatively approving, with a couple of suggestions.

[threepointone]

does this need to be exported?

[petebacondarwin]

I am not sure if it "has" to be exported. But since it is used as the type of a parameter of an exported function it seems the right thing to do...

[threepointone]

Oh, is this because if someone wants to construct the arguments separately before passing it to mockConfirm/mockPrompt, they'll have the type to use? Ok, I can buy that.