编辑

react-native codegen-windows

本指南将为您提供有关 React Native Windows CLI 的 codegen-windows 命令的更多信息。

codegen-windows

codegen-windows CLI 命令用于为原生模块生成一些必要的 Windows 特定原生代码。

用法

为原生模块运行 Windows 特定代码生成。

npx react-native codegen-windows

选项

以下是 react-native codegen-windows 接受的选项

选项	输入类型	描述
--logging	布尔值	详细输出日志记录
--check	布尔值	仅检查是否有任何代码生成文件需要更改
--no-telemetry	布尔值	禁用发送遥测数据，该数据用于分析 react-native-windows CLI 的使用情况和故障
-h, --help	布尔值	显示命令帮助

代码生成配置

react-native codegen-windows 命令由项目 package.json 文件中的 codegenConfig 对象配置。这个 codegenConfig 对象由所有平台共享，但与 React Native for Windows 相关的部分配置如下

字段	类型	描述
类型	字符串	用于原生模块的 "modules"、用于原生组件的 "components"，或同时用于两者的 "all"
jsSrcDir	字符串	TypeScript 规范输入文件的路径
windows	object	Windows 特定代码生成配置

windows 对象配置如下

字段	类型	描述
namespace	字符串	包含生成代码的 C++ 命名空间
cppStringType	字符串	可选，C++ 代码中使用的字符串类型，可以是 "std::string" 或 std::wstring。默认为 "std::string"
generators	数组	可选，代码生成器字符串数组，接受用于原生模块的 "modulesWindows"、用于原生组件的 "componentsWindows"。默认为 [ "modulesWindows" ]
outputDirectory	字符串	可选，生成代码的放置路径。默认为工作目录的 ./codegen/
separateDataTypes	布尔值	可选，指定是否创建单独的文件来定义自定义数据类型。默认为 false

注意： 有关如何为其他平台配置 codegenConfig 对象的更多信息，请参阅 reactnative.dev 配置代码生成页面。

代码生成配置示例

"codegenConfig": {
    "name": "NativeModuleSampleSpec",
    "type": "all",
    "jsSrcsDir": "src",
    "includesGeneratedCode": true,
    "windows": {
      "namespace": "NativeModuleSampleCodegen",
      "generators": [
        "modulesWindows",
        "componentsWindows"
      ],
      "outputDirectory": "windows/NativeModuleSample/codegen",
      "separateDataTypes": true
    }
  },

遥测通知

此命令默认向 Microsoft 发送遥测数据。您可以通过使用 --no-telemetry 命令行选项来阻止发送遥测数据。有关更多详细信息，请参阅下文。

本软件可能会收集有关您及您使用本软件的信息并将其发送给 Microsoft。Microsoft 可能会使用此信息来提供服务并改进我们的产品和服务。您可以按照存储库中的说明关闭遥测功能。本软件中还有一些功能可能使您和 Microsoft 能够从您的应用程序用户那里收集数据。如果您使用这些功能，则必须遵守适用法律，包括向您的应用程序用户提供适当的通知以及 Microsoft 隐私声明的副本。我们的隐私声明位于 https://go.microsoft.com/fwlink/?LinkID=824704。您可以在帮助文档和我们的隐私声明中了解有关数据收集和使用的更多信息。您使用本软件即表示您同意这些做法。

此数据收集通知仅适用于运行 react-native-windows CLI 命令的过程。