Skip to content

chore(doc): add jest specific pckg command#13607

Merged
JLHwung merged 8 commits intobabel:mainfrom
tony-go:doc-test-only
Aug 3, 2021
Merged

chore(doc): add jest specific pckg command#13607
JLHwung merged 8 commits intobabel:mainfrom
tony-go:doc-test-only

Conversation

@tony-go
Copy link
Copy Markdown
Contributor

@tony-go tony-go commented Jul 28, 2021 •
edited by gitpod-io bot
Loading

Q                       A
Fixed Issues? ❌
Patch: Bug Fix? ❌
Major: Breaking Change? ❌
Minor: New Feature? ❌
Tests Added + Pass? ❌
Documentation PR Link ❌
Any Dependency Changes? ❌
License MIT

Hi 👋

Yesterday, chatting with @JLHwung we figured out that the command: yarn jest <name-of-the-pckg> --watch wasn't mentioned in the documentation.

A tiny PR to add it ^^

Let me know if it's useful or not.

@babel-bot
Copy link
Copy Markdown
Collaborator

babel-bot commented Jul 28, 2021 •
edited
Loading

Build successful! You can test your changes in the REPL here: https://babeljs.io/repl/build/47804/

@codesandbox-ci
Copy link
Copy Markdown

codesandbox-ci bot commented Jul 28, 2021 •
edited
Loading

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 206fa6f:

Sandbox Source
babel-repl-custom-plugin Configuration
babel-plugin-multi-config Configuration

@fedeci fedeci added the PR: Docs 📝 A type of pull request used for our changelog categories label Jul 28, 2021
fedeci
fedeci reviewed Jul 28, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@fedeci fedeci left a comment

Choose a reason for hiding this comment

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

Since there are equivalent flags also for TEST_GREP and TEST_DEBUG, why don't we document all of them?

@tony-go
Copy link
Copy Markdown
Contributor Author

tony-go commented Jul 28, 2021

Since there are equivalent flags also for TEST_GREP and TEST_DEBUG, why don't we document all of them?

Just to mention that the command TEST_DEBUG=true make test and yarn node --inspect-brk node_modules/.bin/jest --runInBand doesn't work on my machine 🙈

@tony-go tony-go requested a review from fedeci July 28, 2021 20:41
@nicolo-ribaudo
Copy link
Copy Markdown
Member

nicolo-ribaudo commented Jul 28, 2021

TIL about TEST_DEBUG=true 😬

fedeci
fedeci reviewed Jul 28, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@fedeci fedeci left a comment

Choose a reason for hiding this comment

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

Apart from the nitpicks, I was thinking about a more tabular view of this commands, what's your point of view?

@tony-go
Copy link
Copy Markdown
Contributor Author

tony-go commented Jul 29, 2021

Fix nitpicks and reshape a bit the documentation.

👀

Let me know.

@tony-go tony-go requested a review from fedeci July 29, 2021 06:38
fedeci
fedeci reviewed Jul 29, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@fedeci fedeci left a comment

Choose a reason for hiding this comment

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

Great🚀

@tony-go tony-go requested a review from fedeci July 29, 2021 07:34
fedeci
fedeci approved these changes Jul 29, 2021
View reviewed changes
JLHwung
JLHwung approved these changes Jul 29, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@JLHwung JLHwung left a comment

Choose a reason for hiding this comment

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

LGTM with some nits.

CONTRIBUTING.md Outdated
### Running linting/tests

You can run lint via:
#### You can run lint via:
Copy link
Copy Markdown
Contributor

@JLHwung JLHwung Jul 29, 2021

Choose a reason for hiding this comment

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

Don't know if we want to align the language in h4 subtitles. e.g. We can simplify put "Lint" here?

Copy link
Copy Markdown
Contributor Author

@tony-go tony-go Jul 29, 2021

Choose a reason for hiding this comment

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

My idea was to add a bit of structure to all these lines. But we can rethink it. :)

@tony-go tony-go requested a review from JLHwung July 29, 2021 19:05
JLHwung
JLHwung reviewed Jul 29, 2021
View reviewed changes
JLHwung
JLHwung reviewed Jul 29, 2021
View reviewed changes
@tony-go tony-go requested a review from JLHwung August 3, 2021 11:35
@JLHwung JLHwung merged commit 5f4b58f into babel:main Aug 3, 2021
This was referenced Aug 5, 2021
Merged
Closed
@github-actions github-actions bot added the outdated A closed issue/PR that is archived due to age. Recommended to make a new issue label Nov 3, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 3, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@fedeci fedeci fedeci approved these changes

@JLHwung JLHwung Awaiting requested review from JLHwung

Assignees

No one assigned

Labels

outdated A closed issue/PR that is archived due to age. Recommended to make a new issue PR: Docs 📝 A type of pull request used for our changelog categories

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@tony-go @babel-bot @nicolo-ribaudo @JLHwung @fedeci