mirror of
https://github.com/trezor/trezor-suite.git
synced 2026-03-20 06:08:39 +01:00
23a8ae6a09
* chore(wallet-utils): Moving wallet utils to common package * chore(suite-common) Device types moved to common package * chore(suite-common): Moving tests from suite to common package * chore(test): wallet utils tests moved to common suite package * chore: replace message system types from suite-types from common package * chore: import global JestMocks in suite and wallet-utils * chore: decrease jest global coverage thresholds for suite tests * chore: fix import for suite-config * chore: update refactored build paths and pckg for web and web-landing
1.4 KiB
1.4 KiB
Feature Flags
Feature flags allow us to enable and disable certain features at build time, helping us to produce specific builds for specific environments.
Work flow
All feature flags are located in suite-common/suite-config/src/features.ts. To add a new flag, start by doing the following:
- Add your flag to the
FLAGSconstant and set its defautl value. When naming your flag, bear in mind the following conventions:- Always explain what the flag is about using a comment next to it.
- The name of the flag should always be in capitals.
- The name of the flag should never contain the world
enableordisablebecause the name should always towards an enabled state. Its value should reflect whether the feature is enabled or not. - The name of the flag should never contain the word
flagbecause it's inferred.
- (optional) You can override the flag for each environment (web, desktop, landing) using their specific constants.
- Use the
isEnabledfunction from@suite-utils/featuresto check if the flag is enabled or not. - Wrap the code you wish to control in a condition checking for your flag being enabled or not.
Example
import { isEnabled } from '@suite-utils/features';
const main = () => {
alwaysRunning();
if (isEnabled('LABELING')) {
myLabelingFeature();
}
};
Future evolutions
- Control feature flags at runtime.