A framework for building native macOS apps with React.
Перейти к файлу
Nick Gerleman a659065840 C++ Cleanup 2/N: Reorganize YGConfig (#39218)
Summary:
Pull Request resolved: https://github.com/facebook/react-native/pull/39218

Pull Request resolved: https://github.com/facebook/react-native/pull/39169

X-link: https://github.com/facebook/yoga/pull/1348

## This diff

This diff adds a top level `config` directory for code related to configuring Yoga and Yoga Nodes.

The public API for config handles is `YGConfigRef`, which is forward declared to be a pointer to a struct named `YGConfig`. The existing `YGConfig` is split into `yoga::Config`, as the private C++ implementation, inheriting from `YGConfig`, a marker type represented as an empty struct. The public API continues to accept `YGConfigRef`, which continues to be `YGConfig *`, but it must be cast to its concrete internal representation at the API boundary before doing work on it.

## This stack

The organization of the C++ internals of Yoga are in need of attention.
1. Some of the C++ internals are namespaced, but others not.
2. Some of the namespaces include `detail`, but are meant to be used outside of the translation unit (FB Clang Tidy rules warn on any usage of these)
2. Most of the files are in a flat hierarchy, except for event tracing in its own folder
3. Some files and functions begin with YG, others don’t
4. Some functions are uppercase, others are not
5. Almost all of the interesting logic is in Yoga.cpp, and the file is too large to reason about
6. There are multiple grab bag files where folks put random functions they need in (Utils, BitUtils, Yoga-Internal.h)
7. There is no clear indication from file structure or type naming what is private vs not
8. Handles like `YGNodeRef` and `YGConfigRef` can be used to access internals just by importing headers

This stack does some much needed spring cleaning:
1. All non-public headers and C++ implementation details are in separate folders from the root level `yoga`. This will give us room to split up logic and add more files without too large a flat hierarchy
3. All private C++ internals are under the `facebook::yoga` namespace. Details namespaces are only ever used within the same header, as they are intended
4. Utils files are split
5. Most C++ internals drop the YG prefix
6. Most C++ internal function names are all lower camel case
7. We start to split up Yoga.cpp
8. Every header beginning with YG or at the top-level directory is public and C only, with the exception of Yoga-Internal.h which has non-public functions for bindings
9. It is not possible to use private APIs without static casting handles to internal classes

This will give us more leeway to continue splitting monolithic files, and consistent guidelines for style in new files as well.

These changes should not be breaking to any project using only public Yoga headers. This includes every usage of Yoga in fbsource except for RN Fabric which is currently tied to internals. This refactor should make that boundary clearer.

Changelog: [Internal]

Reviewed By: shwanton

Differential Revision: D48847257

fbshipit-source-id: 7a2157d169ba80a6f79620693ae45bb10dfca5a3
2023-08-30 16:27:32 -07:00
.bundle Introduce Gemfile, ruby-version (#32303) 2021-10-01 21:22:26 -07:00
.circleci Make the e2e Tests actually not blocking (#39175) 2023-08-29 01:59:47 -07:00
.github Prevent check-for-reproducer action trigger on Umbrella and old issues (#38664) 2023-07-28 08:50:35 -07:00
flow-typed/npm Add Microsoft Edge support for opening debugger (#39146) 2023-08-24 10:57:39 -07:00
gradle Gradle to 8.2.1 (#38271) 2023-07-10 15:16:10 -07:00
jest Remove unused inlineRequires params from BabelTransformer API (#38771) 2023-08-07 09:17:43 -07:00
packages C++ Cleanup 2/N: Reorganize YGConfig (#39218) 2023-08-30 16:27:32 -07:00
scripts Remove CI check jobs on .flowconfig.android in react-native (#39158) 2023-08-26 10:00:22 -07:00
tools RN: Enforce Manifest Constraints w/ ESLint (#39064) 2023-08-18 07:48:56 -07:00
.babelrc Move react-native-babel-transformer and react-native-babel-preset from Metro to React Native repo (#38228) 2023-07-27 11:48:16 -07:00
.buckconfig Add support for Buck oncall annotations (#35562) 2022-12-05 06:12:46 -08:00
.buckjavaargs limiting BUCK's memory for CI 2016-02-01 10:49:33 -08:00
.clang-format Consistent QualifierAlignment (#39217) 2023-08-30 16:17:56 -07:00
.editorconfig Revert removal of CRLF from Windows bat files (#31398) 2021-09-09 22:44:32 -07:00
.eslintignore | RN Monorepo | Migrate to package (#36434) 2023-03-17 05:03:25 -07:00
.eslintrc.js RN: Enforce Manifest Constraints w/ ESLint (#39064) 2023-08-18 07:48:56 -07:00
.flowconfig Rollout support for multiplatform react-native project (#39131) 2023-08-24 09:54:15 -07:00
.gitignore Consume Hermes from local source directory (#38967) 2023-08-24 04:54:14 -07:00
.prettierignore Make prettier ignore generated folders (#39076) 2023-08-18 08:42:13 -07:00
.prettierrc Also parse js.flow files with hermes-parser (#39048) 2023-08-16 11:27:13 -07:00
CHANGELOG-pre-060.md split the changelog into decades (#38017) 2023-06-22 04:19:40 -07:00
CHANGELOG-pre-070.md Remove duplicate changelog entry (#38177) 2023-07-05 09:32:10 -07:00
CHANGELOG.md Add 0.71.13 changelog (#39102) 2023-08-22 07:20:40 -07:00
CODE_OF_CONDUCT.md docs: add new version convenant contribuitor guide link (#32107) 2021-08-30 10:18:11 -07:00
CONTRIBUTING.md Update CONTRIBUTING.md, replace wiki links (#34035) 2022-06-21 19:30:23 -07:00
ECOSYSTEM.md Add @getsentry to React Native incubating partners list (#38091) 2023-06-27 10:48:43 -07:00
Gemfile Bump activesupport to 6.1.7.3 to address CVE-2023-28120 (#36803) 2023-04-04 12:49:17 -07:00
Gemfile.lock Bump activesupport to 6.1.7.3 to address CVE-2023-28120 (#36803) 2023-04-04 12:49:17 -07:00
LICENSE Re-add the top level LICENSE file (#37916) 2023-06-15 13:14:17 -07:00
LICENSE-docs More licenses 2015-03-24 19:59:10 -07:00
README.md Update README.md - iOS support is 13.4 (#38108) 2023-06-28 09:01:44 -07:00
build.gradle.kts Introduce react.internal.useHermesNightly (#38886) 2023-08-14 00:45:07 -07:00
gradle.properties Set android.suppressUnsupportedCompileSdk=34 for the root project 2023-08-18 03:07:41 -07:00
gradlew Gradle to 8.2.1 (#38271) 2023-07-10 15:16:10 -07:00
gradlew.bat Bump Gradle to 8.x (#36269) 2023-02-27 13:47:09 -08:00
jest.config.js Use modern timers in monorepo Jest tests (#38955) 2023-08-11 11:01:06 -07:00
package.json Remove CI check jobs on .flowconfig.android in react-native (#39158) 2023-08-26 10:00:22 -07:00
runXcodeTests.sh Use realpath instead of readlink 2022-02-22 02:23:02 -08:00
settings.gradle.kts Use version catalog to consolidate versions for JVM dependencies (#38836) 2023-08-08 11:37:43 -07:00
yarn.lock Add Microsoft Edge support for opening debugger (#39146) 2023-08-24 10:57:39 -07:00

README.md

React Native

Learn once, write anywhere:
Build mobile apps with React.

React Native is released under the MIT license. Current CircleCI build status. Current npm package version. PRs welcome! Follow @reactnative

Getting Started · Learn the Basics · Showcase · Contribute · Community · Support

React Native brings React's declarative UI framework to iOS and Android. With React Native, you use native UI controls and have full access to the native platform.

  • Declarative. React makes it painless to create interactive UIs. Declarative views make your code more predictable and easier to debug.
  • Component-Based. Build encapsulated components that manage their state, then compose them to make complex UIs.
  • Developer Velocity. See local changes in seconds. Changes to JavaScript code can be live reloaded without rebuilding the native app.
  • Portability. Reuse code across iOS, Android, and other platforms.

React Native is developed and supported by many companies and individual core contributors. Find out more in our ecosystem overview.

Contents

📋 Requirements

React Native apps may target iOS 13.4 and Android 5.0 (API 21) or newer. You may use Windows, macOS, or Linux as your development operating system, though building and running iOS apps is limited to macOS. Tools like Expo can be used to work around this.

🎉 Building your first React Native app

Follow the Getting Started guide. The recommended way to install React Native depends on your project. Here you can find short guides for the most common scenarios:

📖 Documentation

The full documentation for React Native can be found on our website.

The React Native documentation discusses components, APIs, and topics that are specific to React Native. For further documentation on the React API that is shared between React Native and React DOM, refer to the React documentation.

The source for the React Native documentation and website is hosted on a separate repo, @facebook/react-native-website.

🚀 Upgrading

Upgrading to new versions of React Native may give you access to more APIs, views, developer tools, and other goodies. See the Upgrading Guide for instructions.

React Native releases are discussed in this discussion repo.

👏 How to Contribute

The main purpose of this repository is to continue evolving React Native core. We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving React Native.

Code of Conduct

Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our Contributing Guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to React Native.

Open Source Roadmap

You can learn more about our vision for React Native in the Roadmap.

Good First Issues

We have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

Discussions

Larger discussions and proposals are discussed in @react-native-community/discussions-and-proposals.

📄 License

React Native is MIT licensed, as found in the LICENSE file.

React Native documentation is Creative Commons licensed, as found in the LICENSE-docs file.