Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update setupFiles documentation for improved clarity #7187

Merged

Conversation

bambielli
Copy link
Contributor

Summary

See #7174 for issue. setupFiles documentation was misleading. This PR makes it clearer that setupFiles are only expected to run once per test file, not once per test.

Test plan

N/A (documentation change)

@facebook-github-bot
Copy link
Contributor

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@bambielli bambielli changed the title fixes iss #7174 : update setupfiles documentation for improved clarit… update setupFiles documentation for improved clarity Oct 17, 2018
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

@thymikee
Copy link
Collaborator

Would you be so kind update versioned docs too? And add a changleog :)


It's worth noting that this code will execute _before_ [`setupTestFrameworkScriptFile`](#setuptestframeworkscriptfile-string).
It's also worth noting that setupFiles will execute _before_ [`setupTestFrameworkScriptFile`](#setuptestframeworkscriptfile-string).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wrap in backtciks?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops sure.

@bambielli
Copy link
Contributor Author

ack i thought I added the changelog... sorry!

…clarity around expected setupfile behavior
@bambielli bambielli force-pushed the update/setupfiles-documentation branch from 709fc71 to e8b42fb Compare October 17, 2018 13:08
@codecov-io
Copy link

Codecov Report

Merging #7187 into master will increase coverage by 0.08%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #7187      +/-   ##
==========================================
+ Coverage   67.22%   67.31%   +0.08%     
==========================================
  Files         248      248              
  Lines        9627     9615      -12     
  Branches        4        4              
==========================================
  Hits         6472     6472              
+ Misses       3154     3142      -12     
  Partials        1        1
Impacted Files Coverage Δ
packages/jest-jasmine2/src/index.js 0% <0%> (ø) ⬆️
packages/jest-runtime/src/script_transformer.js 88.46% <0%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8a7b4a9...e8b42fb. Read the comment docs.

Copy link
Member

@rickhanlonii rickhanlonii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@rickhanlonii rickhanlonii merged commit ed67167 into jestjs:master Oct 17, 2018
@rickhanlonii
Copy link
Member

Thanks @bambielli for your first Jest contribution 🎉

@bambielli
Copy link
Contributor Author

Thank you! I <3 Jest, and am converting many of my coworkers over to it from Mocha/Chai/Sinon.
I'll look for more opportunities to contribute in the future.

@bambielli bambielli deleted the update/setupfiles-documentation branch October 17, 2018 17:26
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants