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

Closed
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:update-packageJsons
Closed

Add missing READMEs & Update package.json in all RN packages#37090
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:update-packageJsons

Conversation

@Pranav-yadav

@Pranav-yadavPranav-yadav commented Apr 25, 2023

Copy link
Copy Markdown
Contributor

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

@facebook-github-botfacebook-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
@analysis-bot

analysis-bot commented Apr 25, 2023

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,499,710+0
androidhermesarmeabi-v7a7,833,554+0
androidhermesx868,977,657+0
androidhermesx86_648,834,477+0
androidjscarm64-v8a9,064,270+0
androidjscarmeabi-v7a8,275,566+0
androidjscx869,113,565+0
androidjscx86_649,374,032+0

Base commit: b0cf746
Branch: main

@Pranav-yadav

Pranav-yadav commented Apr 26, 2023

Copy link
Copy Markdown
ContributorAuthor

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) 👍

@cortinico
cortinico requested a review from hoxyqApril 27, 2023 10:59

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

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.

Comment threadpackages/assets/package.json Outdated

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 😃

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

@Pranav-yadav
Pranav-yadav marked this pull request as ready for review April 27, 2023 17:04
Comment threadpackages/assets/README.md Outdated
Comment threadpackages/babel-plugin-codegen/README.md Outdated
Comment threadpackages/eslint-plugin-specs/README.md Outdated
Comment threadpackages/hermes-inspector-msggen/README.md Outdated
Comment threadpackages/metro-config/README.md Outdated
Comment threadpackages/normalize-color/README.md Outdated
Comment threadpackages/polyfills/README.md Outdated
Comment threadpackages/react-native/package.json Outdated

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.

@cortinico

Are we okay with these keywords?

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.

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

Comment threadpackages/virtualized-lists/README.md Outdated
Comment threadpackages/assets/package.json Outdated

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

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.

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.

@Pranav-yadav

Pranav-yadav commented Apr 27, 2023

Copy link
Copy Markdown
ContributorAuthor

Rebased & addressed suggestions re: jest testing syntax 👍

@Pranav-yadav
Pranav-yadav requested a review from hoxyqApril 27, 2023 20:37
For all public RN packages:
- Add missing READMEs
- Add issues, bugs urls
- Add keywords and homepage urls to respective pkgs
@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

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

Copy link
Copy Markdown
Contributor

@hoxyq merged this pull request in 14316bd.

@Pranav-yadav
Pranav-yadav deleted the update-packageJsons branch April 28, 2023 12:13
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.MergedThis PR has been merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@Pranav-yadav@analysis-bot@facebook-github-bot@hoxyq
, '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

Closed
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:update-packageJsons
Closed

Add missing READMEs & Update package.json in all RN packages#37090
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:update-packageJsons

Conversation

@Pranav-yadav

@Pranav-yadavPranav-yadav commented Apr 25, 2023

Copy link
Copy Markdown
Contributor

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

@facebook-github-botfacebook-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
@analysis-bot

analysis-bot commented Apr 25, 2023

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,499,710+0
androidhermesarmeabi-v7a7,833,554+0
androidhermesx868,977,657+0
androidhermesx86_648,834,477+0
androidjscarm64-v8a9,064,270+0
androidjscarmeabi-v7a8,275,566+0
androidjscx869,113,565+0
androidjscx86_649,374,032+0

Base commit: b0cf746
Branch: main

@Pranav-yadav

Pranav-yadav commented Apr 26, 2023

Copy link
Copy Markdown
ContributorAuthor

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) 👍

@cortinico
cortinico requested a review from hoxyqApril 27, 2023 10:59

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

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.

Comment threadpackages/assets/package.json Outdated

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 😃

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

@Pranav-yadav
Pranav-yadav marked this pull request as ready for review April 27, 2023 17:04
Comment threadpackages/assets/README.md Outdated
Comment threadpackages/babel-plugin-codegen/README.md Outdated
Comment threadpackages/eslint-plugin-specs/README.md Outdated
Comment threadpackages/hermes-inspector-msggen/README.md Outdated
Comment threadpackages/metro-config/README.md Outdated
Comment threadpackages/normalize-color/README.md Outdated
Comment threadpackages/polyfills/README.md Outdated
Comment threadpackages/react-native/package.json Outdated

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.

@cortinico

Are we okay with these keywords?

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.

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

Comment threadpackages/virtualized-lists/README.md Outdated
Comment threadpackages/assets/package.json Outdated

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

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.

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.

@Pranav-yadav

Pranav-yadav commented Apr 27, 2023

Copy link
Copy Markdown
ContributorAuthor

Rebased & addressed suggestions re: jest testing syntax 👍

@Pranav-yadav
Pranav-yadav requested a review from hoxyqApril 27, 2023 20:37
For all public RN packages:
- Add missing READMEs
- Add issues, bugs urls
- Add keywords and homepage urls to respective pkgs
@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

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

Copy link
Copy Markdown
Contributor

@hoxyq merged this pull request in 14316bd.

@Pranav-yadav
Pranav-yadav deleted the update-packageJsons branch April 28, 2023 12:13
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.MergedThis PR has been merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@Pranav-yadav@analysis-bot@facebook-github-bot@hoxyq
, '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

Closed
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:update-packageJsons
Closed

Add missing READMEs & Update package.json in all RN packages#37090
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:update-packageJsons

Conversation

@Pranav-yadav

@Pranav-yadavPranav-yadav commented Apr 25, 2023

Copy link
Copy Markdown
Contributor

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

@facebook-github-botfacebook-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
@analysis-bot

analysis-bot commented Apr 25, 2023

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,499,710+0
androidhermesarmeabi-v7a7,833,554+0
androidhermesx868,977,657+0
androidhermesx86_648,834,477+0
androidjscarm64-v8a9,064,270+0
androidjscarmeabi-v7a8,275,566+0
androidjscx869,113,565+0
androidjscx86_649,374,032+0

Base commit: b0cf746
Branch: main

@Pranav-yadav

Pranav-yadav commented Apr 26, 2023

Copy link
Copy Markdown
ContributorAuthor

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) 👍

@cortinico
cortinico requested a review from hoxyqApril 27, 2023 10:59

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

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.

Comment threadpackages/assets/package.json Outdated

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 😃

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

@Pranav-yadav
Pranav-yadav marked this pull request as ready for review April 27, 2023 17:04
Comment threadpackages/assets/README.md Outdated
Comment threadpackages/babel-plugin-codegen/README.md Outdated
Comment threadpackages/eslint-plugin-specs/README.md Outdated
Comment threadpackages/hermes-inspector-msggen/README.md Outdated
Comment threadpackages/metro-config/README.md Outdated
Comment threadpackages/normalize-color/README.md Outdated
Comment threadpackages/polyfills/README.md Outdated
Comment threadpackages/react-native/package.json Outdated

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.

@cortinico

Are we okay with these keywords?

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.

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

Comment threadpackages/virtualized-lists/README.md Outdated
Comment threadpackages/assets/package.json Outdated

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

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.

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.

@Pranav-yadav

Pranav-yadav commented Apr 27, 2023

Copy link
Copy Markdown
ContributorAuthor

Rebased & addressed suggestions re: jest testing syntax 👍

@Pranav-yadav
Pranav-yadav requested a review from hoxyqApril 27, 2023 20:37
For all public RN packages:
- Add missing READMEs
- Add issues, bugs urls
- Add keywords and homepage urls to respective pkgs
@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

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

Copy link
Copy Markdown
Contributor

@hoxyq merged this pull request in 14316bd.

@Pranav-yadav
Pranav-yadav deleted the update-packageJsons branch April 28, 2023 12:13
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.MergedThis PR has been merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@Pranav-yadav@analysis-bot@facebook-github-bot@hoxyq
, '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

Closed
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:update-packageJsons
Closed

Add missing READMEs & Update package.json in all RN packages#37090
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:update-packageJsons

Conversation

@Pranav-yadav

@Pranav-yadavPranav-yadav commented Apr 25, 2023

Copy link
Copy Markdown
Contributor

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

@facebook-github-botfacebook-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
@analysis-bot

analysis-bot commented Apr 25, 2023

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,499,710+0
androidhermesarmeabi-v7a7,833,554+0
androidhermesx868,977,657+0
androidhermesx86_648,834,477+0
androidjscarm64-v8a9,064,270+0
androidjscarmeabi-v7a8,275,566+0
androidjscx869,113,565+0
androidjscx86_649,374,032+0

Base commit: b0cf746
Branch: main

@Pranav-yadav

Pranav-yadav commented Apr 26, 2023

Copy link
Copy Markdown
ContributorAuthor

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) 👍

@cortinico
cortinico requested a review from hoxyqApril 27, 2023 10:59

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

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.

Comment threadpackages/assets/package.json Outdated

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 😃

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

@Pranav-yadav
Pranav-yadav marked this pull request as ready for review April 27, 2023 17:04
Comment threadpackages/assets/README.md Outdated
Comment threadpackages/babel-plugin-codegen/README.md Outdated
Comment threadpackages/eslint-plugin-specs/README.md Outdated
Comment threadpackages/hermes-inspector-msggen/README.md Outdated
Comment threadpackages/metro-config/README.md Outdated
Comment threadpackages/normalize-color/README.md Outdated
Comment threadpackages/polyfills/README.md Outdated
Comment threadpackages/react-native/package.json Outdated

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.

@cortinico

Are we okay with these keywords?

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.

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

Comment threadpackages/virtualized-lists/README.md Outdated
Comment threadpackages/assets/package.json Outdated

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

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.

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.

@Pranav-yadav

Pranav-yadav commented Apr 27, 2023

Copy link
Copy Markdown
ContributorAuthor

Rebased & addressed suggestions re: jest testing syntax 👍

@Pranav-yadav
Pranav-yadav requested a review from hoxyqApril 27, 2023 20:37
For all public RN packages:
- Add missing READMEs
- Add issues, bugs urls
- Add keywords and homepage urls to respective pkgs
@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

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

Copy link
Copy Markdown
Contributor

@hoxyq merged this pull request in 14316bd.

@Pranav-yadav
Pranav-yadav deleted the update-packageJsons branch April 28, 2023 12:13
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.MergedThis PR has been merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@Pranav-yadav@analysis-bot@facebook-github-bot@hoxyq
, '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

Closed
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:update-packageJsons
Closed

Add missing READMEs & Update package.json in all RN packages#37090
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:update-packageJsons

Conversation

@Pranav-yadav

@Pranav-yadavPranav-yadav commented Apr 25, 2023

Copy link
Copy Markdown
Contributor

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

@facebook-github-botfacebook-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
@analysis-bot

analysis-bot commented Apr 25, 2023

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,499,710+0
androidhermesarmeabi-v7a7,833,554+0
androidhermesx868,977,657+0
androidhermesx86_648,834,477+0
androidjscarm64-v8a9,064,270+0
androidjscarmeabi-v7a8,275,566+0
androidjscx869,113,565+0
androidjscx86_649,374,032+0

Base commit: b0cf746
Branch: main

@Pranav-yadav

Pranav-yadav commented Apr 26, 2023

Copy link
Copy Markdown
ContributorAuthor

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) 👍

@cortinico
cortinico requested a review from hoxyqApril 27, 2023 10:59

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

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.

Comment threadpackages/assets/package.json Outdated

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 😃

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

@Pranav-yadav
Pranav-yadav marked this pull request as ready for review April 27, 2023 17:04
Comment threadpackages/assets/README.md Outdated
Comment threadpackages/babel-plugin-codegen/README.md Outdated
Comment threadpackages/eslint-plugin-specs/README.md Outdated
Comment threadpackages/hermes-inspector-msggen/README.md Outdated
Comment threadpackages/metro-config/README.md Outdated
Comment threadpackages/normalize-color/README.md Outdated
Comment threadpackages/polyfills/README.md Outdated
Comment threadpackages/react-native/package.json Outdated

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.

@cortinico

Are we okay with these keywords?

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.

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

Comment threadpackages/virtualized-lists/README.md Outdated
Comment threadpackages/assets/package.json Outdated

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

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.

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.

@Pranav-yadav

Pranav-yadav commented Apr 27, 2023

Copy link
Copy Markdown
ContributorAuthor

Rebased & addressed suggestions re: jest testing syntax 👍

@Pranav-yadav
Pranav-yadav requested a review from hoxyqApril 27, 2023 20:37
For all public RN packages:
- Add missing READMEs
- Add issues, bugs urls
- Add keywords and homepage urls to respective pkgs
@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

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

Copy link
Copy Markdown
Contributor

@hoxyq merged this pull request in 14316bd.

@Pranav-yadav
Pranav-yadav deleted the update-packageJsons branch April 28, 2023 12:13
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.MergedThis PR has been merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@Pranav-yadav@analysis-bot@facebook-github-bot@hoxyq
, '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

Closed
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:update-packageJsons
Closed

Add missing READMEs & Update package.json in all RN packages#37090
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:update-packageJsons

Conversation

@Pranav-yadav

@Pranav-yadavPranav-yadav commented Apr 25, 2023

Copy link
Copy Markdown
Contributor

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

@facebook-github-botfacebook-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
@analysis-bot

analysis-bot commented Apr 25, 2023

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,499,710+0
androidhermesarmeabi-v7a7,833,554+0
androidhermesx868,977,657+0
androidhermesx86_648,834,477+0
androidjscarm64-v8a9,064,270+0
androidjscarmeabi-v7a8,275,566+0
androidjscx869,113,565+0
androidjscx86_649,374,032+0

Base commit: b0cf746
Branch: main

@Pranav-yadav

Pranav-yadav commented Apr 26, 2023

Copy link
Copy Markdown
ContributorAuthor

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) 👍

@cortinico
cortinico requested a review from hoxyqApril 27, 2023 10:59

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

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.

Comment threadpackages/assets/package.json Outdated

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 😃

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

@Pranav-yadav
Pranav-yadav marked this pull request as ready for review April 27, 2023 17:04
Comment threadpackages/assets/README.md Outdated
Comment threadpackages/babel-plugin-codegen/README.md Outdated
Comment threadpackages/eslint-plugin-specs/README.md Outdated
Comment threadpackages/hermes-inspector-msggen/README.md Outdated
Comment threadpackages/metro-config/README.md Outdated
Comment threadpackages/normalize-color/README.md Outdated
Comment threadpackages/polyfills/README.md Outdated
Comment threadpackages/react-native/package.json Outdated

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.

@cortinico

Are we okay with these keywords?

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.

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

Comment threadpackages/virtualized-lists/README.md Outdated
Comment threadpackages/assets/package.json Outdated

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

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.

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.

@Pranav-yadav

Pranav-yadav commented Apr 27, 2023

Copy link
Copy Markdown
ContributorAuthor

Rebased & addressed suggestions re: jest testing syntax 👍

@Pranav-yadav
Pranav-yadav requested a review from hoxyqApril 27, 2023 20:37
For all public RN packages:
- Add missing READMEs
- Add issues, bugs urls
- Add keywords and homepage urls to respective pkgs
@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

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

Copy link
Copy Markdown
Contributor

@hoxyq merged this pull request in 14316bd.

@Pranav-yadav
Pranav-yadav deleted the update-packageJsons branch April 28, 2023 12:13
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.MergedThis PR has been merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@Pranav-yadav@analysis-bot@facebook-github-bot@hoxyq
, '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

Closed
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:update-packageJsons
Closed

Add missing READMEs & Update package.json in all RN packages#37090
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:update-packageJsons

Conversation

@Pranav-yadav

@Pranav-yadavPranav-yadav commented Apr 25, 2023

Copy link
Copy Markdown
Contributor

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

@facebook-github-botfacebook-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
@analysis-bot

analysis-bot commented Apr 25, 2023

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,499,710+0
androidhermesarmeabi-v7a7,833,554+0
androidhermesx868,977,657+0
androidhermesx86_648,834,477+0
androidjscarm64-v8a9,064,270+0
androidjscarmeabi-v7a8,275,566+0
androidjscx869,113,565+0
androidjscx86_649,374,032+0

Base commit: b0cf746
Branch: main

@Pranav-yadav

Pranav-yadav commented Apr 26, 2023

Copy link
Copy Markdown
ContributorAuthor

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) 👍

@cortinico
cortinico requested a review from hoxyqApril 27, 2023 10:59

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

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.

Comment threadpackages/assets/package.json Outdated

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 😃

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

@Pranav-yadav
Pranav-yadav marked this pull request as ready for review April 27, 2023 17:04
Comment threadpackages/assets/README.md Outdated
Comment threadpackages/babel-plugin-codegen/README.md Outdated
Comment threadpackages/eslint-plugin-specs/README.md Outdated
Comment threadpackages/hermes-inspector-msggen/README.md Outdated
Comment threadpackages/metro-config/README.md Outdated
Comment threadpackages/normalize-color/README.md Outdated
Comment threadpackages/polyfills/README.md Outdated
Comment threadpackages/react-native/package.json Outdated

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.

@cortinico

Are we okay with these keywords?

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.

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

Comment threadpackages/virtualized-lists/README.md Outdated
Comment threadpackages/assets/package.json Outdated

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

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.

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.

@Pranav-yadav

Pranav-yadav commented Apr 27, 2023

Copy link
Copy Markdown
ContributorAuthor

Rebased & addressed suggestions re: jest testing syntax 👍

@Pranav-yadav
Pranav-yadav requested a review from hoxyqApril 27, 2023 20:37
For all public RN packages:
- Add missing READMEs
- Add issues, bugs urls
- Add keywords and homepage urls to respective pkgs
@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

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

Copy link
Copy Markdown
Contributor

@hoxyq merged this pull request in 14316bd.

@Pranav-yadav
Pranav-yadav deleted the update-packageJsons branch April 28, 2023 12:13
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.MergedThis PR has been merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@Pranav-yadav@analysis-bot@facebook-github-bot@hoxyq
, '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

Closed
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:update-packageJsons
Closed

Add missing READMEs & Update package.json in all RN packages#37090
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:update-packageJsons

Conversation

@Pranav-yadav

@Pranav-yadavPranav-yadav commented Apr 25, 2023

Copy link
Copy Markdown
Contributor

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

@facebook-github-botfacebook-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
@analysis-bot

analysis-bot commented Apr 25, 2023

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,499,710+0
androidhermesarmeabi-v7a7,833,554+0
androidhermesx868,977,657+0
androidhermesx86_648,834,477+0
androidjscarm64-v8a9,064,270+0
androidjscarmeabi-v7a8,275,566+0
androidjscx869,113,565+0
androidjscx86_649,374,032+0

Base commit: b0cf746
Branch: main

@Pranav-yadav

Pranav-yadav commented Apr 26, 2023

Copy link
Copy Markdown
ContributorAuthor

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) 👍

@cortinico
cortinico requested a review from hoxyqApril 27, 2023 10:59

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

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.

Comment threadpackages/assets/package.json Outdated

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 😃

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

@Pranav-yadav
Pranav-yadav marked this pull request as ready for review April 27, 2023 17:04
Comment threadpackages/assets/README.md Outdated
Comment threadpackages/babel-plugin-codegen/README.md Outdated
Comment threadpackages/eslint-plugin-specs/README.md Outdated
Comment threadpackages/hermes-inspector-msggen/README.md Outdated
Comment threadpackages/metro-config/README.md Outdated
Comment threadpackages/normalize-color/README.md Outdated
Comment threadpackages/polyfills/README.md Outdated
Comment threadpackages/react-native/package.json Outdated

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.

@cortinico

Are we okay with these keywords?

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.

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

Comment threadpackages/virtualized-lists/README.md Outdated
Comment threadpackages/assets/package.json Outdated

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

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.

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.

@Pranav-yadav

Pranav-yadav commented Apr 27, 2023

Copy link
Copy Markdown
ContributorAuthor

Rebased & addressed suggestions re: jest testing syntax 👍

@Pranav-yadav
Pranav-yadav requested a review from hoxyqApril 27, 2023 20:37
For all public RN packages:
- Add missing READMEs
- Add issues, bugs urls
- Add keywords and homepage urls to respective pkgs
@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

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

Copy link
Copy Markdown
Contributor

@hoxyq merged this pull request in 14316bd.

@Pranav-yadav
Pranav-yadav deleted the update-packageJsons branch April 28, 2023 12:13
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.MergedThis PR has been merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@Pranav-yadav@analysis-bot@facebook-github-bot@hoxyq