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',
  ],
  environments: [
    'staging',
    'production'
  ],
}

As your tags and environments grow, you can keep adding them to your configuration file.

Params#

tags#

An array of tags that can be used in your features. Tags are used for building smaller datafiles containing only the features that you need for your application(s).

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

environments#

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

By default, Featurevisor will use staging and production as environments:

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

If your project does not need any environments, you can also disable it:

module.exports = {
  environments: false,
}

Read more in Environments page.

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.

testsDirectoryPath#

Path to the directory containing your tests.

Defaults to <rootDir>/tests.

datafilesDirectoryPath#

Path to the directory for your generated datafiles.

Defaults to <rootDir>/dist.

datafileNamePattern#

Defaults to featurevisor-%s.json.

stateDirectoryPath#

Path to the directory containing your state.

Defaults to <rootDir>/.featurevisor.

Read more in State files.

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.