Change format of qbs-configurations.json file

 ... that allows to specify an additional common build properties
 for any build configuration.

CHANGELOG.md

@@ -6,6 +6,9 @@
 export build profiles to a file.
  - Added new **Qbs: Import Build Profiles** command to
 import build profiles from a file.
+ - Changed format of the `qbs-configurations.json` file
+that allows to specify an additional common build properties
+for any build configuration.
 
 ## 2.1.4
 

docs/qbs-build-configurations.md

@@ -44,57 +44,120 @@ The default contents of this configuration file looks
 like this:
 
 ```json
-[
-    {
-        "name": "release",
-        "displayName": "Release",
-        "description": "Build with optimizations.",
-        "properties": {
-            "qbs.buildVariant": "release"
-        }
-    },
-    {
-        "name": "debug",
-        "displayName": "Debug",
-        "description": "Build with debug information.",
-        "properties": {
-            "qbs.buildVariant": "debug"
-        }
-    },
-    {
-        "name": "profiling",
-        "displayName": "Profiling",
-        "description": "Build with optimizations and debug information.",
-        "properties": {
-            "qbs.buildVariant": "profiling"
+{
+    "version": "1",
+    "configurations": [
+        {
+            "name": "release",
+            "displayName": "Release",
+            "description": "Build with optimizations.",
+            "properties": {
+                "qbs.buildVariant": "release"
+            }
+        },
+        {
+            "name": "debug",
+            "displayName": "Debug",
+            "description": "Build with debug information.",
+            "properties": {
+                "qbs.buildVariant": "debug"
+            }
+        },
+        {
+            "name": "profiling",
+            "displayName": "Profiling",
+            "description": "Build with optimizations and debug information.",
+            "properties": {
+                "qbs.buildVariant": "profiling"
+            }
         }
+    ],
+    "properties": {
+        "foo": "foo-value",
+        "bar": "bar-value",
     }
-]
+}
 ```
 
 The user can edit, remove, or add the other configurations.
 
 ## Specify overriden properties
 
-It is possible to specify a list of custom properties passed
+It is possible to specify a list of specific properties passed
 to the Qbs at resolve step for each build configuration
 separatelly using the `properties` item.
 
 For example, the possible configuration might look like this:
 
 ```json
-[
-    {
-        "name": "my-cool-config",
-        "displayName": "My Cool Config",
-        "description": "Enable something and override something.",
-        "properties": {
-            "projects.someProject.projectProperty": false,
-            "products.someProduct.productProperty": false,
-            "modules.cpp.treatWarningsAsErrors": true,
-            "products.someProduct.cpp.treatWarningsAsErrors": true,
-            "projects.someProject.listProp: ["a", "b", "c"]
+{
+    "name": "my-cool-config",
+    "displayName": "My Cool Config",
+    "description": "Enable something and override something.",
+    "properties": {
+        "projects.someProject.projectProperty": false,
+        "products.someProduct.productProperty": false,
+        "modules.cpp.treatWarningsAsErrors": true,
+        "products.someProduct.cpp.treatWarningsAsErrors": true,
+        "projects.someProject.listProp: ["a", "b", "c"]
+    }
+}
+```
+
+## Specify common properties
+
+It is possible to specify a list of common properties passed
+to the Qbs at resolve step for each build configuration.
+
+```json
+{
+    "properties": {
+        "foo": "foo-value",
+        "bar": "bar-value"
+    }
+}
+```
+
+E.g. this makes sense if some of overriden properties from
+build configuration are same (e.g. have duplicates):
+
+```json
+{
+    "configurations": [
+        {
+            "name": "release",
+            "properties": {
+                "my-prop": "my-value"
+            }
+        },
+        {
+            "name": "debug",
+            "properties": {
+                "my-prop": "my-value"
+            }
         }
+    ]
+}
+```
+
+then it can be re-written with:
+
+```json
+{
+    "configurations": [
+        {
+            "name": "release",
+        },
+        {
+            "name": "debug",
+        }
+    ],
+    "properties": {
+        "my-prop": "my-value"
     }
-]
+}
 ```
+
+**Note**: If a common property matches with a specific property,
+then the specific property value passed to the resolve step
+(i.e. overrides a common property).

src/datatypes/qbsbuildconfigurationdata.ts

@@ -1,8 +1,17 @@
 /** Qbs configuration data, obtained from the `qbs-configurations.json` file. */
-export class QbsBuildConfigurationData {
+
+export class QbsSpecificBuildConfigurationData {
     public constructor(
         public readonly name: string,
         public readonly displayName?: string,
         public readonly description?: string,
         public readonly properties?: { [key: string]: string }) { }
 }
+
+export class QbsAllBuildConfigurationData {
+    public constructor(
+        public readonly version: string,
+        public readonly configurations: QbsSpecificBuildConfigurationData[],
+        public readonly properties?: { [key: string]: string },
+    ) { }
+}

src/datatypes/qbsbuildconfigurationkey.ts

@@ -1,7 +1,9 @@
 /** Helper enumeration for wrapping the data keys from the `qbs-configurations.json` file. */
 export enum QbsBuildConfigurationKey {
+    Configurations = 'configurations',
     Description = 'description',
     DisplayName = 'displayName',
     Name = 'name',
     Properties = 'properties',
+    Version = 'version',
 }