miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(testing): moved the cleanup func calls into the func that be export default (#27268)

Browse Source 
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->
The cleanup function is called **immediately** when the file is imported
if it is placed outside of the exported function in jest global setup
file.

<img width="1202" alt="Screenshot 2024-08-02 at 7 45 12 AM"
src="https://github.com/user-attachments/assets/caa9cc2b-9212-4c91-b557-d44e6ba7ae05">

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->
The cleanup func in jest global setup file, should be call inside the
default export function.

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

N/A!
This commit is contained in:
Arthur 2024-08-10 01:44:00 +08:00 committed by GitHub
parent ac02118327
commit 264f727a8f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/generated/packages/jest/documents/overview.md
View File

@ -274,9 +274,10 @@ const cleanupRegisteredPaths = registerTsProject('./tsconfig.base.json');
import { yourFancyFunction } from '@some-org/my-util-library'; import { yourFancyFunction } from '@some-org/my-util-library';
export default async function () { export default async function () {
yourFancyFunction(); yourFancyFunction();
// make sure to run the clean up!
cleanupRegisteredPaths();
} }
// make sure to run the clean up!
cleanupRegisteredPaths();
``` ```
If you're using `@swc/jest` and a global setup/teardown file, you have to set the `noInterop: false` and use dynamic imports within the setup function: If you're using `@swc/jest` and a global setup/teardown file, you have to set the `noInterop: false` and use dynamic imports within the setup function:

5
docs/shared/packages/jest/jest-plugin.md
View File

@ -274,9 +274,10 @@ const cleanupRegisteredPaths = registerTsProject('./tsconfig.base.json');
import { yourFancyFunction } from '@some-org/my-util-library'; import { yourFancyFunction } from '@some-org/my-util-library';
export default async function () { export default async function () {
yourFancyFunction(); yourFancyFunction();
// make sure to run the clean up!
cleanupRegisteredPaths();
} }
// make sure to run the clean up!
cleanupRegisteredPaths();
``` ```
If you're using `@swc/jest` and a global setup/teardown file, you have to set the `noInterop: false` and use dynamic imports within the setup function: If you're using `@swc/jest` and a global setup/teardown file, you have to set the `noInterop: false` and use dynamic imports within the setup function: