Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# @react-native/assets-registry

[![Version][version-badge]][package]

## Installation

```
yarn add --dev @react-native/assets-registry
```

*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*

[version-badge]: https://img.shields.io/npm/v/@react-native/assets-registry?style=flat-square
[package]: https://www.npmjs.com/package/@react-native/assets-registry

## Testing

To run the tests in this package, run the following commands from the React Native root folder:

1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/assets`.
7 changes: 5 additions & 2 deletions packages/assets/package.json
Original file line number Diff line number Diff 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",

Copy link
Copy Markdown
Contributor Author

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.git does 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",

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-yadav Pranav-yadav Apr 27, 2023

Copy link
Copy Markdown
Contributor Author

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.

Copy link
Copy Markdown
Contributor Author

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
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# @react-native/babel-plugin-codegen

[![Version][version-badge]][package]

## Installation

```
yarn add --dev @babel/core @react-native/babel-plugin-codegen
```

*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*

[version-badge]: https://img.shields.io/npm/v/@react-native/babel-plugin-codegen?style=flat-square
[package]: https://www.npmjs.com/package/@react-native/babel-plugin-codegen

## Testing

To run the tests in this package, run the following commands from the React Native root folder:

1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/babel-plugin-codegen`.
11 changes: 7 additions & 4 deletions packages/babel-plugin-codegen/package.json
Original file line number Diff line number Diff 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
Original file line number Diff line number Diff 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
Original file line number Diff line number Diff 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
Original file line number Diff line number Diff 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
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# @react-native/eslint-plugin-specs

[![Version][version-badge]][package]

## Installation

```
yarn add --dev @react-native/eslint-plugin-specs
```

*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*

[version-badge]: https://img.shields.io/npm/v/@react-native/eslint-plugin-specs?style=flat-square
[package]: https://www.npmjs.com/package/@react-native/eslint-plugin-specs

## Testing

To run the tests in this package, run the following commands from the React Native root folder:

1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/eslint-plugin-specs`.
11 changes: 7 additions & 4 deletions packages/eslint-plugin-specs/package.json
Original file line number Diff line number Diff 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
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# @react-native/hermes-inspector-msggen

[![Version][version-badge]][package]

## Installation

```
yarn add --dev @babel/cli @babel/core @babel/preset-env @babel/preset-flow jest @react-native/hermes-inspector-msggen
```

*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*

[version-badge]: https://img.shields.io/npm/v/@react-native/hermes-inspector-msggen?style=flat-square
[package]: https://www.npmjs.com/package/@react-native/hermes-inspector-msggen

## Testing

To run the tests in this package, run the following commands from the React Native root folder:

1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/hermes-inspector-msggen`.
8 changes: 7 additions & 1 deletion packages/hermes-inspector-msggen/package.json
Original file line number Diff line number Diff 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
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# @react-native/metro-config

[![Version][version-badge]][package]

## Installation

```
yarn add --dev @react-native/js-polyfills metro-config metro-react-native-babel-transformer metro-runtime @react-native/metro-config
```

*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*

[version-badge]: https://img.shields.io/npm/v/@react-native/metro-config?style=flat-square
[package]: https://www.npmjs.com/package/@react-native/metro-config

## Testing

To run the tests in this package, run the following commands from the React Native root folder:

1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/metro-config`.
7 changes: 5 additions & 2 deletions packages/metro-config/package.json
Original file line number Diff line number Diff 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
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# @react-native/normalize-colors

[![Version][version-badge]][package]

## Installation

```
yarn add --dev @react-native/normalize-colors
```

*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*

[version-badge]: https://img.shields.io/npm/v/@react-native/normalize-colors?style=flat-square
[package]: https://www.npmjs.com/package/@react-native/normalize-colors

## Testing

To run the tests in this package, run the following commands from the React Native root folder:

1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/normalize-color`.
7 changes: 5 additions & 2 deletions packages/normalize-color/package.json
Original file line number Diff line number Diff 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
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# @react-native/js-polyfills

[![Version][version-badge]][package]

## Installation

```
yarn add @react-native/js-polyfills
```

*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*

[version-badge]: https://img.shields.io/npm/v/@react-native/js-polyfills?style=flat-square
[package]: https://www.npmjs.com/package/@react-native/js-polyfills

## Testing

To run the tests in this package, run the following commands from the React Native root folder:

1. `yarn` to install the dependencies. You just need to run this once
2. `yarn jest packages/polyfills`.
7 changes: 5 additions & 2 deletions packages/polyfills/package.json
Original file line number Diff line number Diff 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
Original file line number Diff line number Diff 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
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
{
"name": "@react-native/codegen-typescript-test",
"version": "0.0.1",
"description": "⚛️ TypeScript related unit test for @react-native/codegen",

@Pranav-yadav Pranav-yadav Apr 27, 2023

Copy link
Copy Markdown
Contributor Author

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 all package.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