add pass validation to model and cli

Author: mustafasoylu

src/somesy/cli/sync.py

@@ -152,6 +152,12 @@ def sync(
         "--merge/--overwrite",
         help="Merge codemeta.json with with an existing codemeta.json file (default: False)",
     ),
+    pass_validation: bool = typer.Option(
+        False,
+        "--pass-validation",
+        "-P",
+        help="Pass validation of metadata files (default: False)",
+    ),
 ):
     """Sync project metadata input with metadata files."""
     somesy_input = resolved_somesy_input(
@@ -175,6 +181,7 @@ def sync(
         no_sync_rust=no_sync_rust,
         rust_file=rust_file,
         merge_codemeta=merge_codemeta,
+        pass_validation=pass_validation,
     )
     run_sync(somesy_input)
 
@@ -218,6 +225,8 @@ def run_sync(somesy_input: SomesyInput):
             f"  - [italic]codemeta.json[/italic]:\t[grey]{conf.codemeta_file}[/grey]\n"
         )
     # ----
+    if conf.pass_validation:
+        logger.info("[bold yellow]Passing validation of metadata files.[/bold yellow]")
     sync_command(somesy_input)
     # ----
     logger.info("[bold green]Metadata synchronization completed.[/bold green]")

src/somesy/commands/sync.py

@@ -26,13 +26,14 @@ def _sync_file(
     file: Path,
     writer_cls: Type[ProjectMetadataWriter],
     merge_codemeta: Optional[bool] = False,
+    pass_validation: Optional[bool] = False,
 ):
     """Sync metadata to a file using the provided writer."""
     logger.verbose(f"Loading '{file.name}' ...")
     if writer_cls == CodeMeta:
-        writer = writer_cls(file, merge=merge_codemeta)
+        writer = writer_cls(file, merge=merge_codemeta, pass_validation=pass_validation)
     else:
-        writer = writer_cls(file)
+        writer = writer_cls(file, pass_validation=pass_validation)
     logger.verbose(f"Syncing '{file.name}' ...")
     writer.sync(metadata)
     writer.save(file)
@@ -49,34 +50,75 @@ def sync(somesy_input: SomesyInput):
     # update these only if they exist:
 
     if conf.pyproject_file.is_file() and not conf.no_sync_pyproject:
-        _sync_file(metadata, conf.pyproject_file, Pyproject)
+        _sync_file(
+            metadata,
+            conf.pyproject_file,
+            Pyproject,
+            pass_validation=conf.pass_validation,
+        )
 
     if conf.package_json_file.is_file() and not conf.no_sync_package_json:
-        _sync_file(metadata, conf.package_json_file, PackageJSON)
+        _sync_file(
+            metadata,
+            conf.package_json_file,
+            PackageJSON,
+            pass_validation=conf.pass_validation,
+        )
 
     if conf.julia_file.is_file() and not conf.no_sync_julia:
-        _sync_file(metadata, conf.julia_file, Julia)
+        _sync_file(
+            metadata,
+            conf.julia_file,
+            Julia,
+            pass_validation=conf.pass_validation,
+        )
 
     if conf.fortran_file.is_file() and not conf.no_sync_fortran:
-        _sync_file(metadata, conf.fortran_file, Fortran)
+        _sync_file(
+            metadata,
+            conf.fortran_file,
+            Fortran,
+            pass_validation=conf.pass_validation,
+        )
 
     if conf.pom_xml_file.is_file() and not conf.no_sync_pom_xml:
-        _sync_file(metadata, conf.pom_xml_file, POM)
+        _sync_file(
+            metadata,
+            conf.pom_xml_file,
+            POM,
+            pass_validation=conf.pass_validation,
+        )
 
     if conf.mkdocs_file.is_file() and not conf.no_sync_mkdocs:
-        _sync_file(metadata, conf.mkdocs_file, MkDocs)
+        _sync_file(
+            metadata,
+            conf.mkdocs_file,
+            MkDocs,
+            pass_validation=conf.pass_validation,
+        )
 
     if conf.rust_file.is_file() and not conf.no_sync_rust:
-        _sync_file(metadata, conf.rust_file, Rust)
+        _sync_file(
+            metadata,
+            conf.rust_file,
+            Rust,
+            pass_validation=conf.pass_validation,
+        )
 
     # create these by default if they are missing:
     if not conf.no_sync_cff:
-        _sync_file(metadata, conf.cff_file, CFF)
+        _sync_file(
+            metadata,
+            conf.cff_file,
+            CFF,
+            pass_validation=conf.pass_validation,
+        )
 
     if not conf.no_sync_codemeta:
         _sync_file(
             metadata,
             conf.codemeta_file,
             CodeMeta,
             merge_codemeta=conf.merge_codemeta,
+            pass_validation=conf.pass_validation,
         )

src/somesy/core/models.py

@@ -243,6 +243,12 @@ def at_least_one_target(cls, values):
         ),
     ] = False
 
+    # property to pass validation for all inputs/outputs
+    pass_validation: Annotated[
+        Optional[bool],
+        Field(description="Pass validation for all output files."),
+    ] = False
+
     def log_level(self) -> SomesyLogLevel:
         """Return log level derived from this configuration."""
         return SomesyLogLevel.from_flags(

src/somesy/core/writer.py

@@ -37,6 +37,7 @@ def __init__(
         create_if_not_exists: Optional[bool] = False,
         direct_mappings: FieldKeyMapping = None,
         merge: Optional[bool] = False,
+        pass_validation: Optional[bool] = False,
     ) -> None:
         """Initialize the Project Metadata Output Wrapper.
 
@@ -50,16 +51,19 @@ def __init__(
             create_if_not_exists: Create an empty CFF file if not exists. Defaults to True.
             direct_mappings: Dict with direct mappings of keys between somesy and target
             merge: Merge the output file with an existing file. Defaults to False.
+            pass_validation: Pass validation for all output files. Defaults to False.
 
         """
         self._data: DictLike = {}
         self.path = path if isinstance(path, Path) else Path(path)
         self.create_if_not_exists = create_if_not_exists
         self.direct_mappings = direct_mappings or {}
         self.merge = merge
+        self.pass_validation = pass_validation
         if self.path.is_file():
             self._load()
-            self._validate()
+            if not self.pass_validation:
+                self._validate()
         else:
             if self.create_if_not_exists:
                 self._init_new_file()
@@ -86,7 +90,7 @@ def _load(self):
         """
 
     @abstractmethod
-    def _validate(self):
+    def _validate(self) -> None:
         """Validate the target file data.
 
         Implement this method so that it checks