fix(no-deprecated-functions): remove `process.cwd` from resolve paths #889

G-Rath · 2021-09-12T21:14:25Z

Resolves #874
Resolves #886
Resolves #888

Would be good if people could test this locally on a few projects and in editors - I think it's fine, but want to make sure we've checked that it won't make any editors explode (as thats the primary reason for why this is here).

G-Rath · 2021-09-12T21:36:44Z

hmm ok maybe that's why I added it, so we could test properly?

I think we could get almost the best of both worlds by instead doing:

const jestPath = require.resolve('jest/package.json', {
  paths: [
    process.cwd(),
    ...(require.resolve.paths('jest/package.json') ?? []),
  ],
});

But there's one test that still fails.

I'll have to do some thinking and playing around to see what we can do - I'd like to avoid adding a really big e2e-type setup where we copy around a bunch of files if possible but maybe that's what we have to go with?

SimenB · 2021-09-13T10:21:36Z

I think we should just remove it and throw an error if people use this rule without specifying the version of Jest they use. They can easily do this in their own .eslintrc.js via require('jest/package.json').version (or just hard code the version if they want static config in package.json or whatever)

codejedi365 · 2021-09-13T13:34:25Z

They can easily do this in their own .eslintrc.js via require('jest/package.json').version

Please update the documentation to reflect this concept. It is uncommon to add a settings object to the .eslintrc and I had to go deep into the ESLINT configuration and guess of what to add where.

SimenB · 2021-09-13T14:18:01Z

Our docs are lacking an example of this, yeah

G-Rath · 2021-09-17T02:40:10Z

I've made #897 expanding our documentation to explain this :)

G-Rath · 2021-09-17T22:59:09Z

:(

SimenB · 2021-09-22T07:07:21Z

@G-Rath how's this one going? 😀

G-Rath · 2021-09-22T07:29:18Z

@SimenB go for gold on reviewing - there's some minor cleanup I was going to look to do once I got it all green (which it is now) but it's fine without it

SimenB

this is missing handling of the user passing a string as the version in their settings (via a require('jest/package.json').version)

Beyond that, looks good 🙂

SimenB · 2021-09-22T07:36:49Z

src/rules/__tests__/detectJestVersion.test.ts

+// pin the original cwd so that we can restore it after each test
+// const projectDir = process.cwd();
+
+// afterEach(() => process.chdir(projectDir));


Suggested change

// pin the original cwd so that we can restore it after each test

// const projectDir = process.cwd();

// afterEach(() => process.chdir(projectDir));

hehe yeah this was the main "minor cleanup" I was going to do - I think we should be able to use changing the directory to remove the need to pass the projectDir around, which might be nicer.

So using process.chdir does work, but tbh I don't know which is actually nicer: using it means we don't have to pass around the project directory argument in all of our tests, but then we'll be magically changing directories and so stuff "just works" 🤔

process.chdir actually changes the dir, so I'd prefer not to

G-Rath · 2021-09-22T19:23:44Z

looks good

Glad you think so - I was pleasantly surprised with how nicely this turned out: while a little annoying we can't collect coverage from the process calls, the tests are fast & cleaner than before + we're not making nearly as many tmp directories as before (only ~4 vs "a whole bunch").

At some point I've been meaning to break our utils file up into a few files within utils/, which now that we have this I'll probably do soon.

btw this change should mean we can technically switch to using export = instead of using babel-plugin-replace-ts-export-assignment because that requires there to be only one export which was the case for all but this rule (as it needed to export the _clearJestVersionCache function)

G-Rath · 2021-09-22T19:24:41Z

this is missing handling of the user passing a string as the version in their settings (via a require('jest/package.json').version)

Do you mean you'd like a test that explicitly has require('jest/package.json').version? just otherwise I was pretty sure we already had a test in the rule for if the setting is present (since that would otherwise not be covered in coverage), but I'll double check.

G-Rath · 2021-09-22T19:51:30Z

ugh dang @SimenB I see what you mean now about the jest version: require('jest/package.json').version will return the full version, which isn't what we currently expect when it's passed in explicitly. That also means #897 shouldn't be landed as-is as it has the same problem.

G-Rath · 2021-09-22T20:01:32Z

src/rules/no-deprecated-functions.ts

-const detectJestVersion = (): JestVersion => {
-  if (cachedJestVersion) {
-    return cachedJestVersion;
+const parseJestVersion = (rawVersion: number | string): JestVersion => {


Technically this is duplicated in detectJestVersion, but I'm fine with that as it's only a few lines and otherwise it calls into question a bit the JestVersion & underlying function name which I don't think is worth doing right now.

It'll be easy enough to refactor in the future if we find more uses for this value and/or a use for having minor or patch versions.

# [24.5.0](v24.4.3...v24.5.0) (2021-09-29) ### Bug Fixes * **no-deprecated-functions:** remove `process.cwd` from resolve paths ([#889](#889)) ([6940488](6940488)) * **no-identical-title:** always consider `.each` titles unique ([#910](#910)) ([a41a40e](a41a40e)) ### Features * create `prefer-expect-resolves` rule ([#822](#822)) ([2556020](2556020)) * create `prefer-to-be` rule ([#864](#864)) ([3a64aea](3a64aea)) * **require-top-level-describe:** support enforcing max num of describes ([#912](#912)) ([14a2d13](14a2d13)) * **valid-title:** allow custom matcher messages ([#913](#913)) ([ffc9392](ffc9392))

github-actions · 2021-09-29T07:51:07Z

🎉 This PR is included in version 24.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

# [25.0.0-next.5](v25.0.0-next.4...v25.0.0-next.5) (2021-09-29) ### Bug Fixes * **no-deprecated-functions:** remove `process.cwd` from resolve paths ([#889](#889)) ([6940488](6940488)) * **no-identical-title:** always consider `.each` titles unique ([#910](#910)) ([a41a40e](a41a40e)) * **valid-expect-in-promise:** support `finally` ([#914](#914)) ([9c89855](9c89855)) * **valid-expect-in-promise:** support additional test functions ([#915](#915)) ([4798005](4798005)) ### Features * create `prefer-expect-resolves` rule ([#822](#822)) ([2556020](2556020)) * create `prefer-to-be` rule ([#864](#864)) ([3a64aea](3a64aea)) * **require-top-level-describe:** support enforcing max num of describes ([#912](#912)) ([14a2d13](14a2d13)) * **valid-title:** allow custom matcher messages ([#913](#913)) ([ffc9392](ffc9392))

github-actions · 2021-09-29T08:01:49Z

🎉 This PR is included in version 25.0.0-next.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

G-Rath requested a review from SimenB September 12, 2021 21:14

G-Rath mentioned this pull request Sep 13, 2021

Fix: Bubble up file tree to find jest #888

Closed

SimenB mentioned this pull request Sep 14, 2021

fix(no-deprecated-functions): do not attempt to detect version of Jest automatically #896

Closed

G-Rath mentioned this pull request Sep 17, 2021

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

Closed

fix(no-deprecated-functions): remove process.cwd from resolve paths

580ad23

G-Rath force-pushed the remove-cmd branch 2 times, most recently from 1158b43 to 60a796e Compare September 17, 2021 22:12

G-Rath force-pushed the remove-cmd branch 3 times, most recently from 723cc9e to 2269232 Compare September 18, 2021 00:51

refactor: move detectJestVersion into its own file

a5e89de

G-Rath force-pushed the remove-cmd branch from 2269232 to a5e89de Compare September 18, 2021 01:01

SimenB mentioned this pull request Sep 20, 2021

Release v25 #905

Merged

2 tasks

G-Rath marked this pull request as ready for review September 22, 2021 07:27

SimenB requested changes Sep 22, 2021

View reviewed changes

chore: remove unneeded console log calls from test

55adacc

G-Rath force-pushed the remove-cmd branch from e4e8048 to 55adacc Compare September 22, 2021 19:31

chore: remove leftover comment

1ca4d0a

fix(no-deprecated-functions): parse major jest version from string

b4ccd8b

G-Rath commented Sep 22, 2021

View reviewed changes

SimenB approved these changes Sep 22, 2021

View reviewed changes

G-Rath added 2 commits September 26, 2021 08:48

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

26332f9

docs: link to no-deprecated-functions from readme

c98efb4

G-Rath force-pushed the remove-cmd branch from df34264 to c528939 Compare September 25, 2021 20:51

docs(no-deprecated-function): link to readme section about jest version

bf143f8

G-Rath force-pushed the remove-cmd branch from c528939 to bf143f8 Compare September 25, 2021 20:52

SimenB merged commit 6940488 into main Sep 29, 2021

SimenB deleted the remove-cmd branch September 29, 2021 07:38

github-actions bot added the released label Sep 29, 2021

github-actions bot added the released on @next label Sep 29, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(no-deprecated-functions): remove `process.cwd` from resolve paths #889

fix(no-deprecated-functions): remove `process.cwd` from resolve paths #889

G-Rath commented Sep 12, 2021

G-Rath commented Sep 12, 2021

SimenB commented Sep 13, 2021 •

edited

codejedi365 commented Sep 13, 2021

SimenB commented Sep 13, 2021

G-Rath commented Sep 17, 2021

G-Rath commented Sep 17, 2021

SimenB commented Sep 22, 2021

G-Rath commented Sep 22, 2021

SimenB left a comment

SimenB Sep 22, 2021

G-Rath Sep 22, 2021 •

edited

G-Rath Sep 22, 2021

SimenB Sep 22, 2021

G-Rath commented Sep 22, 2021

G-Rath commented Sep 22, 2021 •

edited

G-Rath commented Sep 22, 2021

G-Rath Sep 22, 2021

github-actions bot commented Sep 29, 2021

github-actions bot commented Sep 29, 2021

fix(no-deprecated-functions): remove process.cwd from resolve paths #889

fix(no-deprecated-functions): remove process.cwd from resolve paths #889

Conversation

G-Rath commented Sep 12, 2021

G-Rath commented Sep 12, 2021

SimenB commented Sep 13, 2021 • edited

codejedi365 commented Sep 13, 2021

SimenB commented Sep 13, 2021

G-Rath commented Sep 17, 2021

G-Rath commented Sep 17, 2021

SimenB commented Sep 22, 2021

G-Rath commented Sep 22, 2021

SimenB left a comment

Choose a reason for hiding this comment

SimenB Sep 22, 2021

Choose a reason for hiding this comment

G-Rath Sep 22, 2021 • edited

Choose a reason for hiding this comment

G-Rath Sep 22, 2021

Choose a reason for hiding this comment

SimenB Sep 22, 2021

Choose a reason for hiding this comment

G-Rath commented Sep 22, 2021

G-Rath commented Sep 22, 2021 • edited

G-Rath commented Sep 22, 2021

G-Rath Sep 22, 2021

Choose a reason for hiding this comment

github-actions bot commented Sep 29, 2021

github-actions bot commented Sep 29, 2021

fix(no-deprecated-functions): remove `process.cwd` from resolve paths #889

fix(no-deprecated-functions): remove `process.cwd` from resolve paths #889

SimenB commented Sep 13, 2021 •

edited

G-Rath Sep 22, 2021 •

edited

G-Rath commented Sep 22, 2021 •

edited