feat: add packageJsonEntry and checkAfterItems in builders

AmadeusITGroup · Nov 22, 2024 · dd84a6b · dd84a6b
1 parent 2c094a7
commit dd84a6b
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 2 deletions.
diff --git a/packages/@o3r/components/builders/metadata-check/schema.json b/packages/@o3r/components/builders/metadata-check/schema.json
@@ -34,6 +34,16 @@
       "type": "string",
       "description": "Path of the config metadata file.",
       "default": "./component.config.metadata.json"
+    },
+    "packageJsonEntry": {
+      "type": "string",
+      "description": "Entry to check for previous metadata in the `package.json` file under `cmsMetadata`.",
+      "default": "configurationFilePath"
+    },
+    "checkAfterItems": {
+      "type": "boolean",
+      "description": "Whether after items should be checked.",
+      "default": true
     }
   },
   "additionalProperties": false,

diff --git a/packages/@o3r/extractors/src/core/comparator/metadata-comparator.interface.ts b/packages/@o3r/extractors/src/core/comparator/metadata-comparator.interface.ts
@@ -85,4 +85,7 @@ export interface MigrationMetadataCheckBuilderOptions extends JsonObject {
 
   /** Entry to check for previous metadata in the `package.json` file under `cmsMetadata`. */
   packageJsonEntry: keyof Omit<CmsMetadataData, 'libraryName'>;
+
+  /** Whether to check the items set in "after" property in the migration file. */
+  checkAfterItems: boolean;
 }
diff --git a/packages/@o3r/extractors/src/core/comparator/metadata-comparison.helper.ts b/packages/@o3r/extractors/src/core/comparator/metadata-comparison.helper.ts
@@ -16,6 +16,7 @@ function checkMetadataFile<MetadataItem, MigrationMetadataItem, MetadataFile>(
   newMetadataFile: MetadataFile,
   migrationData: MigrationData<MigrationMetadataItem>[],
   isBreakingChangeAllowed: boolean,
+  checkAfterItems: boolean,
   comparator: MetadataComparator<MetadataItem, MigrationMetadataItem, MetadataFile>
 ): Error[] {
   const errors: Error[] = [];
@@ -40,7 +41,7 @@ function checkMetadataFile<MetadataItem, MigrationMetadataItem, MetadataFile>(
         continue;
       }
 
-      if (migrationMetadataValue.after) {
+      if (checkAfterItems && migrationMetadataValue.after) {
         const isNewValueInNewMetadata = newMetadataArray.some((newValue) => comparator.isMigrationDataMatch(newValue, migrationMetadataValue.after!, migrationMetadataValue.contentType));
         if (!isNewValueInNewMetadata) {
           errors.push(new Error(`Property ${comparator.getIdentifier(lastValue)} has been modified but the new property is not present in the new metadata`));
@@ -161,7 +162,7 @@ Detection of package manager runner will fallback on the one used to execute the
   const newFile = getLocalMetadataFile<MetadataFile>(metadataPathInWorkspace);
 
 
-  const errors = checkMetadataFile<MetadataItem, MigrationMetadataItem, MetadataFile>(metadata, newFile, migrationData.changes, options.allowBreakingChanges, comparator);
+  const errors = checkMetadataFile<MetadataItem, MigrationMetadataItem, MetadataFile>(metadata, newFile, migrationData.changes, options.allowBreakingChanges, options.checkAfterItems, comparator);
 
   if (errors.length) {
     return {

diff --git a/packages/@o3r/localization/builders/metadata-check/schema.json b/packages/@o3r/localization/builders/metadata-check/schema.json
@@ -34,6 +34,16 @@
       "type": "string",
       "description": "Path of the localization metadata file.",
       "default": "./localisation.metadata.json"
+    },
+    "packageJsonEntry": {
+      "type": "string",
+      "description": "Entry to check for previous metadata in the `package.json` file under `cmsMetadata`.",
+      "default": "localizationFilePath"
+    },
+    "checkAfterItems": {
+      "type": "boolean",
+      "description": "Whether after items should be checked.",
+      "default": true
     }
   },
   "additionalProperties": false,

diff --git a/packages/@o3r/styling/builders/metadata-check/schema.json b/packages/@o3r/styling/builders/metadata-check/schema.json
@@ -34,6 +34,16 @@
       "type": "string",
       "description": "Path of the styling metadata file.",
       "default": "./style.metadata.json"
+    },
+    "packageJsonEntry": {
+      "type": "string",
+      "description": "Entry to check for previous metadata in the `package.json` file under `cmsMetadata`.",
+      "default": "styleFilePath"
+    },
+    "checkAfterItems": {
+      "type": "boolean",
+      "description": "Whether after items should be checked.",
+      "default": true
     }
   },
   "additionalProperties": false,