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

Pranav-yadav · 2023-04-25T20:25:59Z

Summary:

This diff adds missing README files for all public RN packages.

Changes:

For all public RN packages:

Add Missing READMEs

Update package.json in all RN packages to add:

Issues, Bugs urls
Keywords and Homepage urls to respective pkgs

Changelog:

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

Test Plan:

yarn lint && yarn flow && yarn test-ci --> should be green

analysis-bot · 2023-04-25T20:49:17Z

Platform	Engine	Arch	Size (bytes)	Diff
android	hermes	arm64-v8a	8,499,710	+0
android	hermes	armeabi-v7a	7,833,554	+0
android	hermes	x86	8,977,657	+0
android	hermes	x86_64	8,834,477	+0
android	jsc	arm64-v8a	9,064,270	+0
android	jsc	armeabi-v7a	8,275,566	+0
android	jsc	x86	9,113,565	+0
android	jsc	x86_64	9,374,032	+0

Base commit: b0cf746
Branch: main

Pranav-yadav · 2023-04-26T13:39:20Z

This PR is stacked on "Update Node.js to v16".

~~TODO: Rebase once that PR is merged.~~ Rebased.

Note: I'll be unavailable due to uni. exams, if everything is okay, then please rebase (try slash rebase command) and merge or suggest and commit changes (edits allowed to maintainers) 👍

Pranav-yadav · 2023-04-27T16:43:13Z

packages/react-native-codegen-typescript-test/package.json

 {
  "name": "@react-native/codegen-typescript-test",
  "version": "0.0.1",
-  "description": "⚛️ TypeScript related unit test for @react-native/codegen",


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.

Pranav-yadav · 2023-04-27T16:57:06Z

packages/assets/package.json

+  "license": "MIT",
  "repository": {
    "type": "git",
-    "url": "git@github.com:facebook/react-native.git",


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 [[email protected]]: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 😃

Pranav-yadav · 2023-04-27T17:04:33Z

Update: Had some free time, so rebased & resolved the conflicts 😅.

@hoxyq I've left self review above explaining why particular changes are done.
Also about adding more info to respective READMEs, I guess (contributors/maintainers) can iteratively do that as per convenience and shouldn't be a blocker for merging.

cc: @cortinico

packages/assets/README.md

packages/babel-plugin-codegen/README.md

packages/eslint-plugin-specs/README.md

packages/hermes-inspector-msggen/README.md

packages/metro-config/README.md

packages/normalize-color/README.md

packages/polyfills/README.md

hoxyq · 2023-04-27T19:47:24Z

packages/react-native/package.json

+    "directory": "packages/react-native"
+  },
+  "homepage": "https://reactnative.dev/",
+  "keywords": ["react", "react-native", "android", "ios", "mobile", "cross-platform", "app-framework", "mobile-development"],


@cortinico

Are we okay with these keywords?

PS. I took them from keyword on RN gh repo page :)

packages/virtualized-lists/README.md

hoxyq · 2023-04-27T19:52:08Z

packages/assets/package.json

    "directory": "packages/assets"
  },
-  "license": "MIT",
+  "homepage": "https://github.com/facebook/react-native/tree/HEAD/packages/assets#readme",


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

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.

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

Pranav-yadav · 2023-04-27T20:36:22Z

Rebased & addressed suggestions re: jest testing syntax 👍

For all public RN packages: - Add missing READMEs - Add issues, bugs urls - Add keywords and homepage urls to respective pkgs

facebook-github-bot · 2023-04-28T09:22:23Z

@hoxyq has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

facebook-github-bot · 2023-04-28T11:33:03Z

@hoxyq merged this pull request in 14316bd.

…k#37090) Summary: This diff adds _missing_ README files for all public RN packages. #### Changes: For all public RN packages: - Add _Missing_ READMEs Update package.json in all RN packages to add: - Issues, Bugs urls - Keywords and Homepage urls to respective pkgs ## Changelog: [GENERAL][ADDED] - Add missing README files for all public RN packages. [GENERAL][CHANGED] - Update package.json in all RN packages to add required fields. Pull Request resolved: facebook#37090 Test Plan: - `yarn lint && yarn flow && yarn test-ci` --> _should be green_ Reviewed By: cortinico Differential Revision: D45390861 Pulled By: hoxyq fbshipit-source-id: 524a92de56a7cb553573d9f54ccf40a998dfd35f

facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Apr 25, 2023

Pranav-yadav mentioned this pull request Apr 25, 2023

Update Node.js to v16 in all RN packages #37073

Closed

cortinico requested a review from hoxyq April 27, 2023 10:59

Pranav-yadav force-pushed the update-packageJsons branch from 4050d28 to 85d3519 Compare April 27, 2023 16:35

Pranav-yadav commented Apr 27, 2023

View reviewed changes

Pranav-yadav marked this pull request as ready for review April 27, 2023 17:04

hoxyq reviewed Apr 27, 2023

View reviewed changes

Pranav-yadav force-pushed the update-packageJsons branch from 85d3519 to 03c1116 Compare April 27, 2023 20:31

Pranav-yadav requested a review from hoxyq April 27, 2023 20:37

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

88ab7a1

For all public RN packages: - Add missing READMEs - Add issues, bugs urls - Add keywords and homepage urls to respective pkgs

Pranav-yadav force-pushed the update-packageJsons branch from 03c1116 to 88ab7a1 Compare April 27, 2023 20:47

hoxyq approved these changes Apr 28, 2023

View reviewed changes

facebook-github-bot closed this in 14316bd Apr 28, 2023

facebook-github-bot added the Merged This PR has been merged. label Apr 28, 2023

Pranav-yadav deleted the update-packageJsons branch April 28, 2023 12:13

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

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

Uh oh!

Conversation

Pranav-yadav commented Apr 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary:

Changes:

Changelog:

Test Plan:

Uh oh!

analysis-bot commented Apr 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Pranav-yadav commented Apr 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Pranav-yadav Apr 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Pranav-yadav Apr 27, 2023

Choose a reason for hiding this comment

Uh oh!

Pranav-yadav commented Apr 27, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hoxyq Apr 27, 2023

Choose a reason for hiding this comment

Uh oh!

Pranav-yadav Apr 27, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hoxyq Apr 27, 2023

Choose a reason for hiding this comment

Uh oh!

Pranav-yadav Apr 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Pranav-yadav Apr 27, 2023

Choose a reason for hiding this comment

Uh oh!

Pranav-yadav commented Apr 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

facebook-github-bot commented Apr 28, 2023

Uh oh!

facebook-github-bot commented Apr 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Pranav-yadav commented Apr 25, 2023 •

edited

Loading

analysis-bot commented Apr 25, 2023 •

edited

Loading

Pranav-yadav commented Apr 26, 2023 •

edited

Loading

Pranav-yadav Apr 27, 2023 •

edited

Loading

Pranav-yadav Apr 27, 2023 •

edited

Loading

Pranav-yadav commented Apr 27, 2023 •

edited

Loading