feat: add "clean" command

[tido64]

Summary:

This adds a clean command to the CLI for common cleaning operations.

Originally contributed by @dennismunene: microsoft/rnx-kit#993

Test Plan:

yarn link @react-native-community/cli @react-native-community/cli-clean

Test --help:

% npx react-native clean --help
react-native clean

Cleans your project by removing React Native related caches and modules.

Options:
  --include <string>       Comma-separated flag of caches to clear e.g. `npm,yarn`. If omitted, an interactive prompt will appear.
  --project-root <string>  Root path to your React Native project. When not specified, defaults to current working directory. (default: "/~/test-app")
  --verify-cache           Whether to verify the cache. Currently only applies to npm cache.
  -h, --help               output usage information

By default, prompts the user for caches to remove:

% yarn react-native clean
? Select all caches to clean ›
Instructions:
    ↑/↓: Highlight option
    ←/→/[space]: Toggle selection
    a: Toggle all
    enter/return: Complete answer
◯   android (Android build caches, e.g. Gradle)
◯   cocoapods (CocoaPods cache)
◉   metro (Metro, haste-map caches)
◯   npm (`node_modules` folder in the current package, and optionally verify npm cache)
◉   watchman (Stop Watchman and delete its cache)
◯   yarn (Yarn cache)

Remove node_modules:

% npx react-native clean --include npm
✔ Remove node_modules

Clean Gradle cache and node_modules:

% npx react-native clean --include android,npm
✔ Clean Gradle cache
✔ Remove node_modules

[thymikee]

I'm looking at the include flag and wonder – can we make it interactive, with checkboxes to tick, and provide --no-interactive mode so it works the same as now?

[tido64]

I'm looking at the include flag and wonder – can we make it interactive, with checkboxes to tick, and provide --no-interactive mode so it works the same as now?

I made it prompt if you omit --include. Let me know what you think.

[thymikee]

This works really well! The only thing I'm missing is tests. Would you mind providing some?

[thymikee]

In other packages, e.g. cli-doctor we use the execa package to handle this for us. Mind verifying it's ok and remove the platform checks? Hope this makes it unnecessary for the execute helper to exist

[tido64]

Testing this on Windows now. Will reply once complete.

[tido64]

Works on Windows. I also hid the CocoaPods option when on Windows and added hints:

% yarn react-native clean
? Select all caches to clean ›
Instructions:
    ↑/↓: Highlight option
    ←/→/[space]: Toggle selection
    a: Toggle all
    enter/return: Complete answer
◯   android (Android build caches, e.g. Gradle)
◯   cocoapods (CocoaPods cache)
◉   metro (Metro, haste-map caches)
◯   npm (`node_modules` folder in the current package, and optionally verify npm cache)
◉   watchman (Stop Watchman and delete its cache)
◯   yarn (Yarn cache)

[thymikee]

After @satya164 comment internally:

one things I'd suggest is maybe some hint for npm and yarn cache? we rarely need to clean those but I see people clearing them all the time because of metro cache issue and they saw it somewhere

Can we uncheck yarn and npm by default? Cache issues are usually related to metro and watchman in my experience as well.

[thymikee]

how about dimming the description, so it doesn't clutter the output too much?

Suggested change

	title: `${cmd} (${group.description})`,
	title: `${cmd} ${chalk.dim((${group.description}))}`,

[tido64]

Yeah, that looks better.

[tido64]

And on Windows:

[thymikee]

Beauty!

[thymikee]

we'll need to add chalk to package.json. Hope this fixes the CI that started to fail with weird unrelated error

[tido64]

Whoops 😄

[cortinico]

Small FYI: clean won't work for users on New Architecture due to a bug on AGP that is causing clean to depend on preBuild. I agree that ./gradlew clean would be the correct approach here, but maybe we should not advertise it yet? Or have a isNewArchitectureEnabled flag inside the CLI to check this and run a rm?