Refactor `requireNodeAddon` to take the package name and extension-less path of an addon
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Refactorización
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- node.js, react-native, typescript
- Área
- backend-api-design, mobile-dev
Línea de trabajo
Empieza localizando el punto de entrada requireNodeAddon y las declaraciones públicas representadas por index.js e index.d.ts en el ejemplo. Compara la API de ruta sin extensión y packageName solicitada con las implementaciones de las plataformas, incluida la ruta Node.js process.dlopen y la condición de exportación node; se considera terminado cuando los mismos argumentos de llamada funcionan en las plataformas indicadas.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
This is a suggestion which is subtly different from the one proposed in https://github.com/callstackincubator/react-native-node-api/issues/91.
Goals
- Removing the requirement for the Babel plugin, for use-cases where a library author "controls" the code calling into the host package.
- Give more control to the host package when deciding what library files to loads (at runtime).
- Supporting multiple platforms (including Node.js) with source-code calling into the host package with the same call arguments
- In particular Node.js by providing a "node" export condition implementing
requireNodeAddonby calling intoprocess.dlopen.
- In particular Node.js by providing a "node" export condition implementing
Example library
Imagine a library ("my-lib") with a single index.js entrypoint calling into our host package:
// node_modules/my-lib/index.js
import { requireNodeAddon } from "react-native-node-api";
const addon = requireNodeAddon({
packageName: "my-lib", // The name from the package.json
path: "build/Release/hello" // Path to the addon, relative to the package root, stripped from its ".*.node" file extensions.
});
export const sum = addon.sum;
and the following directory structure:
index.js
index.d.ts
build/Release
├── hello.android.node
│ ├── arm64-v8a
│ │ └── libhello.so
│ ├── armeabi-v7a
│ │ └── libhello.so
│ ├── react-native-node-api-module
│ ├── x86
│ │ └── libhello.so
│ └── x86_64
│ └── libhello.so
├── hello.apple.node
│ ├── Info.plist
│ ├── ios-arm64
│ │ └── hello.framework
│ │ ├── Headers
│ │ ├── hello
│ │ └── Info.plist
│ ├── ios-arm64-simulator
│ │ └── hello.framework
│ │ ├── Headers
│ │ ├── hello
│ │ └── Info.plist
│ ├── macos-arm64_x86_64
│ │ └── hello.framework
│ │ ├── Headers
│ │ ├── hello
│ │ └── Info.plist
│ ├── react-native-node-api-module
│ ├── tvos-arm64
│ │ └── hello.framework
│ │ ├── Headers
│ │ ├── hello
│ │ └── Info.plist
│ ├── tvos-arm64-simulator
│ │ └── hello.framework
│ │ ├── Headers
│ │ ├── hello
│ │ └── Info.plist
│ ├── xros-arm64
│ │ └── hello.framework
│ │ ├── Headers
│ │ ├── hello
│ │ └── Info.plist
│ └── xros-arm64-simulator
│ └── hello.framework
│ ├── Headers
│ ├── hello
│ └── Info.plist
└── hello.nodejs.node
├── darwin-arm64
│ └── hello.node
└── react-native-node-api-module
- Lenguaje dominante
- TypeScript
- Estrellas
- 188
- Forks
- 10
- Merge medio
- 2 d 17 h
- PR fusionados (30 d)
- 3
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de callstackincubator/react-native-node-api
-
Android 🤖
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
-
Sanity check of Hermes source directory via environment variable, when building Android projects AbiertoAndroid 🤖 good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
callstackincubator/react-native-node-api#163 · 1 comentario ·
-
enhancement good first issue gyp-to-cmake
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
callstackincubator/react-native-node-api#161 · 3 comentarios · 1 reacción ·
-
enhancement Host 🏡
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
-
Automatable good first issue
Dificultad 3/5 1-2 días Aptitud para principiantes 15/100
callstackincubator/react-native-node-api#424 · 1 comentario ·
Todos los issues de callstackincubator/react-native-node-api
Issues similares
-
VerificationGate: ATTRIBUTION quote guard never matches a normal quotation (\b around the quote) Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
danielmiessler/LifeOS#2234 ·
-
T: Bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
-
Mend: dependency security vulnerability untriaged
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100