-
Notifications
You must be signed in to change notification settings - Fork 25.2k
Add missing READMEs & Update package.json in all RN packages #37090
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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`. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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", | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What is the purpose of
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yup, that's the purpose of "homepage" field in case of packages under monorepo, unless we've specific page for each package on RN/any other website.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also, |
||
| "keywords": ["assets", "registry", "react-native", "support"], | ||
| "bugs": "https://github.com/facebook/react-native/issues", | ||
| "engines": { | ||
| "node": ">=16" | ||
| } | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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`. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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`. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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`. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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`. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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`. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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`. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,14 @@ | ||
| { | ||
| "name": "@react-native/codegen-typescript-test", | ||
| "version": "0.0.1", | ||
| "description": "⚛️ TypeScript related unit test for @react-native/codegen", | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Using symbols like ⚛️ in description is just extra noise for npm and other registries, that too at the start of the descriptions string. Same applies for all |
||
| "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": "*" | ||
| }, | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
git@(old) &git://(new) are more prone to attacks thanhttps://.Reference: https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols
It is very informative read 😃