This documentation is available as Markdown for AI agents and LLMs. See the full Markdown index or append .md to any documentation URL.
Expo 类型生成参考
npm
expo-type-information 包的参考文档。
expo-type-information库仅适用于 macOS。适用于 SDK 56 及更高版本。
expo-type-information 包提供了用于自动为 Swift 模块生成 TypeScript 接口的工具。它由多个部分组成：
- 基于
sourcekitten的 Swift 解析器：用于从 Swift Expo 模块中检索并构造类型信息的解析器。 - 类型抽象：对与 Expo 模块相关的类型信息进行抽象，解析器会以这种抽象后的方式返回信息。
- TypeScript AST 生成器：一组帮助生成 TypeScript 代码的函数。
- CLI：一个命令行工具，集成了上述功能。
配置
安装 expo-type-information 库：
使用此包还需要安装 sourcekitten。你可以使用 macOS 包管理器，例如 Homebrew。
CLI 参考
通用 CLI 选项
该库中的每个 CLI 命令都会使用以下通用选项进行配置。唯一的例外是 inline-modules-interface，它的选项略有不同。
主要命令
module-interface
为 Swift 模块生成完整的 TypeScript 接口。它由以下内容组成：
- 包含模块中定义的所有类型的 types.ts 文件
- 包含原生模块定义的 module.ts
- 模块中定义的每个视图对应的 view.tsx
- 重新导出某些函数的 index.ts 文件
接受标准 通用 CLI 选项。
inline-modules-interface
为项目中的每个 Swift 内联模块创建 TypeScript 接口。该接口由两个文件组成：
- Module.generated.ts：每次运行该命令都会重新生成
- Module.tsx：如果你修改了它，则不会被重新生成
选项：
short-module-interface
为 Expo 模块创建一个简短的 TypeScript 接口。会覆盖 ModuleName.generated.ts，并在不存在时创建 ModuleName.ts。可与 inline-modules 一起使用。
接受标准 通用 CLI 选项。
generate-mocks-for-file
为给定的 expo 模块生成 mock。
接受标准 通用 CLI 选项。
其他命令
这些命令是内部命令或非常特定的命令。
本节中的所有命令都接受标准 通用 CLI 选项。
other type-information
解析 Swift 模块类型信息并输出 FileTypeInformation JSON。
other generate-module-types
生成模块的类型声明文件内容。
other generate-view-types
生成原生 View 的类型声明文件。
other generate-jsx-intrinsics
生成 View 的声明文件，并使用该 View 的 props 更新 JSX intrinsic。
other preprocess-file
在通过 sourcekitten 解析之前，打印处于预处理状态的文件。它有助于检查 --module-path、--input-path 和 --type-inference 选项如何影响解析后的文件。
类型信息抽象
Used for testing purposes, maps Arrays to Sets and Maps depending on the field and returns FileTypeInformation object.
FileTypeInformationFileTypeInformation object.
Reads and extracts FileTypeInformation from either a provided file path or a raw string of source code.
If a raw string is provided, or if the PREPROCESS_AND_INFERENCE inference option is selected,
the function will create a temporary file with the (optionally preprocessed) content to facilitate parsing.
Promise<FileTypeInformation | null>A promise that resolves to a FileTypeInformation object if the input was parsed successfully. Otherwise, it resolves to null.
Used for testing purposes, maps Sets and Maps to Arrays and returns FileTypeInformationSerialized object which can be written to a JSON.
FileTypeInformationSerializeda FileTypeInformationSerialized object.
TypeScript 生成
Generates a short TypeScript interface for an Expo module. This creates the content for two files: a volatile generated file containing raw type definitions, and a stable user-facing file that wraps and exports the native module methods in new functions.
Promise<{
moduleTypescriptInterfaceFileContent: string,
volatileGeneratedFileContent: string
}>A promise that resolves to an object containing the string contents for both the volatile generated file and the stable TypeScript interface file.
Generates a full, multi-file TypeScript interface for an Expo module. The generated interface is separated into a file with type definitions, a file which wraps the native module, a file for each view defined in a module and an index file which reexports all definitions from the other files.
Promise<{
indexFile: OutputFile,
moduleNativeFile: OutputFile,
moduleTypesFile: OutputFile,
moduleViewsFiles: OutputFile[]
} | null>A promise that resolves to an object containing the string contents for all of the generated files or null if the generation has failed.
Generates the TypeScript string content for a native View's type declaration file which mounts the View props on the global JSXIntrinsics.
Promise<string | null>A promise that resolves to a string containing the TypeScript declaration file content or null if the generation has failed.
Generates the TypeScript string content for a native module type declaration file.
Promise<string | null>A promise that resolves to a string containing the TypeScript module declaration file content or null if the generation has failed.
Generates the TypeScript string content for a native View's type declaration file.
Promise<string | null>A promise that resolves to a string containing the TypeScript declaration file content or null if the generation has failed.
Mock 生成
This function generates JavaScript/TypeScript mocks for each provided FileTypeInformation object.
Promise<void>nothing
Promise<FileTypeInformation[]>Component
Type: React.Element<GetFileTypeInformationOptions>
Types
Literal type: union
Represents an anonymous type, a one that is not named instead written directly in the code, such as inline generics, arrays, or optionals.
Acceptable values are: ParametrizedType | SumType | OptionalType | DictionaryType | ArrayType
Type: Type
Represents a list or array of a specific type.
Note: The information that this type is array is implicit and exists only in the type system and on the parent type. There is no field on the
ArrayTypeobject that explicitly indicates that.
Retains information of where the thing was defined in the file. As collecting type information is written in asynchronous way it is non-deterministic. To make it deterministic we just sort the declaration by the definitionOffset, maintaining the same ordering as in original file.
Defines an input option for extracting type information from a set of physical files.
FileTypeInformation object abstracts over type related information in a file.
The abstraction is closely related to Typescript and expo NativeModules (both to be independent of the actual native side
and to give accurate information about what and how we can use the given module).
Serialized version of the FileTypeInformation, suitable for JSON storage or testing environments.
Options specifying the input source and inference level for retrieving type information.
Type: Type
Represents an optional type that can also resolve to null or undefined.
Note: The information that this type is optional is implicit and exists only in the type system and on the parent type. There is no field on the
OptionalTypeobject that explicitly indicates that.
Represents a parametrized type, that is a generic type with specified parameters e.g. Map<string, number>.
Defines an input option for extracting type information directly from a raw string of source code.
Type: Map<string, IdentifierDefinition>
Maps type identifier strings to their definition objects.
Enums
Represents a basic type that is not user defined.
Represents the kind of a parsed identifier from a native file.
Defines the level of type inference to apply when extracting type information.
Note: In case where type inference is on, it may take more than twice the time to compute the type information.
Categorizes the type node within the abstract syntax tree.
Swift 解析器限制
expo-type-information 库使用 sourcekitten 来解析 Swift 文件。解析 Swift 文件是一项复杂的任务，目前并非所有内容都已实现。
关于当前版本 Swift 文件解析的已知问题
-
嵌套类不会被完整解析。
Sourcekitten在解析嵌套闭包方面存在限制，因此你模块中定义的类可能无法被完全解析。这就是为什么如果模块中存在 DSLClass，其方法的返回类型会显示为unresolved的原因。 -
返回类型解析，
PREPROCESS_AND_INFERENCE推断选项。当闭包的返回类型未显式提供时，工具需要对其进行推断。 在
sourcekitten中，一种做法是：当存在return identifier语句时，我们可以询问该identifier的类型。 第三个推断选项PREPROCESS_AND_INFERENCE会重写文件，使得对于每个return expression语句， 都插入一条新的let return_expression = expression; return return_expression;，这样我们就可以询问标识符类型。 已知重写有时会出现问题（主要是由于字符串和注释），因此它不一定总能正常工作。 目前也没有办法解析没有return的返回，即返回表达式作为闭包尾部表达式的情况。 -
不支持的 Expo Module DSL 声明。
目前并非所有 DSL 声明都会被解析，而且有些声明在任何上下文中都不会被解析。例如，
Events会在View内部被解析，但不会在 Module 定义中被解析。 -
使用 Unicode 字符会破坏
sourcekitten的偏移量。