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

docs: expand on how jest version is determined and common workarounds #897

Closed
wants to merge 3 commits into from
Closed

docs: expand on how jest version is determined and common workarounds #897

wants to merge 3 commits into from

Conversation

G-Rath
Copy link
Collaborator

@G-Rath G-Rath commented Sep 17, 2021

This is something of a documentation stop-gap while I work on #889.

@G-Rath G-Rath requested a review from SimenB September 17, 2021 02:39
@G-Rath G-Rath mentioned this pull request Sep 17, 2021
Merged
SimenB
SimenB requested changes Sep 17, 2021
View reviewed changes
README.md Outdated
@@ -60,22 +60,40 @@ This is included in all configs shared by this plugin, so can be omitted if
extending them.

The behaviour of some rules (specifically `no-deprecated-functions`) change
Copy link
Member

Choose a reason for hiding this comment

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

we should create a section here and link to it from https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-deprecated-functions.md

@G-Rath G-Rath requested a review from SimenB September 22, 2021 19:19
@G-Rath G-Rath mentioned this pull request Sep 22, 2021
Merged
2 tasks
@G-Rath
Copy link
Collaborator Author

G-Rath commented Sep 22, 2021

Currently this is actually incorrect, since we assume that the version being passed in settings is the jest major version, which require('jest/package.json').version won't be - so we should either land the parseJestVersion function from #889 as a fix or otherwise merge this after #889 (which'd mean this should be adjusted to explain the new logic).

SimenB
SimenB reviewed Sep 22, 2021
View reviewed changes
docs/rules/no-deprecated-functions.md
@@ -6,6 +6,10 @@ either been renamed for clarity, or replaced with more powerful APIs.
While typically these deprecated functions are kept in the codebase for a number
of majors, eventually they are removed completely.

This rule requires knowing which version of Jest you're using - see
[this section of the readme](README.md) for details on how that is obtained
Copy link
Member

Choose a reason for hiding this comment

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

This link doesn't work, does it?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No it doesn't - IntelliJ seems to have weird handling of relative links in nested docs :/

@G-Rath
Copy link
Collaborator Author

G-Rath commented Sep 25, 2021

Have pulled these changes into #889

@G-Rath G-Rath closed this Sep 25, 2021
@G-Rath G-Rath deleted the update-readme branch September 25, 2021 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SimenB SimenB SimenB requested changes

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

Successfully merging this pull request may close these issues.
2 participants
@G-Rath @SimenB