Configuration

Every Featurevisor project expects a featurevisor.config.js file at the root of the project, next to package.json.

featurevisor.config.js#

Minimum configuration:

module.exports = {
  tags: [
    'web',
    'mobile',
  ],
}

As your tags grow, you can keep adding them to your configuration file. If your project needs environments, configure them explicitly.

Params#

tags#

An array of tags that can be used in your features and targets.

module.exports = {
  tags: [
    'web',
    'ios',
    'android',
    'all'
  ],
}

environments#

An optional array of environments that can be used in your features.

By default, Featurevisor has no environments. This means feature rules are defined directly:

rules:
  - key: everyone
    segments: '*'
    percentage: 100

If your project needs environments, define them as an array of strings:

module.exports = {
  environments: [
    'staging',
    'production'
  ],
}

Read more in Environments page.

sets#

Whether the project is split into independent sets.

Defaults to false. When set to true, Featurevisor expects each set to live under its own subdirectory inside the sets directory:

module.exports = {
  sets: true,
  tags: ['all'],
}

Read more in Sets page.

promotionFlows#

An optional array that restricts which promotions are allowed between sets.

Each entry must contain exactly a from and a to set name. When omitted, any set can be promoted to any other set.

module.exports = {
  sets: true,
  promotionFlows: [
    { from: 'dev', to: 'staging' },
    { from: 'staging', to: 'production' },
  ],
}

Read more in Promotions page.

namespaceCharacter#

The separator used when deriving feature and segment keys from their namespace directories.

Defaults to .. With the default, features/checkout/feature1.yml becomes checkout.feature1.

module.exports = {
  namespaceCharacter: '.',
}

targetsDirectoryPath#

Path to the directory containing your targets.

Defaults to <rootDir>/targets.

setsDirectoryPath#

Path to the directory containing your sets.

Defaults to <rootDir>/sets.

attributesDirectoryPath#

Path to the directory containing your attributes.

Defaults to <rootDir>/attributes.

segmentsDirectoryPath#

Path to the directory containing your segments.

Defaults to <rootDir>/segments.

featuresDirectoryPath#

Path to the directory containing your features.

Defaults to <rootDir>/features.

groupsDirectoryPath#

Path to the directory containing your groups.

Defaults to <rootDir>/groups.

schemasDirectoryPath#

Path to the directory containing your reusable schemas.

Defaults to <rootDir>/schemas.

testsDirectoryPath#

Path to the directory containing your tests.

Defaults to <rootDir>/tests.

datafilesDirectoryPath#

Path to the directory for your generated datafiles.

Defaults to <rootDir>/datafiles.

datafileNamePattern#

Pattern used to name generated datafiles, where %s is replaced by the target key.

Defaults to featurevisor-%s.json.

revisionFileName#

Defaults to REVISION.

Name of the file that will be used to store the revision number of your project.

stateDirectoryPath#

Path to the directory containing your state.

Defaults to <rootDir>/.featurevisor.

Read more in State files.

catalogDirectoryPath#

Path to the directory where the generated catalog is written.

Defaults to <rootDir>/catalog.

defaultBucketBy#

Default value for the bucketBy property in your project. Defaults to userId.

prettyState#

Set to true or false to enable or disable pretty-printing of state files.

Defaults to true.

prettyDatafile#

Set to true or false to enable or disable pretty-printing of datafiles.

Defaults to false.

stringify#

By default, Featurevisor will stringify conditions and segments in generated datafiles so that they are parsed only when needed by the SDKs. This optimization technique works well when datafiles are too large in client-side devices (think browsers) and you are only dealing with one user in the runtime.

This kind of optimization though can bring opposite results if you are using the SDKs in server-side (think Node.js) serving many different users.

To disable this stringification, you can set it to false.

parser#

By default, Featurevisor expects YAML for all definitions. You can change this to JSON by setting parser: "json".

See custom parsers for more information.

enforceCatchAllRule#

When set to true, linting will make sure all features have a catch-all rule with segment: "*" as the last rule in all environments.

maxVariableStringLength#

Maximum length of a string variable in features. Defaults to no limit.

maxVariableArrayStringifiedLength#

Maximum length of a stringified array variable in features. Defaults to no limit.

maxVariableObjectStringifiedLength#

Maximum length of a stringified object variable in features. Defaults to no limit.

maxVariableJSONStringifiedLength#

Maximum length of a JSON stringified variable in features. Defaults to no limit.