Combining Resources

You can generate arbitrary files or parameter files from multiple resource files. This can be useful for configuring your applications based on the compatibilities of your targets.

Basics

Let's start with the simplest by combining texts. To combine text files, you need to declare the source files one after the other with a pipe delimiter |. Here's a concrete example to combine 3 parameter files into a single parameter file.

- source: param1.txt | param2.txt | param3.txt
  destination: param.txt
  compatibility:
    - ...

The param.txt file generated in the package will be the combination of the param1.txt, param2.txt, and param3.txt files.

Combining Parameters

Now let's see how to combine parameter files. Here we'll see how to combine files of the following formats:

• yaml
• yml
• json
• xml
• ini
• toml
• plist

Combining yaml or yml

The declaration is the same except that you declare YAML or YML configuration files here. Here's an example of combining YAML or YML configuration files.

We will here combine the parameter files param1.yaml, param2.yaml together as well as param3.yml and param4.yml. Here's how it looks in the resource file.

- source: param1.yaml | param2.yaml
  destination: param.yaml
  compatibility:
    - ...
 
- source: param3.yml | param4.yml
  destination: param.yml
  compatibility:
    - ...

AIOP reads the parameter files in the order of declaration (param1.yaml, param2.yaml), then combines the fields and writes to the destination file (param.yaml) by sorting the keys alphabetically.

For example, if param1.yaml contains:

version:
  major: 1
  minor: 0
name: aiop

and param2.yaml contains:

version:
  patch: 0

then the destination file param.yaml will contain:

name: aiop
version:
  major: 1
  minor: 0
  patch: 0

The keys are sorted alphabetically and the version fields are combined.

Combining json

Here's an example of combining JSON configuration files.

We will here combine the parameter files param1.json, param2.json. Here's how it looks in the resource file.

- source: param1.json | param2.json
  destination: param.json
  compatibility:
    - ...

AIOP reads the parameter files in the order of declaration (param1.json, param2.json), then combines the fields and writes to the destination file (param.json) by sorting the keys alphabetically.

For example, if param1.json contains:

{
  "version": {
    "major": 1,
    "minor": 0
  },
  "name" : "aiop"
}

and param2.json contains:

{
  "version": {
    "patch": 0
  }
}

then the destination file param.json will contain:

{
  "name": "aiop",
  "version": {
    "major": 1,
    "minor": 0,
    "patch": 0
  }
}

Combining xml

Here's an example of combining XML configuration files.

We will here combine the parameter files param1.xml, param2.xml. Here's how it looks in the resource file.

- source: param1.xml | param2.xml
  destination: param.xml
  compatibility:
    - ...

AIOP reads the parameter files in the order of declaration (param1.xml, param2.xml), then combines the fields and writes to the destination file (param.xml) by sorting the keys alphabetically.

For example, if param1.xml contains:

</version>
  <major>1</major>
  <minor>0</minor>
</version>
<name>aiop</name>

and param2.xml contains:

<version>
  <patch>0</patch>

then the destination file param.xml will contain:

<name>aiop</name>
<version>
  <major>1</major>
  <minor>0</minor>
  <patch>0</patch>

Combining ini

Here's an example of combining INI configuration files.

We will here combine the parameter files param1.ini, param2.ini. Here's how it looks in the resource file.

- source: param1.ini | param2.ini
  destination: param.ini
  compatibility:
    - ...

AIOP reads the parameter files in the order of declaration (param1.ini, param2.ini), then combines the fields and writes to the destination file (param.ini) by sorting the keys alphabetically.

For example, if param1.ini contains:

[version]
major = 1
minor = 0
 
[name]
value = aiop

and param2.ini contains:

[version]
patch = 0

then the destination file param.ini will contain:

[name]
value = aiop
 
[version]
major = 1
minor = 0
patch = 0

Combining toml

Here's an example of combining TOML configuration files.

We will here combine the parameter files param1.toml, param2.toml. Here's how it looks in the resource file.

- source: param1.toml | param2.toml
  destination: param.toml
  compatibility:
    - ...

AIOP reads the parameter files in the order of declaration (param1.toml, param2.toml), then combines the fields and writes to the destination file (param.toml) by sorting the keys alphabetically.

For example, if param1.toml contains:

[version]
major = 1
minor = 0
 
[name]
value = aiop

and param2.toml contains:

[version]
patch = 0

then the destination file param.toml will contain:

[name]
value = aiop
 
[version]
major = 1
minor = 0
patch = 0

Combining plist

Here's an example of combining PLIST configuration files.

We will here combine the parameter files param1.plist, param2.plist. Here's how it looks in the resource file.

- source: param1.plist | param2.plist
  destination: param.plist
  compatibility:
    - ...

AIOP reads the parameter files in the order of declaration (param1.plist, param2.plist), then combines the fields and writes to the destination file (param.plist) by sorting the keys alphabetically.

For example, if param1.plist contains:

<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>version</key>
    <dict>
        <key>major</key>
        <integer>1</integer>
        <
 
key>minor</key>
        <integer>0</integer>
    </dict>
    <key>name</key>
    <string>aiop</string>
</dict>
</plist>
 

and param2.plist contains:

<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>version</key>
    <dict>
        <key>patch</key>
        <integer>0</integer>
    </dict>
</dict>
</plist>
 

then the destination file param.plist will contain:

<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>name</key>
    <string>aiop</string>
    <key>version</key>
    <dict>
        <key>major</key>
        <integer>1</integer>
        <key>minor</key>
        <integer>0</integer>
        <key>patch</key>
        <integer>0</integer>
    </dict>
</dict>
</plist>

Other Files

Any other type of file can be combined in the same manner. The only difference will be that the files will be simply concatenated without line breaks or separators.