feat(doctor): detect wrong dependencies #1983

tarunrajput · 2023-06-23T09:23:22Z

Summary:

Detect wrong/incompatible dependencies/devDependencies inside package.json
Resolves: #1848

Test Plan:

Build cli codebase using : node ./scripts/build.js && yarn build:debugger
Link the cli-doctor using : yarn link
In the example React Native app(Awesome Project), run yarn link "@react-native-community/cli-doctor"
Run the CLI Doctor using : npx @react-native-community/cli doctor

Failure:

⠏ Running diagnostics...
Common
 ● Dependencies - There are some issues with your project dependencies
   - warn @react-native/codegen is part of React Native and should not be a dependency in your package.json
   - error @react-native/gradle-plugin: "0.72.1" is not compatible with react-native: "0.71.11"
 ✓ Node.js - Required to execute JavaScript code
 ✓ yarn - Required to install NPM dependencies
 ● Metro - Metro Bundler is not running
 ✓ Watchman - Used for watching changes in the filesystem when in development mode

Android
 ✖ Adb - No devices and/or emulators connected. Please create emulator with Android Studio or connect Android device.
 ✓ JDK - Required to compile Java code
 ✓ Android Studio - Required for building and installing your app on Android
 ✖ Android SDK - Required for building and installing your app on Android
   - Versions found: N/A
   - Version supported: 33.0.0
 ✖ ANDROID_HOME - Environment variable that points to your Android SDK installation

iOS
 ✓ Xcode - Required for building and installing your app on iOS
 ✓ Ruby - Required for installing iOS dependencies
 ✓ CocoaPods - Required for installing iOS dependencies
 ● ios-deploy - Required for installing your app on a physical device with the CLI
 ✓ .xcode.env - File to customize Xcode environment

Errors:   3
Warnings: 3


Attempting to fix 6 issues...

Common
 ✖ Dependencies
   Please check your package.json and make sure the dependencies are correct
 ✖ Metro
 ✔ Metro

Android
 ✖ Adb
? Select the device / emulator you want to use › - Use arrow-keys. Return to submit.

{
  "name": "jackeye",
  "version": "0.0.1",
  "private": true,
  "scripts": {
    "android": "react-native run-android",
    "ios": "react-native run-ios",
    "lint": "eslint .",
    "start": "react-native start",
    "test": "jest"
  },
  "dependencies": {
    "react": "18.2.0",
    "react-native": "0.71.11"
  },
  "devDependencies": {
    "@babel/core": "^7.20.0",
    "@babel/preset-env": "^7.20.0",
    "@babel/runtime": "^7.20.0",
    "@react-native-community/eslint-config": "^3.2.0",
    "@tsconfig/react-native": "^2.0.2",
    "@types/jest": "^29.2.1",
    "@types/react": "^18.0.24",
    "@types/react-test-renderer": "^18.0.0",
    "babel-jest": "^29.2.1",
    "eslint": "^8.19.0",
    "jest": "^29.2.1",
    "metro-react-native-babel-preset": "0.73.10",
    "prettier": "^2.4.1",
    "react-test-renderer": "18.2.0",
    "typescript": "4.8.4",
    "@react-native/gradle-plugin": "0.72.1",
    "@react-native/codegen": "0.71.11"
  "jest": {
    "preset": "react-native"
  }
}

Success:

⠏ Running diagnostics...
Common
 ✓ Dependencies - NPM dependencies needed for the project to work correctly
 ✓ Node.js - Required to execute JavaScript code
 ✓ yarn - Required to install NPM dependencies
 ● Metro - Metro Bundler is not running
 ✓ Watchman - Used for watching changes in the filesystem when in development mode

Android
 ✖ Adb - No devices and/or emulators connected. Please create emulator with Android Studio or connect Android device.
 ✖ JDK - Required to compile Java code
   - Version found: 20.0.1
   - Version supported: >= 11 < 19
 ✓ Android Studio - Required for building and installing your app on Android
 ✖ Android SDK - Required for building and installing your app on Android
   - Versions found: N/A
   - Version supported: 33.0.0
 ✖ ANDROID_HOME - Environment variable that points to your Android SDK installation

iOS
 ✓ Xcode - Required for building and installing your app on iOS
 ✓ Ruby - Required for installing iOS dependencies
 ✓ CocoaPods - Required for installing iOS dependencies
 ● ios-deploy - Required for installing your app on a physical device with the CLI
 ✖ .xcode.env - File to customize Xcode environment

Errors:   5
Warnings: 2

Usage
 › Press f to try to fix issues.
 › Press e to try to fix errors.
 › Press w to try to fix warnings.
 › Press Enter to exit.

tarunrajput · 2023-06-23T09:25:00Z

@adamTrz @cortinico , mind taking a look?

cortinico

Please adds some tests inside src/tools/healthchecks/__tests__/

packages/cli-doctor/src/tools/healthchecks/dependencies.ts

tarunrajput · 2023-07-10T06:51:04Z

@cortinico, I've added a few unit tests

cortinico

Code looks good to me, let's wait for someone else from the CLI team to review this one 👍

szymonrybczak

Thank you! 🎉 I left few small comments.

packages/cli-doctor/src/tools/healthchecks/dependencies.ts

szymonrybczak · 2023-07-24T07:27:36Z

Hey @tarunrajput, sorry that I'm writing this right now, but might you adding check for internal @react-native-community/cli packages? It would be perfect if we check for react-native-cli and all packages that we have in our repo. I think we should add other warning / error message that we show when we detect internal React Native packages. My proposal is that:

if we detect react-native-cli -> we should give an error
if we detect @react-native-community/cli -> (at correct corresponding version to RN - print a warning, if there's version mismatch give an error - same as we do with RN's internal packages). Mind adding missing logic? 🙏

cc. @cortinico

tarunrajput · 2023-07-24T16:13:32Z

Hi @szymonrybczak, Thanks for the suggestion! Could you please guide me on how to check if the CLI version is compatible with the React Native version, considering they have independent release cycles? 😅

szymonrybczak · 2023-07-24T16:17:21Z

considering they have independent release cycles

See here, every CLI release corresponds to relevant React Native version - that is the source of truth.

arushikesarwani94 · 2023-08-11T18:28:35Z

LGTM ! For CLI review cc: @szymonrybczak

packages/cli-doctor/src/tools/healthchecks/dependencies.ts

szymonrybczak

Thank you for doing this! Left few small nits 🙌

packages/cli-doctor/src/tools/healthchecks/dependencies.ts

tarunrajput · 2023-08-17T15:35:24Z

@szymonrybczak, Thanks! Just updated the PR with the changes.

szymonrybczak · 2023-09-18T20:05:33Z

@thymikee mind giving final review on this PR?

packages/cli-doctor/src/tools/healthchecks/dependencies.ts

packages/cli-doctor/src/tools/healthchecks/__tests__/dependencies.test.ts

thymikee · 2023-09-19T08:51:33Z

packages/cli-doctor/src/tools/healthchecks/dependencies.ts

+                `   - ${chalk.red(
+                  'error',
+                )} ${pkg}: "${packageVersion}" is not compatible with react-native: "${reactNativeVersion}"`,
+              );


could we use logger.error (and logger.warn where applicable) instead? They handle coloring the warn/error/info words, so we don't have to reimplement it

thanks for the suggestion! I chose not to use logger in this case because it would print the error/warning immediately outside of the issue category like this

⠸ Running diagnostics... warn @react-native-community/cli comes included with React Native and should not be listed as a dependency in your package.json Common ● Dependencies - There are some issues with your project dependencies

github-actions · 2024-01-29T03:17:05Z

There hasn't been any activity on this pull request in the past 3 months, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 7 days.

github-actions bot added the feature label Jun 23, 2023

tarunrajput marked this pull request as ready for review June 28, 2023 05:49

tarunrajput requested review from adamTrz and thymikee as code owners June 28, 2023 05:49

cortinico reviewed Jul 3, 2023

View reviewed changes

packages/cli-doctor/src/tools/healthchecks/dependencies.ts Show resolved Hide resolved

tarunrajput force-pushed the tarunrajput/doctor-detect-wrong-dependencies branch from ce0ae4c to a7ee439 Compare July 10, 2023 06:21

cortinico approved these changes Jul 10, 2023

View reviewed changes

szymonrybczak requested changes Jul 14, 2023

View reviewed changes

tarunrajput requested a review from szymonrybczak July 15, 2023 20:43

szymonrybczak approved these changes Jul 17, 2023

View reviewed changes

cortinico mentioned this pull request Jul 20, 2023

@react-native-community/cli-platform-android Build Failed: The current character read is 'i' with an int value of 105 #1981

Closed

tarunrajput force-pushed the tarunrajput/doctor-detect-wrong-dependencies branch from 770f0c6 to d308daa Compare July 25, 2023 19:26

tarunrajput requested a review from szymonrybczak July 25, 2023 19:27

szymonrybczak reviewed Aug 17, 2023

View reviewed changes

packages/cli-doctor/src/tools/healthchecks/dependencies.ts Outdated Show resolved Hide resolved

szymonrybczak approved these changes Aug 17, 2023

View reviewed changes

packages/cli-doctor/src/tools/healthchecks/dependencies.ts Outdated Show resolved Hide resolved

packages/cli-doctor/src/tools/healthchecks/dependencies.ts Outdated Show resolved Hide resolved

tarunrajput force-pushed the tarunrajput/doctor-detect-wrong-dependencies branch from d308daa to 26f59e5 Compare August 17, 2023 15:24

adamTrz approved these changes Aug 19, 2023

View reviewed changes

thymikee reviewed Sep 19, 2023

View reviewed changes

packages/cli-doctor/src/tools/healthchecks/dependencies.ts Outdated Show resolved Hide resolved

thymikee reviewed Sep 19, 2023

View reviewed changes

packages/cli-doctor/src/tools/healthchecks/__tests__/dependencies.test.ts Outdated Show resolved Hide resolved

thymikee reviewed Sep 19, 2023

View reviewed changes

tarunrajput force-pushed the tarunrajput/doctor-detect-wrong-dependencies branch from 26f59e5 to 8571afa Compare September 20, 2023 08:44

feat(doctor): detect wrong dependencies

9dc5617

tarunrajput added 5 commits October 30, 2023 17:18

add tests and refine dependency checks

f5722cc

detect wrong dependencies

1bc6ced

detect cli internal packages in dependencies

7cb4171

minor fixes

ba99a67

address feedbacks

1f6940e

szymonrybczak force-pushed the tarunrajput/doctor-detect-wrong-dependencies branch from 8571afa to 1f6940e Compare October 30, 2023 16:21

szymonrybczak mentioned this pull request Nov 1, 2023

chore: bump node to 20 #2151

Closed

2 tasks

TMisiukiewicz mentioned this pull request Nov 3, 2023

feat: Include transitive deps in autolinking #2054

Open

8 tasks

github-actions bot added the stale label Jan 29, 2024

github-actions bot closed this Feb 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(doctor): detect wrong dependencies #1983

feat(doctor): detect wrong dependencies #1983

tarunrajput commented Jun 23, 2023 •

edited

Loading

tarunrajput commented Jun 23, 2023 •

edited

Loading

cortinico left a comment

tarunrajput commented Jul 10, 2023

cortinico left a comment

szymonrybczak left a comment

szymonrybczak commented Jul 24, 2023

tarunrajput commented Jul 24, 2023

szymonrybczak commented Jul 24, 2023

arushikesarwani94 commented Aug 11, 2023

szymonrybczak left a comment

tarunrajput commented Aug 17, 2023

szymonrybczak commented Sep 18, 2023

thymikee Sep 19, 2023 •

edited

Loading

tarunrajput Sep 20, 2023

github-actions bot commented Jan 29, 2024

feat(doctor): detect wrong dependencies #1983

feat(doctor): detect wrong dependencies #1983

Conversation

tarunrajput commented Jun 23, 2023 • edited Loading

Summary:

Test Plan:

tarunrajput commented Jun 23, 2023 • edited Loading

cortinico left a comment

Choose a reason for hiding this comment

tarunrajput commented Jul 10, 2023

cortinico left a comment

Choose a reason for hiding this comment

szymonrybczak left a comment

Choose a reason for hiding this comment

szymonrybczak commented Jul 24, 2023

tarunrajput commented Jul 24, 2023

szymonrybczak commented Jul 24, 2023

arushikesarwani94 commented Aug 11, 2023

szymonrybczak left a comment

Choose a reason for hiding this comment

tarunrajput commented Aug 17, 2023

szymonrybczak commented Sep 18, 2023

thymikee Sep 19, 2023 • edited Loading

Choose a reason for hiding this comment

tarunrajput Sep 20, 2023

Choose a reason for hiding this comment

github-actions bot commented Jan 29, 2024

tarunrajput commented Jun 23, 2023 •

edited

Loading

tarunrajput commented Jun 23, 2023 •

edited

Loading

thymikee Sep 19, 2023 •

edited

Loading