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

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: #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
facebook · Apr 28, 2023 · 14316bd · 14316bd
1 parent 30da587
commit 14316bd
Show file tree

Hide file tree

Showing 28 changed files with 292 additions and 58 deletions.
diff --git a/packages/assets/README.md b/packages/assets/README.md
@@ -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`.
diff --git a/packages/assets/package.json b/packages/assets/package.json
@@ -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"
   }

diff --git a/packages/babel-plugin-codegen/README.md b/packages/babel-plugin-codegen/README.md
@@ -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`.
diff --git a/packages/babel-plugin-codegen/package.json b/packages/babel-plugin-codegen/package.json
@@ -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"
+  }
 }
diff --git a/packages/eslint-config-react-native-community/package.json b/packages/eslint-config-react-native-community/package.json
@@ -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",

diff --git a/packages/eslint-plugin-react-native-community/README.md b/packages/eslint-plugin-react-native-community/README.md
@@ -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`.
diff --git a/packages/eslint-plugin-react-native-community/package.json b/packages/eslint-plugin-react-native-community/package.json
@@ -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"
 }
diff --git a/packages/eslint-plugin-specs/README.md b/packages/eslint-plugin-specs/README.md
@@ -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`.
diff --git a/packages/eslint-plugin-specs/package.json b/packages/eslint-plugin-specs/package.json
@@ -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"
+  }
 }
diff --git a/packages/hermes-inspector-msggen/README.md b/packages/hermes-inspector-msggen/README.md
@@ -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`.
diff --git a/packages/hermes-inspector-msggen/package.json b/packages/hermes-inspector-msggen/package.json
@@ -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"
   },

diff --git a/packages/metro-config/README.md b/packages/metro-config/README.md
@@ -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`.
diff --git a/packages/metro-config/package.json b/packages/metro-config/package.json
@@ -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"
   },

diff --git a/packages/normalize-color/README.md b/packages/normalize-color/README.md
@@ -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`.
diff --git a/packages/normalize-color/package.json b/packages/normalize-color/package.json
@@ -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"
   }

diff --git a/packages/polyfills/README.md b/packages/polyfills/README.md
@@ -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`.
diff --git a/packages/polyfills/package.json b/packages/polyfills/package.json
@@ -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"
   }

diff --git a/packages/react-native-bots/package.json b/packages/react-native-bots/package.json
@@ -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"
   },

diff --git a/packages/react-native-codegen-typescript-test/package.json b/packages/react-native-codegen-typescript-test/package.json
@@ -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": "*"
   },