Gathering detailed insights and metrics for expo-build-flags
Gathering detailed insights and metrics for expo-build-flags
Gathering detailed insights and metrics for expo-build-flags
Gathering detailed insights and metrics for expo-build-flags
npm install expo-build-flags
Module System
Min. Node Version
Typescript Support
Node Version
NPM Version
42 Commits
1 Watching
3 Branches
1 Contributors
Updated on 13 Nov 2024
TypeScript (59.49%)
JavaScript (30.06%)
Ruby (6.44%)
Shell (4.01%)
Cumulative downloads
Total Downloads
Last day
-15.2%
1,029
Compared to previous day
Last week
46.8%
5,370
Compared to previous week
Last month
15.5%
21,225
Compared to previous month
Last year
0%
40,112
Compared to previous year
A module to make feature-flagging easier for expo projects.
This module is in active development and is not stable or well documented yet.
yarn add expo-build-flags
Add a flags file to the root of your repo in the form of the test example, or run yarn build-flags init
.
Run yarn build-flags override +secretFeature -newFeature
sometime before your bundle server or build start to generate the runtime typescript module. This path is defined by mergePath
and you should add it to your project gitignore.
The arguments after the override command are the flags you want to +
enable or -
disable. No comparison with the default value is done, so if it's already enabled and you +enable
it, it's a no-op.
You can run yarn build-flags ota-override
instead of "override" to do the same but also consider the branch name in two supported CI environments: Github and Gitlab. Use the ota.branches
array in the flags.yml to setup that matching and branch-based enablement.
To set flags for EAS builds, set the EXPO_BUILD_FLAGS
environment variable in eas.json
for your profile. This value will be available to the config plugin at build time in EAS when you add it to your app.json
plugins array:
1{ 2 "expo": { 3+ "plugins": ["expo-build-flags"] 4 } 5}
Using the EXPO_BUILD_FLAGS
environment variable, the config plugin will:
<meta-data android:name="EXBuildFlags" />
tag to your AndroidManifest.xmlEXBuildFlags
array to your Info.plistThe variable value is a comma-separated list of flag names you want to enable, ie: EXPO_BUILD_FLAGS=newFeature,secretFeature
.
To benefit from tree shaking, add the babel plugin to your project's babel config:
1{ 2 presets: ["babel-preset-expo"], 3 plugins: [ 4+ ["expo-build-flags/babel-plugin", { flagsModule: "./constants/buildFlags.ts" }], 5 ], 6}
The flagsModule
path must match the runtime mergePath
in your committed flags.yml file. This plugin replaces the BuildFlags
imports with the literal boolean values which allows the build pipeline to strip unreachable paths.
If your feature relies on native module behaviour, you may want to avoid linking that module if the build flag is off. To do so, specify the absolute name or relative path to the module in the base definition for your flag:
Example for flags.yml definition:
1flags: 2 featureWithNativeStuff: 3 value: false 4 modules: 5 - react-native-device-info
In the above example, react-native-device-info
would be excluded from autolinking. If you want to allow builds to occur on a specific branch, you can specify it:
1modules: 2 - react-native-device-info: 3 branch: some-branch-with-build
Locally-referenced modules aren't currently supported (until this 'exclude' exclusion can be overridden).
No vulnerabilities found.
No security vulnerabilities found.