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

Minor docs updates for the migration guides #1116

Merged
merged 5 commits into from
Feb 21, 2024

Conversation

pmcelhaney
Copy link
Contributor

The main change is to updating the migration for autoRevealOutput to point to outputConfig instead of runMode.

I also updated the formatting to use alerts syntax. If you don't like it, I'm happy to update the PR.

@coveralls
Copy link

coveralls commented Feb 19, 2024

Pull Request Test Coverage Report for Build 7978235888

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 97.946%

Totals Coverage Status
Change from base Build 7937613483: 0.0%
Covered Lines: 3915
Relevant Lines: 3923

💛 - Coveralls

@pmcelhaney
Copy link
Contributor Author

Added a PR. #1116

After looking again, I'm not sure the PR template needs any changes. It would be nice if there was a way for VSCode to dump the effective settings for jest.*, but I couldn't find one.

Copy link
Collaborator

@connectdotz connectdotz left a comment

Choose a reason for hiding this comment

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

Thanks for the update, looks good, just one minor adjustment and we should be good to go.

README.md Outdated
@@ -444,7 +444,7 @@ The extension also features built-in conflict detection and quick fixes to assis
"clearOnRun": "terminal"
}
```

**Migration Guide**
<a id="outputconfig-migration"></a>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's put the tag above the title

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved the anchor tag.

At first I misunderstood, thinking you wanted an alert there. Do you want to keep the alert?

image

Copy link
Collaborator

Choose a reason for hiding this comment

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

I was suggesting a simple swap like this:

<a id="outputconfig-migration"></a>
**Migration Guide**

No need for additional alert

- Finally, remove any deprecated settings.

By following these guidelines, you should be able to smoothly transition to using `"jest.outputConfig"`.
> [!NOTE]
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think we need the [!NOTE] here. Sorry if my earlier message didn't come across clearly.

Copy link
Collaborator

Choose a reason for hiding this comment

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

This is pretty minor, never mind. I can adjust it later if needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah that's what I thought you meant at first. I was on the fence about whether the note makes it better or worse so I left it up to you.

The length of the README is getting unwieldy. If it sounds good to you, I might start sending PRs to break it up.

Copy link
Collaborator

@connectdotz connectdotz left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution @pmcelhaney!

- Finally, remove any deprecated settings.

By following these guidelines, you should be able to smoothly transition to using `"jest.outputConfig"`.
> [!NOTE]
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is pretty minor, never mind. I can adjust it later if needed.

@connectdotz connectdotz merged commit bab26b4 into jest-community:master Feb 21, 2024
11 checks passed
@connectdotz
Copy link
Collaborator

The length of the README is getting unwieldy. If it sounds good to you, I might start sending PRs to break it up.

Yes, the README is getting pretty hard to go through. I am interested in hearing your idea of improving it...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants