React/react-native
1
0
Fork 0
mirror of https://github.com/facebook/react-native.git synced 2024-11-21 20:50:09 +00:00
Code Issues Actions 11 Packages Projects Releases Wiki Activity

Add missing READMEs & Update package.json in all RN packages (#37090)

Browse Source 
Summary:
This diff adds _missing_ README files for all public RN packages.

#### Changes:
For all public RN packages:
- Add _Missing_ READMEs

Update package.json in all RN packages to add:
- Issues, Bugs urls
- Keywords and Homepage urls to respective pkgs

## Changelog:

[GENERAL][ADDED] - Add missing README files for all public RN packages.
[GENERAL][CHANGED] - Update package.json in all RN packages to add required fields.

Pull Request resolved: https://github.com/facebook/react-native/pull/37090

Test Plan: - `yarn lint && yarn flow && yarn test-ci` --> _should be green_

Reviewed By: cortinico

Differential Revision: D45390861

Pulled By: hoxyq

fbshipit-source-id: 524a92de56a7cb553573d9f54ccf40a998dfd35f
This commit is contained in:
Pranav Yadav 2023-04-28 04:26:20 -07:00 committed by Facebook GitHub Bot
parent 30da587336
commit 14316bd635
28 changed files with 292 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
packages/assets/README.md Normal file
View File

@ -0,0 +1,21 @@
# @react-native/assets-registry
[![Version][version-badge]][package]
## Installation
```
yarn add --dev @react-native/assets-registry
```
*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*
[version-badge]: https://img.shields.io/npm/v/@react-native/assets-registry?style=flat-square
[package]: https://www.npmjs.com/package/@react-native/assets-registry
## Testing
To run the tests in this package, run the following commands from the React Native root folder:
1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/assets`.

7
packages/assets/package.json
View File

@ -2,12 +2,15 @@
"name": "@react-native/assets-registry",
"version": "0.73.0",
"description": "Asset support code for React Native.",
"license": "MIT",
"repository": {
"type": "git",
"url": "git@github.com:facebook/react-native.git",
"url": "https://github.com/facebook/react-native.git",
"directory": "packages/assets"
},
"license": "MIT",
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/assets#readme",
"keywords": ["assets", "registry", "react-native", "support"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=16"
}

21
packages/babel-plugin-codegen/README.md Normal file
View File

@ -0,0 +1,21 @@
# @react-native/babel-plugin-codegen
[![Version][version-badge]][package]
## Installation
```
yarn add --dev @babel/core @react-native/babel-plugin-codegen
```
*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*
[version-badge]: https://img.shields.io/npm/v/@react-native/babel-plugin-codegen?style=flat-square
[package]: https://www.npmjs.com/package/@react-native/babel-plugin-codegen
## Testing
To run the tests in this package, run the following commands from the React Native root folder:
1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/babel-plugin-codegen`.

11
packages/babel-plugin-codegen/package.json
View File

@ -1,12 +1,16 @@
{
"version": "0.73.0",
"name": "@react-native/babel-plugin-codegen",
"version": "0.73.0",
"description": "Babel plugin to generate native module and view manager code for React Native.",
"license": "MIT",
"repository": {
"type": "git",
"url": "git@github.com:facebook/react-native.git",
"url": "https://github.com/facebook/react-native.git",
"directory": "packages/babel-plugin-codegen"
},
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/babel-plugin-codegen#readme",
"keywords": ["babel", "plugin", "codegen", "react-native", "native-modules", "view-manager"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=16"
},
@ -18,6 +22,5 @@
},
"devDependencies": {
"@babel/core": "^7.20.0"
},
"license": "MIT"
}
}

6
packages/eslint-config-react-native-community/package.json
View File

@ -2,17 +2,19 @@
"name": "@react-native/eslint-config",
"version": "0.73.0",
"description": "ESLint config for React Native",
"main": "index.js",
"license": "MIT",
"repository": {
"type": "git",
"url": "git@github.com:facebook/react-native.git",
"url": "https://github.com/facebook/react-native.git",
"directory": "packages/eslint-config-react-native-community"
},
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/eslint-config-react-native-community#readme",
"keywords": ["eslint", "config", "react-native"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=16"
},
"main": "index.js",
"dependencies": {
"@babel/core": "^7.20.0",
"@babel/eslint-parser": "^7.19.0",

7
packages/eslint-plugin-react-native-community/README.md
View File

@ -25,3 +25,10 @@ Add to your eslint config (`.eslintrc`, or `eslintConfig` field in `package.json
### `platform-colors`
Enforces that calls to `PlatformColor` and `DynamicColorIOS` are statically analyzable to enable performance optimizations.
## Testing
To run the tests in this package, run the following commands from the React Native root folder:
1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/eslint-plugin-react-native-community`.

11
packages/eslint-plugin-react-native-community/package.json
View File

@ -2,14 +2,17 @@
"name": "@react-native/eslint-plugin",
"version": "0.73.0",
"description": "ESLint rules for @react-native/eslint-config",
"main": "index.js",
"license": "MIT",
"repository": {
"type": "git",
"url": "git@github.com:facebook/react-native.git",
"url": "https://github.com/facebook/react-native.git",
"directory": "packages/eslint-plugin-react-native-community"
},
"license": "MIT",
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/eslint-plugin-react-native-community#readme",
"keywords": ["eslint", "rules", "eslint-config", "react-native"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=16"
}
},
"main": "index.js"
}

21
packages/eslint-plugin-specs/README.md Normal file
View File

@ -0,0 +1,21 @@
# @react-native/eslint-plugin-specs
[![Version][version-badge]][package]
## Installation
```
yarn add --dev @react-native/eslint-plugin-specs
```
*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*
[version-badge]: https://img.shields.io/npm/v/@react-native/eslint-plugin-specs?style=flat-square
[package]: https://www.npmjs.com/package/@react-native/eslint-plugin-specs
## Testing
To run the tests in this package, run the following commands from the React Native root folder:
1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/eslint-plugin-specs`.

11
packages/eslint-plugin-specs/package.json
View File

@ -2,15 +2,19 @@
"name": "@react-native/eslint-plugin-specs",
"version": "0.73.0",
"description": "ESLint rules to validate NativeModule and Component Specs",
"main": "index.js",
"license": "MIT",
"repository": {
"type": "git",
"url": "git@github.com:facebook/react-native.git",
"url": "https://github.com/facebook/react-native.git",
"directory": "packages/eslint-plugin-specs"
},
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/eslint-plugin-specs#readme",
"keywords": ["eslint", "rules", "react-native", "native-modules", "components", "specs"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=16"
},
"main": "index.js",
"scripts": {
"prepack": "node prepack.js",
"postpack": "node postpack.js"
@ -25,6 +29,5 @@
"make-dir": "^2.1.0",
"pirates": "^4.0.1",
"source-map-support": "0.5.0"
},
"license": "MIT"
}
}

21
packages/hermes-inspector-msggen/README.md Normal file
View File

@ -0,0 +1,21 @@
# @react-native/hermes-inspector-msggen
[![Version][version-badge]][package]
## Installation
```
yarn add --dev @babel/cli @babel/core @babel/preset-env @babel/preset-flow jest @react-native/hermes-inspector-msggen
```
*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*
[version-badge]: https://img.shields.io/npm/v/@react-native/hermes-inspector-msggen?style=flat-square
[package]: https://www.npmjs.com/package/@react-native/hermes-inspector-msggen
## Testing
To run the tests in this package, run the following commands from the React Native root folder:
1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/hermes-inspector-msggen`.

8
packages/hermes-inspector-msggen/package.json
View File

@ -1,8 +1,14 @@
{
"name": "@react-native/hermes-inspector-msggen",
"private": true,
"version": "0.72.0",
"private": true,
"description": "Hermes Inspector Message Generator for React Native",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/facebook/react-native.git",
"directory": "packages/hermes-inspector-msggen"
},
"bin": {
"msggen": "./bin/index.js"
},

21
packages/metro-config/README.md Normal file
View File

@ -0,0 +1,21 @@
# @react-native/metro-config
[![Version][version-badge]][package]
## Installation
```
yarn add --dev @react-native/js-polyfills metro-config metro-react-native-babel-transformer metro-runtime @react-native/metro-config
```
*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*
[version-badge]: https://img.shields.io/npm/v/@react-native/metro-config?style=flat-square
[package]: https://www.npmjs.com/package/@react-native/metro-config
## Testing
To run the tests in this package, run the following commands from the React Native root folder:
1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/metro-config`.

7
packages/metro-config/package.json
View File

@ -2,12 +2,15 @@
"name": "@react-native/metro-config",
"version": "0.73.0",
"description": "Metro configuration for React Native.",
"license": "MIT",
"repository": {
"type": "git",
"url": "git@github.com:facebook/react-native.git",
"url": "https://github.com/facebook/react-native.git",
"directory": "packages/metro-config"
},
"license": "MIT",
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/metro-config#readme",
"keywords": ["metro", "config", "react-native"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=16"
},

21
packages/normalize-color/README.md Normal file
View File

@ -0,0 +1,21 @@
# @react-native/normalize-colors
[![Version][version-badge]][package]
## Installation
```
yarn add --dev @react-native/normalize-colors
```
*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*
[version-badge]: https://img.shields.io/npm/v/@react-native/normalize-colors?style=flat-square
[package]: https://www.npmjs.com/package/@react-native/normalize-colors
## Testing
To run the tests in this package, run the following commands from the React Native root folder:
1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/normalize-color`.

7
packages/normalize-color/package.json
View File

@ -2,12 +2,15 @@
"name": "@react-native/normalize-colors",
"version": "0.73.0",
"description": "Color normalization for React Native.",
"license": "MIT",
"repository": {
"type": "git",
"url": "git@github.com:facebook/react-native.git",
"url": "https://github.com/facebook/react-native.git",
"directory": "packages/normalize-color"
},
"license": "MIT",
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/normalize-color#readme",
"keywords": ["color", "normalization", "normalize-colors", "react-native"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=16"
}

21
packages/polyfills/README.md Normal file
View File

@ -0,0 +1,21 @@
# @react-native/js-polyfills
[![Version][version-badge]][package]
## Installation
```
yarn add @react-native/js-polyfills
```
*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*
[version-badge]: https://img.shields.io/npm/v/@react-native/js-polyfills?style=flat-square
[package]: https://www.npmjs.com/package/@react-native/js-polyfills
## Testing
To run the tests in this package, run the following commands from the React Native root folder:
1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/polyfills`.

7
packages/polyfills/package.json
View File

@ -2,12 +2,15 @@
"name": "@react-native/js-polyfills",
"version": "0.73.0",
"description": "Polyfills for React Native.",
"license": "MIT",
"repository": {
"type": "git",
"url": "git@github.com:facebook/react-native.git",
"url": "https://github.com/facebook/react-native.git",
"directory": "packages/polyfills"
},
"license": "MIT",
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/polyfills#readme",
"keywords": ["polyfill", "polyfills", "js", "js-polyfills", "react-native"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=16"
}

8
packages/react-native-bots/package.json
View File

@ -1,7 +1,15 @@
{
"name": "@react-native/bots",
"description": "React Native Bots",
"version": "0.0.0",
"private": true,
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/facebook/react-native.git",
"directory": "packages/react-native-bots"
},
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/react-native-bots#readme",
"engines": {
"node": ">=16"
},

8
packages/react-native-codegen-typescript-test/package.json
View File

@ -1,13 +1,14 @@
{
"name": "@react-native/codegen-typescript-test",
"version": "0.0.1",
"description": "⚛️ TypeScript related unit test for @react-native/codegen",
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/react-native-typescript-test",
"description": "TypeScript related unit test for @react-native/codegen",
"license": "MIT",
"repository": {
"type": "git",
"url": "git@github.com:facebook/react-native.git",
"url": "https://github.com/facebook/react-native.git",
"directory": "packages/react-native-codegen-typescript-test"
},
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/react-native-typescript-test",
"engines": {
"node": ">=16"
},
@ -16,7 +17,6 @@
"clean": "rimraf lib && rimraf __generated__/*.ts",
"prepare": "yarn run build"
},
"license": "MIT",
"dependencies": {
"@react-native/codegen": "*"
},

4
packages/react-native-codegen/README.md
View File

@ -15,7 +15,7 @@ yarn add --dev @react-native/codegen
## Testing
To run the tests in this package, run the following commands from the react Native root folder:
To run the tests in this package, run the following commands from the React Native root folder:
1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest react-native-codegen`.
2. `yarn jest packages/react-native-codegen`.

10
packages/react-native-codegen/package.json
View File

@ -1,13 +1,16 @@
{
"name": "@react-native/codegen",
"version": "0.73.0",
"description": "⚛️ Code generation tools for React Native",
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/react-native-codegen",
"description": "Code generation tools for React Native",
"license": "MIT",
"repository": {
"type": "git",
"url": "git@github.com:facebook/react-native.git",
"url": "https://github.com/facebook/react-native.git",
"directory": "packages/react-native-codegen"
},
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/react-native-codegen#readme",
"keywords": ["code", "generation", "codegen", "tools", "react-native"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=16"
},
@ -16,7 +19,6 @@
"clean": "rimraf lib",
"prepare": "yarn run build"
},
"license": "MIT",
"files": [
"lib"
],

7
packages/react-native-gradle-plugin/README.md
View File

@ -14,3 +14,10 @@ yarn add @react-native/gradle-plugin
[version-badge]: https://img.shields.io/npm/v/@react-native/gradle-plugin?style=flat-square
[package]: https://www.npmjs.com/package/@react-native/gradle-plugin
## Testing
To run the tests in this package, run the following commands from the React Native root folder:
1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/react-native-gradle-plugin`.

10
packages/react-native-gradle-plugin/package.json
View File

@ -1,13 +1,16 @@
{
"name": "@react-native/gradle-plugin",
"version": "0.73.0",
"description": "⚛️ Gradle Plugin for React Native",
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/react-native-gradle-plugin",
"description": "Gradle Plugin for React Native",
"license": "MIT",
"repository": {
"type": "git",
"url": "git@github.com:facebook/react-native.git",
"url": "https://github.com/facebook/react-native.git",
"directory": "packages/react-native-gradle-plugin"
},
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/react-native-gradle-plugin#readme",
"keywords": ["gradle", "plugin", "react-native"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=16"
},
@ -16,7 +19,6 @@
"clean": "./gradlew clean",
"test": "./gradlew check"
},
"license": "MIT",
"files": [
"settings.gradle.kts",
"build.gradle.kts",

11
packages/react-native/package.json
View File

@ -1,13 +1,20 @@
{
"name": "react-native",
"version": "1000.0.0",
"bin": "./cli.js",
"description": "A framework for building native apps using React",
"license": "MIT",
"repository": "github:facebook/react-native",
"repository": {
"type": "git",
"url": "https://github.com/facebook/react-native.git",
"directory": "packages/react-native"
},
"homepage": "https://reactnative.dev/",
"keywords": ["react", "react-native", "android", "ios", "mobile", "cross-platform", "app-framework", "mobile-development"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=16"
},
"bin": "./cli.js",
"types": "types",
"jest-junit": {
"outputDirectory": "reports/junit",

28
packages/rn-tester/README.md
View File

@ -5,10 +5,11 @@ The RNTester showcases React Native views and modules.
## Running this app
Before running the app, make sure you ran:
git clone https://github.com/facebook/react-native.git
cd react-native
yarn install
```sh
git clone https://github.com/facebook/react-native.git
cd react-native
yarn install
```
### Running on iOS
@ -29,11 +30,12 @@ If you are still having a problem after doing the clean up (which can happen if
Both macOS and Xcode are required.
1. `cd packages/rn-tester`
1. Install [Bundler](https://bundler.io/): `gem install bundler`. We use bundler to install the right version of [CocoaPods](https://cocoapods.org/) locally.
1. Install Bundler and CocoaPods dependencies: `bundle install && bundle exec pod install` or `yarn setup-ios-hermes`. In order to use JSC instead of Hermes engine, run: `USE_HERMES=0 bundle exec pod install` or `yarn setup-ios-jsc` instead.
1. Open the generated `RNTesterPods.xcworkspace`. This is not checked in, as it is generated by CocoaPods. Do not open `RNTesterPods.xcodeproj` directly.
2. Install [Bundler](https://bundler.io/): `gem install bundler`. We use bundler to install the right version of [CocoaPods](https://cocoapods.org/) locally.
3. Install Bundler and CocoaPods dependencies: `bundle install && bundle exec pod install` or `yarn setup-ios-hermes`. In order to use JSC instead of Hermes engine, run: `USE_HERMES=0 bundle exec pod install` or `yarn setup-ios-jsc` instead.
4. Open the generated `RNTesterPods.xcworkspace`. This is not checked in, as it is generated by CocoaPods. Do not open `RNTesterPods.xcodeproj` directly.
#### Note for M1 users
If you own a Mac M1 laptop, you need to run some different commands to install and run cocoapods.
- `sudo arch -x86_64 gem install ffi`: this installs the `ffi` package to load dynamically-linked libraries.
@ -44,7 +46,6 @@ If you own a Mac M1 laptop, you need to run some different commands to install a
You'll need to have all the [prerequisites](https://reactnative.dev/contributing/how-to-build-from-source#prerequisites) (SDK, NDK) for Building React Native installed.
Start an Android emulator.
```sh
cd packages/rn-tester
# In order to use Hermes engine, run `yarn install-android-hermes` instead.
@ -65,11 +66,12 @@ Follow the same setup as running with gradle.
Install Buck from [here](https://buckbuild.com/setup/install.html).
Run the following commands from the react-native folder:
./gradlew :ReactAndroid:packageReactNdkLibsForBuck
buck fetch rntester
buck install -r rntester
./scripts/packager.sh
```sh
./gradlew :ReactAndroid:packageReactNdkLibsForBuck
buck fetch rntester
buck install -r rntester
./scripts/packager.sh
```
_Note: The native libs are still built using gradle. Full build with buck is coming soon(tm)._

7
packages/rn-tester/package.json
View File

@ -1,13 +1,12 @@
{
"private": true,
"name": "@react-native/tester",
"version": "0.0.1",
"license": "MIT",
"private": true,
"description": "React Native tester app.",
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/rn-tester",
"license": "MIT",
"repository": {
"type": "git",
"url": "git@github.com:facebook/react-native.git",
"url": "https://github.com/facebook/react-native.git",
"directory": "packages/rn-tester"
},
"engines": {

21
packages/virtualized-lists/README.md Normal file
View File

@ -0,0 +1,21 @@
# @react-native/virtualized-lists
[![Version][version-badge]][package]
## Installation
```
yarn add @react-native/virtualized-lists
```
*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*
[version-badge]: https://img.shields.io/npm/v/@react-native/virtualized-lists?style=flat-square
[package]: https://www.npmjs.com/package/@react-native/virtualized-lists
## Testing
To run the tests in this package, run the following commands from the React Native root folder:
1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/virtualized-lists`.

7
packages/virtualized-lists/package.json
View File

@ -2,12 +2,15 @@
"name": "@react-native/virtualized-lists",
"version": "0.73.0",
"description": "Virtualized lists for React Native.",
"license": "MIT",
"repository": {
"type": "git",
"url": "git@github.com:facebook/react-native.git",
"url": "https://github.com/facebook/react-native.git",
"directory": "packages/virtualized-lists"
},
"license": "MIT",
"homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/virtualized-lists#readme",
"keywords": ["lists", "virtualized-lists", "section-lists", "react-native"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=16"
},