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.

Sign up for GitHub

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

Closed
Pranav-yadav wants to merge 1 commit into from
Closed

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions packages/assets/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff 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`.
7 changes: 5 additions & 2 deletions packages/assets/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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",

@Pranav-yadavPranav-yadavApr 27, 2023

Copy link
Copy Markdown
ContributorAuthor

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 than https://.

Due to the lack of TLS or other cryptography, cloning over git://might lead to an arbitrary code execution vulnerability, and should therefore be avoided unless you know what you are doing.

If you run git clone git://example.com/project.git, an attacker who controls e.g your router can modify the repo you just cloned, inserting malicious code into it. If you then compile/run the code you just cloned, you will execute the malicious code. Running git clone http://example.com/project.git should be avoided for the same reason.

Running git clone https://example.com/project.gitdoes not suffer from the same problem (unless the attacker can provide a TLS certificate for example.com). Running git clone [git@example.com]:project.git only suffers from this problem if you accept a wrong ssh key fingerprint.

Reference: https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols
It is very informative read 😃

"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",

@hoxyqhoxyqApr 27, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the purpose of #readme suffix in all these links? Do we want to navigate to README file?

@Pranav-yadavPranav-yadavApr 27, 2023•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The 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.
PS. If you look closely exact similar links are already used in RN packages.

@Pranav-yadavPranav-yadavApr 27, 2023

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, #... is just a "fragment" and won't break urls in any case.

"keywords": ["assets", "registry", "react-native", "support"],
"bugs": "https://github.com/facebook/react-native/issues",
"engines": {
"node": ">=16"
}
Expand Down
21 changes: 21 additions & 0 deletions packages/babel-plugin-codegen/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff 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`.
11 changes: 7 additions & 4 deletions packages/babel-plugin-codegen/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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"
},
Expand All@@ -18,6 +22,5 @@
},
"devDependencies": {
"@babel/core": "^7.20.0"
},
"license": "MIT"
}
}
6 changes: 4 additions & 2 deletions packages/eslint-config-react-native-community/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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",
Expand Down
7 changes: 7 additions & 0 deletions packages/eslint-plugin-react-native-community/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 changes: 7 additions & 4 deletions packages/eslint-plugin-react-native-community/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 changes: 21 additions & 0 deletions packages/eslint-plugin-specs/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff 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`.
11 changes: 7 additions & 4 deletions packages/eslint-plugin-specs/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
Expand All@@ -25,6 +29,5 @@
"make-dir": "^2.1.0",
"pirates": "^4.0.1",
"source-map-support": "0.5.0"
},
"license": "MIT"
}
}
21 changes: 21 additions & 0 deletions packages/hermes-inspector-msggen/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff 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`.
8 changes: 7 additions & 1 deletion packages/hermes-inspector-msggen/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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"
},
Expand Down
21 changes: 21 additions & 0 deletions packages/metro-config/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff 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`.
7 changes: 5 additions & 2 deletions packages/metro-config/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
},
Expand Down
21 changes: 21 additions & 0 deletions packages/normalize-color/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff 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`.
7 changes: 5 additions & 2 deletions packages/normalize-color/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
}
Expand Down
21 changes: 21 additions & 0 deletions packages/polyfills/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff 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`.
7 changes: 5 additions & 2 deletions packages/polyfills/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
}
Expand Down
8 changes: 8 additions & 0 deletions packages/react-native-bots/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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"
},
Expand Down
8 changes: 4 additions & 4 deletions packages/react-native-codegen-typescript-test/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff 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",

@Pranav-yadavPranav-yadavApr 27, 2023•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The 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.
Removing such symbols should make the search easier and should make the packages more accessible.

Same applies for allpackage.json files.

"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"
},
Expand All@@ -16,7 +17,6 @@
"clean": "rimraf lib && rimraf __generated__/*.ts",
"prepare": "yarn run build"
},
"license": "MIT",
"dependencies": {
"@react-native/codegen": "*"
},
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
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.

 Sign up for GitHub

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

 Closed

Pranav-yadav
wants to merge
1
commit into

from

 Closed


Add missing READMEs & Update package.json in all RN packages
#37090
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 21 additions & 0 deletions
packages/assets/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/assets/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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",
@Pranav-yadavPranav-yadavApr 27, 2023

Copy link


Copy Markdown

ContributorAuthor
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 than https://.
Due to the lack of TLS or other cryptography, cloning over git://might lead to an arbitrary code execution vulnerability, and should therefore be avoided unless you know what you are doing.
If you run git clone git://example.com/project.git, an attacker who controls e.g your router can modify the repo you just cloned, inserting malicious code into it. If you then compile/run the code you just cloned, you will execute the malicious code. Running git clone http://example.com/project.git should be avoided for the same reason.
Running git clone https://example.com/project.gitdoes not suffer from the same problem (unless the attacker can provide a TLS certificate for example.com). Running git clone [git@example.com]:project.git only suffers from this problem if you accept a wrong ssh key fingerprint.
Reference: https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols

It is very informative read 😃
 "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",
@hoxyqhoxyqApr 27, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the purpose of #readme suffix in all these links? Do we want to navigate to README file?
@Pranav-yadavPranav-yadavApr 27, 2023•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The 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.

PS. If you look closely exact similar links are already used in RN packages.
@Pranav-yadavPranav-yadavApr 27, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, #... is just a "fragment" and won't break urls in any case.
 "keywords": ["assets", "registry", "react-native", "support"],
 "bugs": "https://github.com/facebook/react-native/issues",
 "engines": {
 "node": ">=16"
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/babel-plugin-codegen/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

11 changes: 7 additions & 4 deletions
packages/babel-plugin-codegen/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand All@@ -18,6 +22,5 @@
 },
 "devDependencies": {
 "@babel/core": "^7.20.0"
 },
 "license": "MIT"
 }
}

6 changes: 4 additions & 2 deletions
packages/eslint-config-react-native-community/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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",
Expand Down

7 changes: 7 additions & 0 deletions
packages/eslint-plugin-react-native-community/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 changes: 7 additions & 4 deletions
packages/eslint-plugin-react-native-community/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 changes: 21 additions & 0 deletions
packages/eslint-plugin-specs/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

11 changes: 7 additions & 4 deletions
packages/eslint-plugin-specs/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
Expand All@@ -25,6 +29,5 @@
 "make-dir": "^2.1.0",
 "pirates": "^4.0.1",
 "source-map-support": "0.5.0"
 },
 "license": "MIT"
 }
}

21 changes: 21 additions & 0 deletions
packages/hermes-inspector-msggen/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

8 changes: 7 additions & 1 deletion
packages/hermes-inspector-msggen/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand Down

21 changes: 21 additions & 0 deletions
packages/metro-config/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/metro-config/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 },
Expand Down

21 changes: 21 additions & 0 deletions
packages/normalize-color/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/normalize-color/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/polyfills/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/polyfills/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 }
Expand Down

8 changes: 8 additions & 0 deletions
packages/react-native-bots/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand Down

8 changes: 4 additions & 4 deletions
packages/react-native-codegen-typescript-test/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff 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",
@Pranav-yadavPranav-yadavApr 27, 2023•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The 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.
Removing such symbols should make the search easier and should make the packages more accessible.
Same applies for allpackage.json files.
 "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"
 },
Expand All@@ -16,7 +17,6 @@
 "clean": "rimraf lib && rimraf __generated__/*.ts",
 "prepare": "yarn run build"
 },
 "license": "MIT",
 "dependencies": {
 "@react-native/codegen": "*"
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
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.

 Sign up for GitHub

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

 Closed

Pranav-yadav
wants to merge
1
commit into

from

 Closed


Add missing READMEs & Update package.json in all RN packages
#37090
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 21 additions & 0 deletions
packages/assets/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/assets/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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",
@Pranav-yadavPranav-yadavApr 27, 2023

Copy link


Copy Markdown

ContributorAuthor
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 than https://.
Due to the lack of TLS or other cryptography, cloning over git://might lead to an arbitrary code execution vulnerability, and should therefore be avoided unless you know what you are doing.
If you run git clone git://example.com/project.git, an attacker who controls e.g your router can modify the repo you just cloned, inserting malicious code into it. If you then compile/run the code you just cloned, you will execute the malicious code. Running git clone http://example.com/project.git should be avoided for the same reason.
Running git clone https://example.com/project.gitdoes not suffer from the same problem (unless the attacker can provide a TLS certificate for example.com). Running git clone [git@example.com]:project.git only suffers from this problem if you accept a wrong ssh key fingerprint.
Reference: https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols

It is very informative read 😃
 "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",
@hoxyqhoxyqApr 27, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the purpose of #readme suffix in all these links? Do we want to navigate to README file?
@Pranav-yadavPranav-yadavApr 27, 2023•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The 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.

PS. If you look closely exact similar links are already used in RN packages.
@Pranav-yadavPranav-yadavApr 27, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, #... is just a "fragment" and won't break urls in any case.
 "keywords": ["assets", "registry", "react-native", "support"],
 "bugs": "https://github.com/facebook/react-native/issues",
 "engines": {
 "node": ">=16"
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/babel-plugin-codegen/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

11 changes: 7 additions & 4 deletions
packages/babel-plugin-codegen/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand All@@ -18,6 +22,5 @@
 },
 "devDependencies": {
 "@babel/core": "^7.20.0"
 },
 "license": "MIT"
 }
}

6 changes: 4 additions & 2 deletions
packages/eslint-config-react-native-community/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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",
Expand Down

7 changes: 7 additions & 0 deletions
packages/eslint-plugin-react-native-community/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 changes: 7 additions & 4 deletions
packages/eslint-plugin-react-native-community/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 changes: 21 additions & 0 deletions
packages/eslint-plugin-specs/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

11 changes: 7 additions & 4 deletions
packages/eslint-plugin-specs/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
Expand All@@ -25,6 +29,5 @@
 "make-dir": "^2.1.0",
 "pirates": "^4.0.1",
 "source-map-support": "0.5.0"
 },
 "license": "MIT"
 }
}

21 changes: 21 additions & 0 deletions
packages/hermes-inspector-msggen/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

8 changes: 7 additions & 1 deletion
packages/hermes-inspector-msggen/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand Down

21 changes: 21 additions & 0 deletions
packages/metro-config/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/metro-config/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 },
Expand Down

21 changes: 21 additions & 0 deletions
packages/normalize-color/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/normalize-color/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/polyfills/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/polyfills/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 }
Expand Down

8 changes: 8 additions & 0 deletions
packages/react-native-bots/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand Down

8 changes: 4 additions & 4 deletions
packages/react-native-codegen-typescript-test/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff 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",
@Pranav-yadavPranav-yadavApr 27, 2023•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The 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.
Removing such symbols should make the search easier and should make the packages more accessible.
Same applies for allpackage.json files.
 "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"
 },
Expand All@@ -16,7 +17,6 @@
 "clean": "rimraf lib && rimraf __generated__/*.ts",
 "prepare": "yarn run build"
 },
 "license": "MIT",
 "dependencies": {
 "@react-native/codegen": "*"
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
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.

 Sign up for GitHub

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

 Closed

Pranav-yadav
wants to merge
1
commit into

from

 Closed


Add missing READMEs & Update package.json in all RN packages
#37090
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 21 additions & 0 deletions
packages/assets/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/assets/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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",
@Pranav-yadavPranav-yadavApr 27, 2023

Copy link


Copy Markdown

ContributorAuthor
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 than https://.
Due to the lack of TLS or other cryptography, cloning over git://might lead to an arbitrary code execution vulnerability, and should therefore be avoided unless you know what you are doing.
If you run git clone git://example.com/project.git, an attacker who controls e.g your router can modify the repo you just cloned, inserting malicious code into it. If you then compile/run the code you just cloned, you will execute the malicious code. Running git clone http://example.com/project.git should be avoided for the same reason.
Running git clone https://example.com/project.gitdoes not suffer from the same problem (unless the attacker can provide a TLS certificate for example.com). Running git clone [git@example.com]:project.git only suffers from this problem if you accept a wrong ssh key fingerprint.
Reference: https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols

It is very informative read 😃
 "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",
@hoxyqhoxyqApr 27, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the purpose of #readme suffix in all these links? Do we want to navigate to README file?
@Pranav-yadavPranav-yadavApr 27, 2023•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The 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.

PS. If you look closely exact similar links are already used in RN packages.
@Pranav-yadavPranav-yadavApr 27, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, #... is just a "fragment" and won't break urls in any case.
 "keywords": ["assets", "registry", "react-native", "support"],
 "bugs": "https://github.com/facebook/react-native/issues",
 "engines": {
 "node": ">=16"
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/babel-plugin-codegen/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

11 changes: 7 additions & 4 deletions
packages/babel-plugin-codegen/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand All@@ -18,6 +22,5 @@
 },
 "devDependencies": {
 "@babel/core": "^7.20.0"
 },
 "license": "MIT"
 }
}

6 changes: 4 additions & 2 deletions
packages/eslint-config-react-native-community/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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",
Expand Down

7 changes: 7 additions & 0 deletions
packages/eslint-plugin-react-native-community/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 changes: 7 additions & 4 deletions
packages/eslint-plugin-react-native-community/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 changes: 21 additions & 0 deletions
packages/eslint-plugin-specs/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

11 changes: 7 additions & 4 deletions
packages/eslint-plugin-specs/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
Expand All@@ -25,6 +29,5 @@
 "make-dir": "^2.1.0",
 "pirates": "^4.0.1",
 "source-map-support": "0.5.0"
 },
 "license": "MIT"
 }
}

21 changes: 21 additions & 0 deletions
packages/hermes-inspector-msggen/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

8 changes: 7 additions & 1 deletion
packages/hermes-inspector-msggen/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand Down

21 changes: 21 additions & 0 deletions
packages/metro-config/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/metro-config/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 },
Expand Down

21 changes: 21 additions & 0 deletions
packages/normalize-color/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/normalize-color/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/polyfills/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/polyfills/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 }
Expand Down

8 changes: 8 additions & 0 deletions
packages/react-native-bots/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand Down

8 changes: 4 additions & 4 deletions
packages/react-native-codegen-typescript-test/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff 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",
@Pranav-yadavPranav-yadavApr 27, 2023•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The 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.
Removing such symbols should make the search easier and should make the packages more accessible.
Same applies for allpackage.json files.
 "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"
 },
Expand All@@ -16,7 +17,6 @@
 "clean": "rimraf lib && rimraf __generated__/*.ts",
 "prepare": "yarn run build"
 },
 "license": "MIT",
 "dependencies": {
 "@react-native/codegen": "*"
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
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.

 Sign up for GitHub

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

 Closed

Pranav-yadav
wants to merge
1
commit into

from

 Closed


Add missing READMEs & Update package.json in all RN packages
#37090
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 21 additions & 0 deletions
packages/assets/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/assets/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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",
@Pranav-yadavPranav-yadavApr 27, 2023

Copy link


Copy Markdown

ContributorAuthor
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 than https://.
Due to the lack of TLS or other cryptography, cloning over git://might lead to an arbitrary code execution vulnerability, and should therefore be avoided unless you know what you are doing.
If you run git clone git://example.com/project.git, an attacker who controls e.g your router can modify the repo you just cloned, inserting malicious code into it. If you then compile/run the code you just cloned, you will execute the malicious code. Running git clone http://example.com/project.git should be avoided for the same reason.
Running git clone https://example.com/project.gitdoes not suffer from the same problem (unless the attacker can provide a TLS certificate for example.com). Running git clone [git@example.com]:project.git only suffers from this problem if you accept a wrong ssh key fingerprint.
Reference: https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols

It is very informative read 😃
 "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",
@hoxyqhoxyqApr 27, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the purpose of #readme suffix in all these links? Do we want to navigate to README file?
@Pranav-yadavPranav-yadavApr 27, 2023•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The 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.

PS. If you look closely exact similar links are already used in RN packages.
@Pranav-yadavPranav-yadavApr 27, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, #... is just a "fragment" and won't break urls in any case.
 "keywords": ["assets", "registry", "react-native", "support"],
 "bugs": "https://github.com/facebook/react-native/issues",
 "engines": {
 "node": ">=16"
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/babel-plugin-codegen/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

11 changes: 7 additions & 4 deletions
packages/babel-plugin-codegen/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand All@@ -18,6 +22,5 @@
 },
 "devDependencies": {
 "@babel/core": "^7.20.0"
 },
 "license": "MIT"
 }
}

6 changes: 4 additions & 2 deletions
packages/eslint-config-react-native-community/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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",
Expand Down

7 changes: 7 additions & 0 deletions
packages/eslint-plugin-react-native-community/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 changes: 7 additions & 4 deletions
packages/eslint-plugin-react-native-community/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 changes: 21 additions & 0 deletions
packages/eslint-plugin-specs/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

11 changes: 7 additions & 4 deletions
packages/eslint-plugin-specs/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
Expand All@@ -25,6 +29,5 @@
 "make-dir": "^2.1.0",
 "pirates": "^4.0.1",
 "source-map-support": "0.5.0"
 },
 "license": "MIT"
 }
}

21 changes: 21 additions & 0 deletions
packages/hermes-inspector-msggen/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

8 changes: 7 additions & 1 deletion
packages/hermes-inspector-msggen/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand Down

21 changes: 21 additions & 0 deletions
packages/metro-config/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/metro-config/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 },
Expand Down

21 changes: 21 additions & 0 deletions
packages/normalize-color/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/normalize-color/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/polyfills/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/polyfills/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 }
Expand Down

8 changes: 8 additions & 0 deletions
packages/react-native-bots/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand Down

8 changes: 4 additions & 4 deletions
packages/react-native-codegen-typescript-test/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff 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",
@Pranav-yadavPranav-yadavApr 27, 2023•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The 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.
Removing such symbols should make the search easier and should make the packages more accessible.
Same applies for allpackage.json files.
 "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"
 },
Expand All@@ -16,7 +17,6 @@
 "clean": "rimraf lib && rimraf __generated__/*.ts",
 "prepare": "yarn run build"
 },
 "license": "MIT",
 "dependencies": {
 "@react-native/codegen": "*"
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
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.

 Sign up for GitHub

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

 Closed

Pranav-yadav
wants to merge
1
commit into

from

 Closed


Add missing READMEs & Update package.json in all RN packages
#37090
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 21 additions & 0 deletions
packages/assets/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/assets/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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",
@Pranav-yadavPranav-yadavApr 27, 2023

Copy link


Copy Markdown

ContributorAuthor
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 than https://.
Due to the lack of TLS or other cryptography, cloning over git://might lead to an arbitrary code execution vulnerability, and should therefore be avoided unless you know what you are doing.
If you run git clone git://example.com/project.git, an attacker who controls e.g your router can modify the repo you just cloned, inserting malicious code into it. If you then compile/run the code you just cloned, you will execute the malicious code. Running git clone http://example.com/project.git should be avoided for the same reason.
Running git clone https://example.com/project.gitdoes not suffer from the same problem (unless the attacker can provide a TLS certificate for example.com). Running git clone [git@example.com]:project.git only suffers from this problem if you accept a wrong ssh key fingerprint.
Reference: https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols

It is very informative read 😃
 "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",
@hoxyqhoxyqApr 27, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the purpose of #readme suffix in all these links? Do we want to navigate to README file?
@Pranav-yadavPranav-yadavApr 27, 2023•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The 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.

PS. If you look closely exact similar links are already used in RN packages.
@Pranav-yadavPranav-yadavApr 27, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, #... is just a "fragment" and won't break urls in any case.
 "keywords": ["assets", "registry", "react-native", "support"],
 "bugs": "https://github.com/facebook/react-native/issues",
 "engines": {
 "node": ">=16"
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/babel-plugin-codegen/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

11 changes: 7 additions & 4 deletions
packages/babel-plugin-codegen/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand All@@ -18,6 +22,5 @@
 },
 "devDependencies": {
 "@babel/core": "^7.20.0"
 },
 "license": "MIT"
 }
}

6 changes: 4 additions & 2 deletions
packages/eslint-config-react-native-community/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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",
Expand Down

7 changes: 7 additions & 0 deletions
packages/eslint-plugin-react-native-community/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 changes: 7 additions & 4 deletions
packages/eslint-plugin-react-native-community/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 changes: 21 additions & 0 deletions
packages/eslint-plugin-specs/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

11 changes: 7 additions & 4 deletions
packages/eslint-plugin-specs/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
Expand All@@ -25,6 +29,5 @@
 "make-dir": "^2.1.0",
 "pirates": "^4.0.1",
 "source-map-support": "0.5.0"
 },
 "license": "MIT"
 }
}

21 changes: 21 additions & 0 deletions
packages/hermes-inspector-msggen/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

8 changes: 7 additions & 1 deletion
packages/hermes-inspector-msggen/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand Down

21 changes: 21 additions & 0 deletions
packages/metro-config/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/metro-config/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 },
Expand Down

21 changes: 21 additions & 0 deletions
packages/normalize-color/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/normalize-color/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/polyfills/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/polyfills/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 }
Expand Down

8 changes: 8 additions & 0 deletions
packages/react-native-bots/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand Down

8 changes: 4 additions & 4 deletions
packages/react-native-codegen-typescript-test/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff 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",
@Pranav-yadavPranav-yadavApr 27, 2023•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The 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.
Removing such symbols should make the search easier and should make the packages more accessible.
Same applies for allpackage.json files.
 "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"
 },
Expand All@@ -16,7 +17,6 @@
 "clean": "rimraf lib && rimraf __generated__/*.ts",
 "prepare": "yarn run build"
 },
 "license": "MIT",
 "dependencies": {
 "@react-native/codegen": "*"
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
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.

 Sign up for GitHub

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

 Closed

Pranav-yadav
wants to merge
1
commit into

from

 Closed


Add missing READMEs & Update package.json in all RN packages
#37090
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 21 additions & 0 deletions
packages/assets/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/assets/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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",
@Pranav-yadavPranav-yadavApr 27, 2023

Copy link


Copy Markdown

ContributorAuthor
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 than https://.
Due to the lack of TLS or other cryptography, cloning over git://might lead to an arbitrary code execution vulnerability, and should therefore be avoided unless you know what you are doing.
If you run git clone git://example.com/project.git, an attacker who controls e.g your router can modify the repo you just cloned, inserting malicious code into it. If you then compile/run the code you just cloned, you will execute the malicious code. Running git clone http://example.com/project.git should be avoided for the same reason.
Running git clone https://example.com/project.gitdoes not suffer from the same problem (unless the attacker can provide a TLS certificate for example.com). Running git clone [git@example.com]:project.git only suffers from this problem if you accept a wrong ssh key fingerprint.
Reference: https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols

It is very informative read 😃
 "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",
@hoxyqhoxyqApr 27, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the purpose of #readme suffix in all these links? Do we want to navigate to README file?
@Pranav-yadavPranav-yadavApr 27, 2023•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The 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.

PS. If you look closely exact similar links are already used in RN packages.
@Pranav-yadavPranav-yadavApr 27, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, #... is just a "fragment" and won't break urls in any case.
 "keywords": ["assets", "registry", "react-native", "support"],
 "bugs": "https://github.com/facebook/react-native/issues",
 "engines": {
 "node": ">=16"
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/babel-plugin-codegen/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

11 changes: 7 additions & 4 deletions
packages/babel-plugin-codegen/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand All@@ -18,6 +22,5 @@
 },
 "devDependencies": {
 "@babel/core": "^7.20.0"
 },
 "license": "MIT"
 }
}

6 changes: 4 additions & 2 deletions
packages/eslint-config-react-native-community/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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",
Expand Down

7 changes: 7 additions & 0 deletions
packages/eslint-plugin-react-native-community/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 changes: 7 additions & 4 deletions
packages/eslint-plugin-react-native-community/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 changes: 21 additions & 0 deletions
packages/eslint-plugin-specs/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

11 changes: 7 additions & 4 deletions
packages/eslint-plugin-specs/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
Expand All@@ -25,6 +29,5 @@
 "make-dir": "^2.1.0",
 "pirates": "^4.0.1",
 "source-map-support": "0.5.0"
 },
 "license": "MIT"
 }
}

21 changes: 21 additions & 0 deletions
packages/hermes-inspector-msggen/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

8 changes: 7 additions & 1 deletion
packages/hermes-inspector-msggen/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand Down

21 changes: 21 additions & 0 deletions
packages/metro-config/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/metro-config/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 },
Expand Down

21 changes: 21 additions & 0 deletions
packages/normalize-color/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/normalize-color/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/polyfills/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/polyfills/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 }
Expand Down

8 changes: 8 additions & 0 deletions
packages/react-native-bots/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand Down

8 changes: 4 additions & 4 deletions
packages/react-native-codegen-typescript-test/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff 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",
@Pranav-yadavPranav-yadavApr 27, 2023•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The 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.
Removing such symbols should make the search easier and should make the packages more accessible.
Same applies for allpackage.json files.
 "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"
 },
Expand All@@ -16,7 +17,6 @@
 "clean": "rimraf lib && rimraf __generated__/*.ts",
 "prepare": "yarn run build"
 },
 "license": "MIT",
 "dependencies": {
 "@react-native/codegen": "*"
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
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.

 Sign up for GitHub

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

 Closed

Pranav-yadav
wants to merge
1
commit into

from

 Closed


Add missing READMEs & Update package.json in all RN packages
#37090
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 21 additions & 0 deletions
packages/assets/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/assets/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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",
@Pranav-yadavPranav-yadavApr 27, 2023

Copy link


Copy Markdown

ContributorAuthor
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 than https://.
Due to the lack of TLS or other cryptography, cloning over git://might lead to an arbitrary code execution vulnerability, and should therefore be avoided unless you know what you are doing.
If you run git clone git://example.com/project.git, an attacker who controls e.g your router can modify the repo you just cloned, inserting malicious code into it. If you then compile/run the code you just cloned, you will execute the malicious code. Running git clone http://example.com/project.git should be avoided for the same reason.
Running git clone https://example.com/project.gitdoes not suffer from the same problem (unless the attacker can provide a TLS certificate for example.com). Running git clone [git@example.com]:project.git only suffers from this problem if you accept a wrong ssh key fingerprint.
Reference: https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols

It is very informative read 😃
 "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",
@hoxyqhoxyqApr 27, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the purpose of #readme suffix in all these links? Do we want to navigate to README file?
@Pranav-yadavPranav-yadavApr 27, 2023•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The 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.

PS. If you look closely exact similar links are already used in RN packages.
@Pranav-yadavPranav-yadavApr 27, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, #... is just a "fragment" and won't break urls in any case.
 "keywords": ["assets", "registry", "react-native", "support"],
 "bugs": "https://github.com/facebook/react-native/issues",
 "engines": {
 "node": ">=16"
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/babel-plugin-codegen/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

11 changes: 7 additions & 4 deletions
packages/babel-plugin-codegen/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand All@@ -18,6 +22,5 @@
 },
 "devDependencies": {
 "@babel/core": "^7.20.0"
 },
 "license": "MIT"
 }
}

6 changes: 4 additions & 2 deletions
packages/eslint-config-react-native-community/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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",
Expand Down

7 changes: 7 additions & 0 deletions
packages/eslint-plugin-react-native-community/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 changes: 7 additions & 4 deletions
packages/eslint-plugin-react-native-community/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 changes: 21 additions & 0 deletions
packages/eslint-plugin-specs/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

11 changes: 7 additions & 4 deletions
packages/eslint-plugin-specs/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
Expand All@@ -25,6 +29,5 @@
 "make-dir": "^2.1.0",
 "pirates": "^4.0.1",
 "source-map-support": "0.5.0"
 },
 "license": "MIT"
 }
}

21 changes: 21 additions & 0 deletions
packages/hermes-inspector-msggen/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

8 changes: 7 additions & 1 deletion
packages/hermes-inspector-msggen/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand Down

21 changes: 21 additions & 0 deletions
packages/metro-config/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/metro-config/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 },
Expand Down

21 changes: 21 additions & 0 deletions
packages/normalize-color/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/normalize-color/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 }
Expand Down

21 changes: 21 additions & 0 deletions
packages/polyfills/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff 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`.

7 changes: 5 additions & 2 deletions
packages/polyfills/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
 }
Expand Down

8 changes: 8 additions & 0 deletions
packages/react-native-bots/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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"
 },
Expand Down

8 changes: 4 additions & 4 deletions
packages/react-native-codegen-typescript-test/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff 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",
@Pranav-yadavPranav-yadavApr 27, 2023•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The 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.
Removing such symbols should make the search easier and should make the packages more accessible.
Same applies for allpackage.json files.
 "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"
 },
Expand All@@ -16,7 +17,6 @@
 "clean": "rimraf lib && rimraf __generated__/*.ts",
 "prepare": "yarn run build"
 },
 "license": "MIT",
 "dependencies": {
 "@react-native/codegen": "*"
 },
Expand Down
Loading