fix: project config type validation

Author: 01Joseph-Hwang10

docs/codegen/config/project.md

@@ -11,7 +11,8 @@ The path should be a folder that contains the configuration file, named `jtd-cod
 
 ### `include`
 
-> - Required
+> - Optional
+> - Default: `[]`
 
 The `include` field is an array of directories 
 that contain the JSON Type Definition IDL files.

jtd_codebuild/bundler.py

@@ -37,7 +37,7 @@ def bundle(
 
         # Bundle reference schemas
         schemas: list[dict] = pipe(
-            config.references or [],
+            config.references,
             map(resolve),
             map(self.bundle),
         )

jtd_codebuild/config/project/config.json

@@ -431,11 +431,6 @@
       "type": "string"
     }
   },
-  "required": [
-    "include",
-    "references",
-    "targets"
-  ],
   "title": "ProjectConfig",
   "type": "object"
 }

jtd_codebuild/config/project/model/_config.py

@@ -1,4 +1,4 @@
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 from ._types import DuplicatePolicy, TargetProcessingStrategy
 from ._target import (
     PythonTarget,
@@ -13,8 +13,8 @@
 
 
 class ProjectConfig(BaseModel, Subscriptable):
-    include: list[str]
-    references: list[str] | None = None
+    include: list[str] = Field(default_factory=lambda: [])
+    references: list[str] = Field(default_factory=lambda: [])
     targets: list[
         PythonTarget
         | TypescriptTarget
@@ -23,7 +23,7 @@ class ProjectConfig(BaseModel, Subscriptable):
         | CSharpTarget
         | RustTarget
         | RubyTarget
-    ]
+    ] = Field(default_factory=lambda: [])
     targetProcessingStrategy: TargetProcessingStrategy = "parallel"
     jtdBundlePath: str = "gen/schema.jtd.json"
     duplicate: DuplicatePolicy = "error"

jtd_codebuild/config/project/scripts/__init__.py

@@ -0,0 +1,9 @@
+from os.path import join, dirname
+from jtd_codebuild.config.project.model import ProjectConfig
+from jtd_codebuild.utils.io import write_json
+
+if __name__ == "__main__":
+    write_json(
+        join(dirname(__file__), "..", "config.json"),
+        ProjectConfig.model_json_schema(),
+    )

jtd_codebuild/config/project/scripts/generate_project_config_json_schema.py

@@ -1,9 +1,10 @@
 import abc
 import subprocess
+from os import makedirs
 from jtd_codebuild.component import Component
 from jtd_codebuild.logger import Logger
 from jtd_codebuild.config.project.model import Target
-from jtd_codebuild.utils.fs import safe_mkdir, resolve
+from jtd_codebuild.utils.fs import resolve
 from jtd_codebuild.utils.subprocess import stream_logs
 
 
@@ -54,7 +55,7 @@ def generate(self, target: Target) -> None:
         Returns:
             A list of subprocesses created by the code generation.
         """
-        safe_mkdir(self.get_target_path(target))
+        makedirs(self.get_target_path(target), exist_ok=True)
         process = subprocess.Popen(
             self._codegen_command(target),
             shell=True,

jtd_codebuild/generators/_generator.py

@@ -27,15 +27,6 @@ def file_is_json(file: str) -> bool:
     return file.endswith(".json")
 
 
-def safe_mkdir(path: str) -> None:
-    """Create a directory with creating its parent directories if they do not exist.
-
-    Args:
-        path: The directory path.
-    """
-    makedirs(path, exist_ok=True)
-
-
 def safe_open(file_path: str, mode: str) -> TextIOWrapper:
     """Open a file with creating its parent directories if they do not exist.
 
@@ -46,7 +37,7 @@ def safe_open(file_path: str, mode: str) -> TextIOWrapper:
     Returns:
         The opened file.
     """
-    safe_mkdir(dirname(file_path))
+    makedirs(dirname(file_path), exist_ok=True)
     return open(file_path, mode)
 
 

jtd_codebuild/utils/fs.py

@@ -1,7 +1,7 @@
 import json
 from typing import Any
+from os import makedirs
 from os.path import dirname
-from .fs import safe_mkdir
 
 
 def read(file: str) -> str:
@@ -13,7 +13,7 @@ def read(file: str) -> str:
     Returns:
         The file content.
     """
-    safe_mkdir(dirname(file))
+    makedirs(dirname(file), exist_ok=True)
     with open(file, "r") as f:
         return f.read()
 
@@ -25,7 +25,7 @@ def write(file: str, data: str) -> None:
         file: The file name.
         data: The file content.
     """
-    safe_mkdir(dirname(file))
+    makedirs(dirname(file), exist_ok=True)
     with open(file, "w") as f:
         f.write(data)
 

jtd_codebuild/utils/io.py

@@ -54,6 +54,7 @@ jtd-codebuild = "jtd_codebuild.__main__:cli"
 test = "python -m pytest"
 lint = "flake8 jtd_codebuild"
 check-format = "black jtd_codebuild --check"
+generate-project-config-json-schema = "python -m jtd_codebuild.config.project.scripts.generate_project_config_json_schema"
 
 [tool.black]
 line-length = 88