cdk.json seems to ignore various options

• I’m submitting a …

  • 🪲 bug report

• What is the current behavior? When I add various settings options to the cdk.json file, they don’t seem to be applied when running cdk synth. Specifically pathMetadata and assetMetadata

To reproduce: make some very basic cdk app (I am currently using python). cdk.json

{
    "app": "python3 app.py",
    "pathMetadata": false,
    "assetMetadata": false,
    "versionReporting": false
}

When I run cdk -v synth I get the following:

cdk.json: {
  "app": "python3 app.py",
  "pathMetadata": false,
  "assetMetadata": false,
  "versionReporting": false,
  "staging": false
}
merged settings: {
  versionReporting: false,
  pathMetadata: true,
  output: 'cdk.out',
  app: 'python3 app.py',
  assetMetadata: true,
  staging: true,
  context: {},
  tags: []
}

Clearly you can see the pathMetadata and assetMetadata in the cdk.json but it doesn’t merge into the settings

• What is the expected behavior (or behavior of feature suggested)? That the cdk.json settings be merged into the settings

• What is the motivation / use case for changing the behavior or adding this feature? This is how it should work already

• Please tell us about your environment:

  • CDK CLI Version: 1.3.0
  • OS: macOS Mojave
  • Language: Python

[eladb]

Yes, we currently don’t have support for all switches in cdk.json and we should!

[zradlo1984]

The reason is that in cdk.js all options that has defaults specified (excluding undefined value) will be set after command line arguments are parsed. And in settings.js (class Configuration) there is this code:

        this.settings = this.defaultConfig
            .merge(userConfig)
            .merge(this.projectConfig)
            .merge(this.commandLineArguments)
            .makeReadOnly();

so defaultConfig is overriden by userConfig (~/cdk.json) then by projectConfig(cdk.json) and then with commandLineArguments (which includes all defaults specified in cdk.js function parseCommandLineArguments so command line defaults overrides all options specified earlier).