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.

Sign up for GitHub

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

Jump to bottom

Created Readme.md for @jest/utils #14467

Merged
merged 6 commits into from
Sep 6, 2023
Merged

Created Readme.md for @jest/utils #14467

merged 6 commits into from
Sep 6, 2023

Conversation

malaviya-parth
Copy link
Contributor

Summary

This PR fixes #14457

Please let me know if any changes to make (if any required) in this.

Test plan

None

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Sep 1, 2023 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@netlify
Copy link

netlify bot commented Sep 1, 2023 •
edited
Loading

✅ Deploy Preview for jestjs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 19d5012
🔍 Latest deploy log https://app.netlify.com/sites/jestjs/deploys/64f827f02a54350008ecb371
😎 Deploy Preview https://deploy-preview-14467--jestjs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

SimenB
SimenB reviewed Sep 5, 2023
View reviewed changes
Copy link
Member

@SimenB SimenB left a comment

Choose a reason for hiding this comment

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

thanks!

packages/jest-util/Readme.md Outdated

This packages is a collection of utilities and helper functions

## [clearLine.ts](https://github.com/jestjs/jest/blob/v29.6.4/packages/jest-util/src/clearLine.ts)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## [clearLine.ts](https://github.com/jestjs/jest/blob/v29.6.4/packages/jest-util/src/clearLine.ts)
## `clearLine`

something like that for all of them? we don't need the links I think 🙂

packages/jest-util/Readme.md Outdated
This packages is a collection of utilities and helper functions

## [clearLine.ts](https://github.com/jestjs/jest/blob/v29.6.4/packages/jest-util/src/clearLine.ts)
- It ensures that the clearing operation is only performed when running in a terminal environment, and not when the output is redirected to a file or another non-terminal destination.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- It ensures that the clearing operation is only performed when running in a terminal environment, and not when the output is redirected to a file or another non-terminal destination.
It ensures that the clearing operation is only performed when running in a terminal environment, and not when the output is redirected to a file or another non-terminal destination.

I don't think we need this as a bullet point?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure will commit the suggested changes soon 🚀

SimenB
SimenB approved these changes Sep 5, 2023
View reviewed changes
Copy link
Member

@SimenB SimenB left a comment

Choose a reason for hiding this comment

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

Great stuff, thanks! 👍

packages/jest-util/Readme.md Outdated
@@ -0,0 +1,66 @@
# [@jest/utils](https://github.com/jestjs/jest/blob/v29.6.4/packages/jest-util/src/index.ts)
Copy link
Member

Choose a reason for hiding this comment

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

Remove the link here as well 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh!, Sorry let me correct it.

mrazauskas
mrazauskas reviewed Sep 5, 2023
View reviewed changes
Copy link
Contributor

@mrazauskas mrazauskas left a comment

Choose a reason for hiding this comment

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

Perhaps the entries could be sorted in alphabetical order?

@SimenB
Copy link
Member

SimenB commented Sep 5, 2023

Perhaps the entries could be sorted in alphabetical order?

Good idea

@malaviya-parth
Copy link
Contributor Author

malaviya-parth commented Sep 5, 2023 •
edited
Loading

Perhaps the entries could be sorted in alphabetical order?
Should I keet ErrorWithStack.ts at the top as it is like that sorted in the directory due to it being a class?
Sure, let me change it.

mrazauskas
mrazauskas reviewed Sep 6, 2023
View reviewed changes
Copy link
Contributor

@mrazauskas mrazauskas left a comment

Choose a reason for hiding this comment

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

Thanks! I like this order, it works.

Please take a look at lint errors on CI.

SimenB
SimenB approved these changes Sep 6, 2023
View reviewed changes
Copy link
Member

@SimenB SimenB left a comment

Choose a reason for hiding this comment

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

wonderful, thank you so much!

@SimenB SimenB merged commit 9db8fa9 into jestjs:main Sep 6, 2023
8 checks passed
This was referenced Sep 17, 2023
Merged
Merged
@ms-bot ms-bot mentioned this pull request Oct 2, 2023
Draft
@github-actions
Copy link

github-actions bot commented Oct 7, 2023

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 Oct 7, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mrazauskas mrazauskas mrazauskas left review comments

@SimenB SimenB SimenB approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Docs]: Add README.md to jest-util
3 participants
@malaviya-parth @SimenB @mrazauskas