Skip to content

Configuration

Gáspár Nagy edited this page Jul 3, 2019 · 2 revisions

Deveroom uses conventions and the SpecFlow configuration for all usual setting.

Some additional settings can be configured using a Deveroom JSON configuration file. The configuration file has to be named as deveroom.json and can be placed in the following folders.

  • the project folder -- project-level settings
  • the solution folder -- solution-level settings (coming soon)
  • the %LOCALAPPDATA%\Deveroom\ folder -- user-level settings for this machine (coming soon)

You can add Deveroom configuration files to your project using the "Add / New Item..." dialog, by selecting "Deveroom configuration file" from the "Deveroom" group. (Please make sure you set the name to deveroom.json.)

Editing the Deveroom configuration file is supported by a JSON schema, that enables auto-completion and documentation in Visual Studio.

Any file or folder path setting int he configuration file can contain a path that is either absolute or relative to the location of the configuration file. You can also use environment variables in these path settings, using the %ENVVAR% format, e.g. "generatorFolder": "%USERPROFILE%\\.nuget\\packages\\SpecFlow\\2.3.1\\tools".

Note: Currently you need to build your project to apply the configuration changes you have made in the deveroom.json file.

Sample configuration file

{
  "$schema": "http://schemas.specsolutions.eu/deveroom-config-latest.json",

  "specFlow": { // this settings are only required if the SpecFlow references are not provided via NuGet packages
    "isSpecFlowProject": true,
    "generatorFolder": "..\\packages\\SpecFlow.2.3.0\\tools",
    "traits": [
      "MsBuildGeneration",
      "DesignTimeFeatureFileGeneration"
    ]
  }
}
Clone this wiki locally