feat: Introduce Multi-file Project Configurations

[wsidl]

Summary

The project file will be required to support the generation of a common input sources but requiring different parameters to express alternate and/or conflicting patterns. This feature will introduce a !include tag that would allow including the content of a nearby file.

Current Behaviour

Requires re-implementing a project file with the data sources and making minor modifications. For example, project_1.yaml could have two objects with 2 fields each, where obj2.field2 is a status of obj1.field2:

obj1:
  type: object
  properties:
    field1:
      type: string
    field2:
      type: integer
obj2:
  type: object
  properties:
    field1:
      type: static
      value: "sensor"
    field2:
      type: string
      expression: "['below, 'above'][(obj1().field2 > 0) | int]"

Creating a another project with the same objects, output types, and configurations but with a slight modification (like the following means copying the entire file.

...
obj2:
    ...
    field2:
      type: string
      expression: "['even', 'odd'][obj2().field2 % 2 | int]"

The problem this creates is a maintenance issue if the structure of either object changes, it will need to be changed for all files.

Expected Behaviour

Instead of maintaining all of these individual files, it would be possible to create a single set of object definitions with known parameters and include those into the project file with overridden modifications.

Using the above example, each object can be their own file:

obj1.yaml

type: object
properties:
  field1:
    type: string
  field2:
    type: integer

obj2.yaml

type: object
properties:
  field1:
    type: static
    value: sensor
  field2:
    type: string

Then each project file can include it into their project with modifications.

project1.yaml

obj1: << !include obj1.yaml
obj2: << !include obj2.yaml
  field2:
    expression: "['below, 'above'][(obj1().field2 > 0) | int]"

`project2.yaml

obj1: << !include obj1.yaml
obj2: << !include obj2.yaml
  field2:
    expression: "['even', 'odd'][obj2().field2 % 2 | int]"

so if modifications occur to obj1 that could potentially impact downstream logic, it would be modified in one place with only individual modifications where overrides take place.

Additional Notes

Since YAML also supports multi-document files, the !include tag can also include an index of the document within the file to reference.