Skip to content

Commit 937ced3

Browse files
hramosgrabbou
authored andcommittedFeb 1, 2021
Optionally override codegen script defaults via envvars
Summary: The codegen helper script, `generate-specs.sh`, is being used to generate code for the FBReactNativeSpec and React-Fabric/rncore pods. The script now supports overriding several defaults by setting the following environment variables: - SRCS_DIR: Path to JavaScript sources, defaults to $RN_DIR/Libraries/ - LIBRARY_NAME: Defaults to FBReactNativeSpec - MODULES_OUTPUT_DIR: Defaults to Libraries/$LIBRARY_NAME/$LIBRARY_NAME - COMPONENTS_LIBRARY_NAME: Defaults to rncore - COMPONENTS_OUTPUT_DIR: Defaults to ReactCommon/react/renderer/components/$COMPONENTS_LIBRARY_NAME The CocoaPods codegen integration has been updated to take advantage of these. **Example CocoaPods usage:** ``` # packages/rn-tester/NativeModuleExample/RNTesterSpecs.podspec Pod::Spec.new do |s| s.name = "RNTesterSpec" # ... use_react_native_codegen!(s, { :srcs_dir => __dir__, :modules_output_dir => __dir__ }) end ``` Changelog: [Internal] Reviewed By: fkgozali Differential Revision: D25738466 fbshipit-source-id: c68f5a3cd0996283a7af287e992e2f973024f44c
1 parent e5888de commit 937ced3

File tree

3 files changed

+42
-24
lines changed

3 files changed

+42
-24
lines changed
 

‎packages/rn-tester/Podfile.lock

+1-1
Original file line numberDiff line numberDiff line change
@@ -798,7 +798,7 @@ SPEC CHECKSUMS:
798798
CocoaLibEvent: 2fab71b8bd46dd33ddb959f7928ec5909f838e3f
799799
DoubleConversion: cde416483dac037923206447da6e1454df403714
800800
FBLazyVector: fe973c09b2299b5e8154186ecf1f6554b4f70987
801-
FBReactNativeSpec: cc83b1f9c1a764577c37a7009d002b8afb36f192
801+
FBReactNativeSpec: d0504078deb2ffa0fbee5032382f4ef165a1c8a8
802802
Flipper: be611d4b742d8c87fbae2ca5f44603a02539e365
803803
Flipper-DoubleConversion: 38631e41ef4f9b12861c67d17cb5518d06badc41
804804
Flipper-Folly: e4493b013c02d9347d5e0cb4d128680239f6c78a

‎scripts/generate-specs.sh

+21-9
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,16 @@
88
# native modules and components, then uses react-native-codegen
99
# to generate native code.
1010
#
11+
# Optionally, set these envvars to override defaults:
12+
# - SRCS_DIR: Path to JavaScript sources
13+
# - CODEGEN_MODULES_LIBRARY_NAME: Defaults to FBReactNativeSpec
14+
# - CODEGEN_MODULES_OUTPUT_DIR: Defaults to Libraries/$CODEGEN_MODULES_LIBRARY_NAME/$CODEGEN_MODULES_LIBRARY_NAME
15+
# - CODEGEN_COMPONENTS_LIBRARY_NAME: Defaults to rncore
16+
# - CODEGEN_COMPONENTS_OUTPUT_DIR: Defaults to ReactCommon/react/renderer/components/$CODEGEN_COMPONENTS_LIBRARY_NAME
17+
#
1118
# Usage:
1219
# ./scripts/generate-specs.sh
20+
# SRCS_DIR=myapp/js CODEGEN_MODULES_LIBRARY_NAME=MySpecs CODEGEN_MODULES_OUTPUT_DIR=myapp/MySpecs ./scripts/generate-specs.sh
1321
#
1422

1523
# shellcheck disable=SC2038
@@ -33,12 +41,16 @@ describe () {
3341
}
3442

3543
main() {
36-
SRCS_DIR=$(cd "$RN_DIR/Libraries" && pwd)
44+
SRCS_DIR=${SRCS_DIR:-$(cd "$RN_DIR/Libraries" && pwd)}
45+
CODEGEN_MODULES_LIBRARY_NAME=${CODEGEN_MODULES_LIBRARY_NAME:-FBReactNativeSpec}
3746

38-
OUTPUT_DIR="$TEMP_DIR/out"
39-
COMPONENTS_DIR="$RN_DIR/ReactCommon/react/renderer/components/rncore"
40-
MODULES_DIR="$RN_DIR/Libraries/FBReactNativeSpec/FBReactNativeSpec"
47+
CODEGEN_COMPONENTS_LIBRARY_NAME=${CODEGEN_COMPONENTS_LIBRARY_NAME:-rncore}
48+
CODEGEN_MODULES_OUTPUT_DIR=${CODEGEN_MODULES_OUTPUT_DIR:-"$RN_DIR/Libraries/$CODEGEN_MODULES_LIBRARY_NAME/$CODEGEN_MODULES_LIBRARY_NAME"}
49+
# TODO: $CODEGEN_COMPONENTS_PATH should be programmatically specified, and may change with use_frameworks! support.
50+
CODEGEN_COMPONENTS_PATH="ReactCommon/react/renderer/components"
51+
CODEGEN_COMPONENTS_OUTPUT_DIR=${CODEGEN_COMPONENTS_OUTPUT_DIR:-"$RN_DIR/$CODEGEN_COMPONENTS_PATH/$CODEGEN_COMPONENTS_LIBRARY_NAME"}
4152

53+
TEMP_OUTPUT_DIR="$TEMP_DIR/out"
4254
SCHEMA_FILE="$TEMP_DIR/schema.json"
4355

4456
CODEGEN_REPO_PATH="$RN_DIR/packages/react-native-codegen"
@@ -66,13 +78,13 @@ main() {
6678

6779
describe "Generating native code from schema (iOS)"
6880
pushd "$RN_DIR" >/dev/null || exit
69-
"$YARN_BINARY" --silent node scripts/generate-specs-cli.js ios "$SCHEMA_FILE" "$OUTPUT_DIR"
81+
"$YARN_BINARY" --silent node scripts/generate-specs-cli.js ios "$SCHEMA_FILE" "$TEMP_OUTPUT_DIR" "$CODEGEN_MODULES_LIBRARY_NAME"
7082
popd >/dev/null || exit
7183

72-
mkdir -p "$COMPONENTS_DIR" "$MODULES_DIR"
73-
mv "$OUTPUT_DIR/FBReactNativeSpec.h" "$OUTPUT_DIR/FBReactNativeSpec-generated.mm" "$MODULES_DIR"
74-
find "$OUTPUT_DIR" -type f | xargs sed -i '' 's/FBReactNativeSpec/rncore/g'
75-
cp -R "$OUTPUT_DIR/." "$COMPONENTS_DIR"
84+
mkdir -p "$CODEGEN_COMPONENTS_OUTPUT_DIR" "$CODEGEN_MODULES_OUTPUT_DIR"
85+
mv "$TEMP_OUTPUT_DIR/$CODEGEN_MODULES_LIBRARY_NAME.h" "$TEMP_OUTPUT_DIR/$CODEGEN_MODULES_LIBRARY_NAME-generated.mm" "$CODEGEN_MODULES_OUTPUT_DIR"
86+
find "$TEMP_OUTPUT_DIR" -type f | xargs sed -i '' "s/$CODEGEN_MODULES_LIBRARY_NAME/$CODEGEN_COMPONENTS_LIBRARY_NAME/g"
87+
cp -R "$TEMP_OUTPUT_DIR/." "$CODEGEN_COMPONENTS_OUTPUT_DIR"
7688
}
7789

7890
trap cleanup EXIT

‎scripts/react_native_pods.rb

+20-14
Original file line numberDiff line numberDiff line change
@@ -153,30 +153,36 @@ def use_react_native_codegen!(spec, options={})
153153
srcs_dir = options[:srcs_dir] ||= File.join(prefix, "Libraries")
154154

155155
# Library name (e.g. FBReactNativeSpec)
156-
library_name = spec.name
157-
modules_output_dir = File.join(prefix, "Libraries/#{library_name}/#{library_name}")
156+
codegen_modules_library_name = spec.name
157+
codegen_modules_output_dir = options[:codegen_modules_output_dir] ||= File.join(prefix, "Libraries/#{codegen_modules_library_name}/#{codegen_modules_library_name}")
158158

159159
# Run the codegen as part of the Xcode build pipeline.
160+
env_vars = "SRCS_DIR=#{srcs_dir}"
161+
env_vars += " CODEGEN_MODULES_OUTPUT_DIR=#{codegen_modules_output_dir}"
162+
if ENV['USE_FABRIC'] == '1'
163+
# We use a different library name for components, as well as an additional set of files.
164+
# Eventually, we want these to be part of the same library as #{codegen_modules_library_name} above.
165+
codegen_components_library_name = "rncore"
166+
codegen_components_output_dir = File.join(prefix, "ReactCommon/react/renderer/components/#{codegen_components_library_name}")
167+
env_vars += " CODEGEN_COMPONENTS_OUTPUT_DIR=#{codegen_components_output_dir}"
168+
end
160169
spec.script_phase = {
161170
:name => 'Generate Specs',
162171
:input_files => [srcs_dir],
163-
:output_files => ["$(DERIVED_FILE_DIR)/codegen.log"],
164-
:script => "sh '#{File.join(__dir__, "generate-specs.sh")}' | tee \"${SCRIPT_OUTPUT_FILE_0}\"",
165-
:execution_position => :before_compile
172+
:output_files => ["$(DERIVED_FILE_DIR)/codegen-#{codegen_modules_library_name}.log"],
173+
:script => "bash -c '#{env_vars} CODEGEN_MODULES_LIBRARY_NAME=#{codegen_modules_library_name} #{File.join(__dir__, "generate-specs.sh")}' | tee \"${SCRIPT_OUTPUT_FILE_0}\"",
174+
:execution_position => :before_compile,
175+
:show_env_vars_in_log => true
166176
}
167177

168178
# Since the generated files are not guaranteed to exist when CocoaPods is run, we need to create
169179
# empty files to ensure the references are included in the resulting Pods Xcode project.
170-
mkdir_command = "mkdir -p #{modules_output_dir}"
171-
generated_filenames = [ "#{library_name}.h", "#{library_name}-generated.mm" ]
172-
generated_files = generated_filenames.map { |filename| File.join(modules_output_dir, filename) }
180+
mkdir_command = "mkdir -p #{codegen_modules_output_dir}"
181+
generated_filenames = [ "#{codegen_modules_library_name}.h", "#{codegen_modules_library_name}-generated.mm" ]
182+
generated_files = generated_filenames.map { |filename| File.join(codegen_modules_output_dir, filename) }
173183

174184
if ENV['USE_FABRIC'] == '1'
175-
# We use a different library name for components, as well as an additional set of files.
176-
# Eventually, we want these to be part of the same library as #{library_name} above.
177-
components_library_name = "rncore"
178-
components_output_dir = File.join(prefix, "ReactCommon/react/renderer/components/#{components_library_name}")
179-
mkdir_command += " #{components_output_dir}"
185+
mkdir_command += " #{codegen_components_output_dir}"
180186
components_generated_filenames = [
181187
"ComponentDescriptors.h",
182188
"EventEmitters.cpp",
@@ -187,7 +193,7 @@ def use_react_native_codegen!(spec, options={})
187193
"ShadowNodes.cpp",
188194
"ShadowNodes.h"
189195
]
190-
generated_files = generated_files.concat(components_generated_filenames.map { |filename| File.join(components_output_dir, filename) })
196+
generated_files = generated_files.concat(components_generated_filenames.map { |filename| File.join(codegen_components_output_dir, filename) })
191197
end
192198

193199
spec.prepare_command = "#{mkdir_command} && touch #{generated_files.reduce() { |str, file| str + " " + file }}"

0 commit comments

Comments
 (0)
Please sign in to comment.