search

AmadeusITGroup / otter

The Otter project is a highly modular framework whose goal is to provide a common platform to accelerate and facilitate the development of runtime customizable Angular based Web Applications
https://amadeusitgroup.github.io/otter/
BSD 3-Clause "New" or "Revised" License
51 stars 38 forks source link

feat: add checkAfterItems in builders #2503

Open guillaumerochelle opened 1 week ago

guillaumerochelle commented 1 week ago

Proposed change

Add checkAfterItems in metadata-check builder. This new option allows devs to deactivate checks on items set in "after" property. This will allow documenting breaking changes in modules which don't have access to the complete metadata.

For example with this migration change:

{
  "version": "1.0.0",
  "changes": [
    {
      "contentType": "CONFIG",
      "before": {
        "libraryName": "@mylib/moduleA",
        "configName": "Foo",
        "propertyName": "bar"
      },
      "after": {
        "libraryName": "@mylib/moduleB",
        "configName": "Bar",
        "propertyName": "baz"
      }
    }
  ]
}

When running builder @o3r/components:check-config-migration-metadata, the metadata file is the one of module @mylib/moduleA and doesn't contain any metadata from other modules (@mylib/moduleB). The check for property "baz" in config interface @mylib/moduleB#Bar will fail.

With the new option checkAfterItems, we can deactivate this check.

Bonus: Add packageJsonEntry in the schema of :

Related issues