Facebook/react-native
1
0
Fork 0
mirror of https://github.com/facebook/react-native.git synced 2025-11-01 09:14:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add TSMethodSignature to react-native-codegen (#35311)

Browse Source 
Summary:
Refering to "Support function signature along with function type properties in commands" in https://github.com/facebook/react-native/issues/34872

Many TypeScript programmers prefer `{ name(arg:string):void; }` to `{ readonly name:(arg:string)=>void; }`.

In this pull request, I updated test cases in both commands and modules to cover it, with missing implementation.

Command arguments are `NamedShape<T>` but the `optional` field is missing, it is also fixed.

## Changelog

[General] [Changed] - Add `TSMethodSignature` to react-native-codegen

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

Test Plan: `yarn jest react-native-codegen` passed

Reviewed By: rshest

Differential Revision: D41217482

Pulled By: cipolleschi

fbshipit-source-id: 480af118d09b022bae919c5391547fd82c1a7cc9
This commit is contained in:
Zihan Chen (MSFT)
2022-11-14 08:01:20 -08:00
committed by Facebook GitHub Bot
parent c0f06e8bba
commit ae1d54bc5a
8 changed files with 65 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/react-native-codegen/src/parsers/flow/components/__test_fixtures__/fixtures.js
Vendored
+2 -2
View File
@@ -871,13 +871,13 @@ type NativeType = HostComponent<ModuleProps>;
interface NativeCommands {
+handleRootTag: (viewRef: React.ElementRef<NativeType>, rootTag: RootTag) => void;
+hotspotUpdate: (viewRef: React.ElementRef<NativeType>, x: Int32, y: Int32) => void;
+scrollTo: (
scrollTo(
viewRef: React.ElementRef<NativeType>,
x: Float,
y: Int32,
z: Double,
animated: boolean,
) => void;
): void;
}
export const Commands = codegenNativeCommands<NativeCommands>({
packages/react-native-codegen/src/parsers/flow/components/__tests__/__snapshots__/component-parser-test.js.snap
+11
View File
@@ -1280,6 +1280,7 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_DEFINED_WITH_ALL_T
'params': [
{
'name': 'rootTag',
'optional': false,
'typeAnnotation': {
'type': 'ReservedTypeAnnotation',
'name': 'RootTag'
@@ -1299,12 +1300,14 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_DEFINED_WITH_ALL_T
'params': [
{
'name': 'x',
'optional': false,
'typeAnnotation': {
'type': 'Int32TypeAnnotation'
}
},
{
'name': 'y',
'optional': false,
'typeAnnotation': {
'type': 'Int32TypeAnnotation'
}
@@ -1323,24 +1326,28 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_DEFINED_WITH_ALL_T
'params': [
{
'name': 'x',
'optional': false,
'typeAnnotation': {
'type': 'FloatTypeAnnotation'
}
},
{
'name': 'y',
'optional': false,
'typeAnnotation': {
'type': 'Int32TypeAnnotation'
}
},
{
'name': 'z',
'optional': false,
'typeAnnotation': {
'type': 'DoubleTypeAnnotation'
}
},
{
'name': 'animated',
'optional': false,
'typeAnnotation': {
'type': 'BooleanTypeAnnotation'
}
@@ -2898,12 +2905,14 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_EVENTS_TYPES_EXPOR
'params': [
{
'name': 'y',
'optional': false,
'typeAnnotation': {
'type': 'Int32TypeAnnotation'
}
},
{
'name': 'animated',
'optional': false,
'typeAnnotation': {
'type': 'BooleanTypeAnnotation'
}
@@ -2946,12 +2955,14 @@ exports[`RN Codegen Flow Parser can generate fixture COMMANDS_WITH_EXTERNAL_TYPE
'params': [
{
'name': 'y',
'optional': false,
'typeAnnotation': {
'type': 'Int32TypeAnnotation'
}
},
{
'name': 'animated',
'optional': false,
'typeAnnotation': {
'type': 'BooleanTypeAnnotation'
}
packages/react-native-codegen/src/parsers/flow/components/commands.js
Vendored
+1
View File
@@ -90,6 +90,7 @@ function buildCommandSchema(property: EventTypeAST, types: TypeDeclarationMap) {
return {
name: paramName,
optional: false,
typeAnnotation: returnType,
};
});
packages/react-native-codegen/src/parsers/flow/modules/__test_fixtures__/fixtures.js
Vendored
+1 -1
View File
@@ -591,7 +591,7 @@ export enum StringOptions {
}
export interface Spec extends TurboModule {
+getEnums: (quality: Quality, resolution?: Resolution, floppy: Floppy, stringOptions: StringOptions) => string;
getEnums(quality: Quality, resolution?: Resolution, floppy: Floppy, stringOptions: StringOptions): string;
}
export default TurboModuleRegistry.getEnforcing<Spec>('SampleTurboModuleIOS');
packages/react-native-codegen/src/parsers/typescript/components/__test_fixtures__/fixtures.js
Vendored
+2 -2
View File
@@ -981,13 +981,13 @@ type NativeType = HostComponent<ModuleProps>;
interface NativeCommands {
readonly handleRootTag: (viewRef: React.ElementRef<NativeType>, rootTag: RootTag) => void;
readonly hotspotUpdate: (viewRef: React.ElementRef<NativeType>, x: Int32, y: Int32) => void;
readonly scrollTo: (
scrollTo(
viewRef: React.ElementRef<NativeType>,
x: Float,
y: Int32,
z: Double,
animated: boolean,
) => void;
): void;
}
export const Commands = codegenNativeCommands<NativeCommands>({
packages/react-native-codegen/src/parsers/typescript/components/__tests__/__snapshots__/typescript-component-parser-test.js.snap
+11
View File
@@ -1985,6 +1985,7 @@ exports[`RN Codegen TypeScript Parser can generate fixture COMMANDS_DEFINED_WITH
'params': [
{
'name': 'rootTag',
'optional': false,
'typeAnnotation': {
'type': 'ReservedTypeAnnotation',
'name': 'RootTag'
@@ -2004,12 +2005,14 @@ exports[`RN Codegen TypeScript Parser can generate fixture COMMANDS_DEFINED_WITH
'params': [
{
'name': 'x',
'optional': false,
'typeAnnotation': {
'type': 'Int32TypeAnnotation'
}
},
{
'name': 'y',
'optional': false,
'typeAnnotation': {
'type': 'Int32TypeAnnotation'
}
@@ -2028,24 +2031,28 @@ exports[`RN Codegen TypeScript Parser can generate fixture COMMANDS_DEFINED_WITH
'params': [
{
'name': 'x',
'optional': false,
'typeAnnotation': {
'type': 'FloatTypeAnnotation'
}
},
{
'name': 'y',
'optional': false,
'typeAnnotation': {
'type': 'Int32TypeAnnotation'
}
},
{
'name': 'z',
'optional': false,
'typeAnnotation': {
'type': 'DoubleTypeAnnotation'
}
},
{
'name': 'animated',
'optional': false,
'typeAnnotation': {
'type': 'BooleanTypeAnnotation'
}
@@ -3603,12 +3610,14 @@ exports[`RN Codegen TypeScript Parser can generate fixture COMMANDS_EVENTS_TYPES
'params': [
{
'name': 'y',
'optional': false,
'typeAnnotation': {
'type': 'Int32TypeAnnotation'
}
},
{
'name': 'animated',
'optional': false,
'typeAnnotation': {
'type': 'BooleanTypeAnnotation'
}
@@ -3651,12 +3660,14 @@ exports[`RN Codegen TypeScript Parser can generate fixture COMMANDS_WITH_EXTERNA
'params': [
{
'name': 'y',
'optional': false,
'typeAnnotation': {
'type': 'Int32TypeAnnotation'
}
},
{
'name': 'animated',
'optional': false,
'typeAnnotation': {
'type': 'BooleanTypeAnnotation'
}
packages/react-native-codegen/src/parsers/typescript/components/commands.js
Vendored
+35 -12
View File
@@ -19,16 +19,13 @@ const {parseTopLevelType} = require('../parseTopLevelType');
type EventTypeAST = Object;
function buildCommandSchema(property: EventTypeAST, types: TypeDeclarationMap) {
const topLevelType = parseTopLevelType(
property.typeAnnotation.typeAnnotation,
types,
);
const name = property.key.name;
const optional = property.optional || topLevelType.optional;
const value = topLevelType.type;
const firstParam = value.parameters[0].typeAnnotation;
function buildCommandSchemaInternal(
name: string,
optional: boolean,
parameters: Array<$FlowFixMe>,
types: TypeDeclarationMap,
): NamedShape<CommandTypeAnnotation> {
const firstParam = parameters[0].typeAnnotation;
if (
!(
firstParam.typeAnnotation != null &&
@@ -42,7 +39,7 @@ function buildCommandSchema(property: EventTypeAST, types: TypeDeclarationMap) {
);
}
const params = value.parameters.slice(1).map(param => {
const params = parameters.slice(1).map(param => {
const paramName = param.name;
const paramValue = parseTopLevelType(
param.typeAnnotation.typeAnnotation,
@@ -96,6 +93,7 @@ function buildCommandSchema(property: EventTypeAST, types: TypeDeclarationMap) {
return {
name: paramName,
optional: false,
typeAnnotation: returnType,
};
});
@@ -113,12 +111,37 @@ function buildCommandSchema(property: EventTypeAST, types: TypeDeclarationMap) {
};
}
function buildCommandSchema(
property: EventTypeAST,
types: TypeDeclarationMap,
): NamedShape<CommandTypeAnnotation> {
if (property.type === 'TSPropertySignature') {
const topLevelType = parseTopLevelType(
property.typeAnnotation.typeAnnotation,
types,
);
const name = property.key.name;
const optional = property.optional || topLevelType.optional;
const parameters = topLevelType.type.parameters || topLevelType.type.params;
return buildCommandSchemaInternal(name, optional, parameters, types);
} else {
const name = property.key.name;
const optional = property.optional || false;
const parameters = property.parameters || property.params;
return buildCommandSchemaInternal(name, optional, parameters, types);
}
}
function getCommands(
commandTypeAST: $ReadOnlyArray<EventTypeAST>,
types: TypeDeclarationMap,
): $ReadOnlyArray<NamedShape<CommandTypeAnnotation>> {
return commandTypeAST
.filter(property => property.type === 'TSPropertySignature')
.filter(
property =>
property.type === 'TSPropertySignature' ||
property.type === 'TSMethodSignature',
)
.map(property => buildCommandSchema(property, types))
.filter(Boolean);
}
packages/react-native-codegen/src/parsers/typescript/modules/__test_fixtures__/fixtures.js
Vendored
+2 -2
View File
@@ -412,9 +412,9 @@ import type {TurboModule} from 'react-native/Libraries/TurboModule/RCTExport';
import * as TurboModuleRegistry from 'react-native/Libraries/TurboModule/TurboModuleRegistry';
export interface Spec extends TurboModule {
readonly getArray: (
getArray(
arg: [string, string][],
) => (string | number | boolean)[];
): (string | number | boolean)[];
}
export default TurboModuleRegistry.getEnforcing<Spec>('SampleTurboModule');