You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Rename cmake package
* Update references to "react-native-node-api-cmake"
* Rename "react-native-node-api-modules" to "react-native-node-api"
* Rename "react-native-node-api-modules" to "react-native-node-api" and move it to "packages/host"
* Rename "react-native-node-addon-examples" to "@react-native-node-api/node-addon-examples"
* Rename root package
Copy file name to clipboardExpand all lines: README.md
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,3 @@
1
-
2
1
<palign="center">
3
2
<imgsrc="./docs/logo.svg"width="20%" />
4
3
</p>
@@ -32,7 +31,7 @@ See the document on ["how it works"](./docs/HOW_IT_WORKS.md) for a detailed desc
32
31
33
32
This mono-repository hosts the development of a few packages:
34
33
35
-
### `packages/react-native-node-api-modules`
34
+
### `packages/react-native-node-api`
36
35
37
36
Responsible for adding Node-API support to your React Native application:
38
37
@@ -49,19 +48,19 @@ Responsible for adding Node-API support to your React Native application:
49
48
50
49
Note: We'll sometimes refer to this as the "host package", as it can be seen as a host of Node-API modules in React Native apps.
51
50
52
-
### `packages/react-native-node-api-cmake`
51
+
### `packages/cmake-rn`
53
52
54
53
A wrapper around CMake making it easier to produce [prebuilt binaries](./docs/PREBUILDS.md) targeting iOS and Android matching the [the prebuilt binary specification](./docs/PREBUILDS.md).
55
54
56
55
Serves the same purpose as `cmake-js` does for the Node.js community and could potentially be upstreamed into `cmake-js` eventually.
57
56
58
57
### `packages/gyp-to-cmake`
59
58
60
-
A tool to transform `binding.gyp` files into `CMakeLists.txt` files, intended for `cmake-js` or `react-native-node-api-cmake` to build from.
59
+
A tool to transform `binding.gyp` files into `CMakeLists.txt` files, intended for `cmake-js` or `cmake-rn` to build from.
61
60
62
61
### `packages/node-addon-examples`
63
62
64
-
A wrapper around the examples in the [nodejs/node-addon-examples](https://github.com/nodejs/node-addon-examples) repo, using `gyp-to-cmake` and `react-native-node-api-cmake` to prepare prebuilds and scaffolding for loading the addons.
63
+
A wrapper around the examples in the [nodejs/node-addon-examples](https://github.com/nodejs/node-addon-examples) repo, using `gyp-to-cmake` and `cmake-rn` to prepare prebuilds and scaffolding for loading the addons.
65
64
66
65
The main purpose is to use these as tests to verify the implementation. We choose to use this as our first signal for compliance, over the [js-native-api tests in the Node.js project](https://github.com/nodejs/node/tree/main/test/js-native-api), because the examples depends much less on Node.js built-in runtime APIs.
Copy file name to clipboardExpand all lines: docs/AUTO-LINKING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Auto-linking
2
2
3
-
The `react-native-node-api-modules` package (sometimes referred to as "the host package") has mechanisms to automatically find and link prebuilt binaries with Node-API modules.
3
+
The `react-native-node-api` package (sometimes referred to as "the host package") has mechanisms to automatically find and link prebuilt binaries with Node-API modules.
4
4
5
5
When auto-linking, prebuilt binaries are copied (sometimes referred to as vendored) from dependencies of the app into the host package. As they're copied, they get renamed to avoid conflicts in naming as the library files across multiple dependency packages will be sharing a namespace when building the app.
6
6
@@ -15,12 +15,12 @@ The name of the library when linked / copied into the host is based on two thing
15
15
16
16
## How do I link Node-API module libraries into my app?
17
17
18
-
Linking will run when you `pod install` and as part of building your app with Gradle as long as your app has a dependency on the `react-native-node-api-modules` package.
18
+
Linking will run when you `pod install` and as part of building your app with Gradle as long as your app has a dependency on the `react-native-node-api` package.
19
19
20
20
You can also manually link by running the following in your app directory:
21
21
22
22
```bash
23
-
npx react-native-node-api-modules link --android --apple
0 commit comments