mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
df0b6900ec
Summary: ## Context babel-plugin-codegen: 1. Looks at HostComponent spec files (i.e: *NativeComponent.js files). 2. It runs the Static ViewConfig codegen (i.e: GenerateViewConfigJs.js) 3. It replaces codegenNativeComponent with NativeComponentRegistry.get. **Before** [react-native-svg/src/fabric/CircleNativeComponent.ts](https://github.com/react-native-svg/react-native-svg/pull/1847/files#diff-676990c4b50b85e2530021bed11f83744fb646c8ffcc769fd5d982eac1b97e98R9-R55) ``` interface SvgNodeCommonProps { name?: string; opacity?: WithDefault<Float, 1.0>; matrix?: ReadonlyArray<Float>; // transform?: ____TransformStyle_Internal, // CATransform3D, custom handling mask?: string; markerStart?: string; markerMid?: string; markerEnd?: string; clipPath?: string; clipRule?: WithDefault<Int32, 0>; responsible?: boolean; display?: string; } type ColorStruct = Readonly<{ type?: WithDefault<Int32, -1>; value?: ColorValue; brushRef?: string; }>; interface SvgRenderableCommonProps { fill?: ColorStruct; fillOpacity?: WithDefault<Float, 1.0>; fillRule?: WithDefault<Int32, 1>; stroke?: ColorStruct; strokeOpacity?: WithDefault<Float, 1.0>; strokeWidth?: WithDefault<string, '1'>; strokeLinecap?: WithDefault<Int32, 0>; strokeLinejoin?: WithDefault<Int32, 0>; strokeDasharray?: ReadonlyArray<string>; strokeDashoffset?: Float; strokeMiterlimit?: Float; vectorEffect?: WithDefault<Int32, 0>; propList?: ReadonlyArray<string>; } interface NativeProps extends ViewProps, SvgNodeCommonProps, SvgRenderableCommonProps { cx?: string; cy?: string; r?: string; } export default codegenNativeComponent<NativeProps>('RNSVGCircle'); ``` **After** ``` var __INTERNAL_VIEW_CONFIG = { uiViewClassName: "RNSVGCircle", validAttributes: { name: true, opacity: true, matrix: true, mask: true, markerStart: true, markerMid: true, markerEnd: true, clipPath: true, clipRule: true, responsible: true, display: true, fill: true, fillOpacity: true, fillRule: true, stroke: true, strokeOpacity: true, strokeWidth: true, strokeLinecap: true, strokeLinejoin: true, strokeDasharray: true, strokeDashoffset: true, strokeMiterlimit: true, vectorEffect: true, propList: true, cx: true, cy: true, r: true, }, }; exports.__INTERNAL_VIEW_CONFIG = __INTERNAL_VIEW_CONFIG; var _default = NativeComponentRegistry.get(nativeComponentName, function () { return __INTERNAL_VIEW_CONFIG; }); exports.default = _default; ``` ## Changes This babel plugin only worked with Flow HostComponent spec files. After this change, it'll start to work with TypeScript files as well. ## Motivation Once published, this update will allow us to make react-native-svg static ViewConfigs-compatible. For usage, see this GitHub commit: [feat: try to add babel plugin](https://github.com/react-native-svg/react-native-svg/pull/1847/commits/80fe687747fba6c7d7b072562278496b5fec15d1) Changelog: [General][Added] Make babel-plugin-codegen work for TypeScript Spec files Reviewed By: cipolleschi Differential Revision: D39136171 fbshipit-source-id: d89d35b591577e7626ce46a9c8e73b4d7ac7f227
172 lines
4.9 KiB
JavaScript
172 lines
4.9 KiB
JavaScript
/**
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @format
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
let flowParser, typeScriptParser, RNCodegen;
|
|
|
|
const {basename} = require('path');
|
|
|
|
try {
|
|
flowParser = require('react-native-codegen/src/parsers/flow');
|
|
typeScriptParser = require('react-native-codegen/src/parsers/typescript');
|
|
RNCodegen = require('react-native-codegen/src/generators/RNCodegen');
|
|
} catch (e) {
|
|
// Fallback to lib when source doesn't exit (e.g. when installed as a dev dependency)
|
|
flowParser = require('react-native-codegen/lib/parsers/flow');
|
|
typeScriptParser = require('react-native-codegen/lib/parsers/typescript');
|
|
RNCodegen = require('react-native-codegen/lib/generators/RNCodegen');
|
|
}
|
|
|
|
function parse(filename, code) {
|
|
if (filename.endsWith('js')) {
|
|
return flowParser.parseString(code);
|
|
}
|
|
|
|
if (filename.endsWith('ts')) {
|
|
return typeScriptParser.parseString(code);
|
|
}
|
|
|
|
throw new Error(
|
|
`Unable to parse file '${filename}'. Unsupported filename extension.`,
|
|
);
|
|
}
|
|
|
|
function generateViewConfig(filename, code) {
|
|
const schema = parse(filename, code);
|
|
|
|
const libraryName = basename(filename).replace(
|
|
/NativeComponent\.(js|ts)$/,
|
|
'',
|
|
);
|
|
return RNCodegen.generateViewConfig({
|
|
schema,
|
|
libraryName,
|
|
});
|
|
}
|
|
|
|
function isCodegenDeclaration(declaration) {
|
|
if (!declaration) {
|
|
return false;
|
|
}
|
|
|
|
if (
|
|
declaration.left &&
|
|
declaration.left.left &&
|
|
declaration.left.left.name === 'codegenNativeComponent'
|
|
) {
|
|
return true;
|
|
} else if (
|
|
declaration.callee &&
|
|
declaration.callee.name &&
|
|
declaration.callee.name === 'codegenNativeComponent'
|
|
) {
|
|
return true;
|
|
} else if (
|
|
declaration.type === 'TypeCastExpression' &&
|
|
declaration.expression &&
|
|
declaration.expression.callee &&
|
|
declaration.expression.callee.name &&
|
|
declaration.expression.callee.name === 'codegenNativeComponent'
|
|
) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
module.exports = function ({parse, types: t}) {
|
|
return {
|
|
pre(state) {
|
|
this.code = state.code;
|
|
this.filename = state.opts.filename;
|
|
this.defaultExport = null;
|
|
this.commandsExport = null;
|
|
this.codeInserted = false;
|
|
},
|
|
visitor: {
|
|
ExportNamedDeclaration(path) {
|
|
if (this.codeInserted) {
|
|
return;
|
|
}
|
|
|
|
if (
|
|
path.node.declaration &&
|
|
path.node.declaration.declarations &&
|
|
path.node.declaration.declarations[0]
|
|
) {
|
|
const firstDeclaration = path.node.declaration.declarations[0];
|
|
|
|
if (firstDeclaration.type === 'VariableDeclarator') {
|
|
if (
|
|
firstDeclaration.init &&
|
|
firstDeclaration.init.type === 'CallExpression' &&
|
|
firstDeclaration.init.callee.type === 'Identifier' &&
|
|
firstDeclaration.init.callee.name === 'codegenNativeCommands'
|
|
) {
|
|
if (
|
|
firstDeclaration.id.type === 'Identifier' &&
|
|
firstDeclaration.id.name !== 'Commands'
|
|
) {
|
|
throw path.buildCodeFrameError(
|
|
"Native commands must be exported with the name 'Commands'",
|
|
);
|
|
}
|
|
this.commandsExport = path;
|
|
return;
|
|
} else {
|
|
if (firstDeclaration.id.name === 'Commands') {
|
|
throw path.buildCodeFrameError(
|
|
"'Commands' is a reserved export and may only be used to export the result of codegenNativeCommands.",
|
|
);
|
|
}
|
|
}
|
|
}
|
|
} else if (path.node.specifiers && path.node.specifiers.length > 0) {
|
|
path.node.specifiers.forEach(specifier => {
|
|
if (
|
|
specifier.type === 'ExportSpecifier' &&
|
|
specifier.local.type === 'Identifier' &&
|
|
specifier.local.name === 'Commands'
|
|
) {
|
|
throw path.buildCodeFrameError(
|
|
"'Commands' is a reserved export and may only be used to export the result of codegenNativeCommands.",
|
|
);
|
|
}
|
|
});
|
|
}
|
|
},
|
|
ExportDefaultDeclaration(path, state) {
|
|
if (isCodegenDeclaration(path.node.declaration)) {
|
|
this.defaultExport = path;
|
|
}
|
|
},
|
|
|
|
Program: {
|
|
exit(path) {
|
|
if (this.defaultExport) {
|
|
const viewConfig = generateViewConfig(this.filename, this.code);
|
|
this.defaultExport.replaceWithMultiple(
|
|
parse(viewConfig, {
|
|
babelrc: false,
|
|
browserslistConfigFile: false,
|
|
configFile: false,
|
|
}).program.body,
|
|
);
|
|
if (this.commandsExport != null) {
|
|
this.commandsExport.remove();
|
|
}
|
|
this.codeInserted = true;
|
|
}
|
|
},
|
|
},
|
|
},
|
|
};
|
|
};
|