Add supported_languages field to hacs.json schema and validation

- Add supported_languages field to HacsManifest class
- Add _supported_languages_validator to validate ISO 639-1 language codes
- Add supported_languages to HACS_MANIFEST_JSON_SCHEMA
- Add validation in hacsjson.py to check if declared README files exist
- Add runtime check in async_get_info_file_contents_with_language to only use declared languages
- Fixes review comments from ludeeus

Author: rosch100

custom_components/hacs/repositories/base.py

@@ -228,6 +228,7 @@ class HacsManifest:
     name: str = None
     persistent_directory: str = None
     render_readme: bool = False
+    supported_languages: list[str] = []  # Supported README languages (e.g., ["de", "fr", "es"])
     zip_release: bool = False
 
     def to_dict(self):
@@ -250,6 +251,8 @@ def from_dict(manifest: dict):
         for key, value in manifest_data.manifest.items():
             if key == "country" and isinstance(value, str):
                 setattr(manifest_data, key, [value])
+            elif key == "supported_languages" and isinstance(value, str):
+                setattr(manifest_data, key, [value])
             elif key in manifest_data.__dict__:
                 setattr(manifest_data, key, value)
         return manifest_data
@@ -265,6 +268,11 @@ def update_data(self, data: dict) -> None:
                     setattr(self, key, [value])
                 else:
                     setattr(self, key, value)
+            elif key == "supported_languages":
+                if isinstance(value, str):
+                    setattr(self, key, [value])
+                else:
+                    setattr(self, key, value)
             else:
                 setattr(self, key, value)
 
@@ -771,6 +779,19 @@ async def async_get_info_file_contents_with_language(
                 language = None
             else:
                 language = language.lower()
+                
+                # Check if language is declared in supported_languages
+                if (
+                    self.repository_manifest.supported_languages
+                    and language not in self.repository_manifest.supported_languages
+                ):
+                    self.logger.debug(
+                        "%s Language '%s' not in supported_languages %s, using README.md",
+                        self.string,
+                        language,
+                        self.repository_manifest.supported_languages,
+                    )
+                    language = None
 
         # If no language or English, use standard README
         if not language or language == "en":

custom_components/hacs/validate/hacsjson.py

@@ -1,44 +1,71 @@
-from __future__ import annotations
-
-from voluptuous.error import Invalid
-from voluptuous.humanize import humanize_error
-
-from ..enums import HacsCategory, RepositoryFile
-from ..repositories.base import HacsManifest, HacsRepository
-from ..utils.validate import HACS_MANIFEST_JSON_SCHEMA
-from .base import ActionValidationBase, ValidationException
-
-
-async def async_setup_validator(repository: HacsRepository) -> Validator:
-    """Set up this validator."""
-    return Validator(repository=repository)
-
-
-class Validator(ActionValidationBase):
-    """Validate the repository."""
-
-    more_info = "https://hacs.xyz/docs/publish/include#check-hacs-manifest"
-
-    async def async_validate(self) -> None:
-        """Validate the repository."""
-        if RepositoryFile.HACS_JSON not in [x.filename for x in self.repository.tree]:
-            raise ValidationException(f"The repository has no '{RepositoryFile.HACS_JSON}' file")
-
-        rawhacsjson = await self.repository.get_hacs_json_raw(version=self.repository.ref)
-        if rawhacsjson is None:
-            raise ValidationException(
-                f"The repository has an invalid '{RepositoryFile.HACS_JSON}' file"
-            )
-
-        try:
-            hacsjson = HacsManifest.from_dict(HACS_MANIFEST_JSON_SCHEMA(rawhacsjson))
-        except Invalid as exception:
-            self.repository.logger.warning(
-                "HACS JSON validation failed for: %s",
-                rawhacsjson,
-            )
-            raise ValidationException(humanize_error(rawhacsjson, exception)) from exception
-
-        if self.repository.data.category == HacsCategory.INTEGRATION:
-            if hacsjson.zip_release and not hacsjson.filename:
-                raise ValidationException("zip_release is True, but filename is not set")
+from __future__ import annotations
+
+from voluptuous.error import Invalid
+from voluptuous.humanize import humanize_error
+
+from ..enums import HacsCategory, RepositoryFile
+from ..repositories.base import HacsManifest, HacsRepository
+from ..utils.validate import HACS_MANIFEST_JSON_SCHEMA
+from .base import ActionValidationBase, ValidationException
+
+
+async def async_setup_validator(repository: HacsRepository) -> Validator:
+    """Set up this validator."""
+    return Validator(repository=repository)
+
+
+class Validator(ActionValidationBase):
+    """Validate the repository."""
+
+    more_info = "https://hacs.xyz/docs/publish/include#check-hacs-manifest"
+
+    async def async_validate(self) -> None:
+        """Validate the repository."""
+        if RepositoryFile.HACS_JSON not in [x.filename for x in self.repository.tree]:
+            raise ValidationException(f"The repository has no '{RepositoryFile.HACS_JSON}' file")
+
+        rawhacsjson = await self.repository.get_hacs_json_raw(version=self.repository.ref)
+        if rawhacsjson is None:
+            raise ValidationException(
+                f"The repository has an invalid '{RepositoryFile.HACS_JSON}' file"
+            )
+
+        try:
+            hacsjson = HacsManifest.from_dict(HACS_MANIFEST_JSON_SCHEMA(rawhacsjson))
+        except Invalid as exception:
+            self.repository.logger.warning(
+                "HACS JSON validation failed for: %s",
+                rawhacsjson,
+            )
+            raise ValidationException(humanize_error(rawhacsjson, exception)) from exception
+
+        if self.repository.data.category == HacsCategory.INTEGRATION:
+            if hacsjson.zip_release and not hacsjson.filename:
+                raise ValidationException("zip_release is True, but filename is not set")
+
+        # Validate supported_languages if provided
+        if hacsjson.supported_languages:
+            # Check if README files for declared languages exist
+            tree_files = [x.filename for x in self.repository.tree]
+            missing_readmes = []
+            for lang in hacsjson.supported_languages:
+                readme_path = f"README.{lang}.md"
+                # Check various case combinations
+                found = False
+                for possible_path in [
+                    readme_path,
+                    f"README.{lang.upper()}.md",
+                    f"readme.{lang}.md",
+                    f"readme.{lang.upper()}.md",
+                ]:
+                    if possible_path in tree_files:
+                        found = True
+                        break
+                if not found:
+                    missing_readmes.append(lang)
+
+            if missing_readmes:
+                raise ValidationException(
+                    f"supported_languages declares languages {missing_readmes}, "
+                    f"but corresponding README files (README.{{lang}}.md) were not found in the repository."
+                )