mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Blake Friedman
affadb6da8
Summary: Using version information previously housed in react-native-communtiy/cli Changelog: [Internal] Reviewed By: cortinico Differential Revision: D55960009 fbshipit-source-id: 38f8b2310942a9337a7b64b51a87ae629d9bbbaf
56 lines
1.8 KiB
Markdown
56 lines
1.8 KiB
Markdown
# @react-native/core-cli-utils
|
|
|
|
|
|
|
|
A collection of utilites to help Frameworks build their React Native CLI tooling. This is not intended to be used directly use users of React Native.
|
|
|
|
## Usage
|
|
|
|
```js
|
|
import { Command } from 'commander';
|
|
import cli from '@react-native/core-cli-utils';
|
|
import debug from 'debug';
|
|
|
|
const android = new Command('android');
|
|
|
|
const frameworkFindsAndroidSrcDir = "...";
|
|
const tasks = cli.clean.android(frameworkFindsAndroidSrcDir);
|
|
const log = debug('fancy-framework:android');
|
|
|
|
android
|
|
.command('clean')
|
|
.description(cli.clean.android)
|
|
.action(async () => {
|
|
const log = debug('fancy-framework:android:clean');
|
|
log(`🧹 let me clean your Android caches`);
|
|
// Add other caches your framework needs besides the normal React Native caches
|
|
// here.
|
|
for (const task of tasks) {
|
|
try {
|
|
log(`\t ${task.label}`);
|
|
// See: https://github.com/sindresorhus/execa#lines
|
|
const {stdout} = await task.action({ lines: true })
|
|
log(stdout.join('\n\tGradle: '));
|
|
} catch (e) {
|
|
log(`\t ⚠️ whoops: ${e.message}`);
|
|
}
|
|
}
|
|
});
|
|
```
|
|
|
|
And you'd be using it like this:
|
|
|
|
```bash
|
|
$ ./fancy-framework android clean
|
|
🧹 let me clean your Android caches
|
|
Gradle: // a bunch of gradle output
|
|
Gradle: ....
|
|
```
|
|
|
|
## Features
|
|
- `"@react-native/core-cli-utils/version.js"` contains the platform and tooling version requirements for react-native.
|
|
|
|
## Contributing
|
|
|
|
Changes to this package can be made locally and linked against your app. Please see the [Contributing guide](https://reactnative.dev/contributing/overview#contributing-code).
|