docs: additional docs

Author: 01Joseph-Hwang10

docs/cli/build.md

@@ -0,0 +1,17 @@
+# `jtd-codebuild <path>`
+
+This command generates code from JSON Type Definition IDL files.
+
+## Usage
+
+```bash
+jtd-codebuild <path>
+```
+
+### Arguments
+
+- `<path>`: The path that contains `jtd-codebuild.json` file. If this is not provided, the current directory is used. See [Quick Example][quick-example] or [Configuration] for how to write `jtd-codebuild.json`.
+
+[quick-example]: ../../README.md#quick-example
+[Configuration]: ../codegen/config/index.md
+

docs/cli/init.md

@@ -0,0 +1,28 @@
+# `jtd-codebuild <path> init [--preset <preset>]`
+
+This command initializes a `jtd-codebuild.json` file in the given path.
+
+## Usage
+
+```bash
+jtd-codebuild <path> init [--preset <preset>]
+```
+
+### Arguments
+
+- `<path>`: The path to initialize the `jtd-codebuild.json` file. If this is not provided, the current directory is used.
+
+### Options
+
+- `--preset <preset>`: The preset to use for the initialization. If this is not provided, the `config` preset is used by default. See [Presets](#presets) for available presets.
+
+
+## Presets
+
+Presets are predefined configurations that can be used to quickly initialize a `jtd-codebuild.json` configuration file and related files.
+
+Currently, 3 presets are available:
+
+- `config`: Initializes a configuration file with default values. If `--preset` is not provided, this preset is used by default.
+- `project`: Initializes a configuration file with a project structure.
+- `workspace`: Initializes a workspace configuration file.

docs/codegen/config/index.md renamed to docs/codegen/config/project.md

@@ -1,4 +1,4 @@
-# Configuration
+# Project Configuration
 
 `jtd-codebuild <path>` CLI finds the configuration file in the given path and generates the code based on the configuration.
 
@@ -84,3 +84,10 @@ Check each language's configuration for more details.
 - [Ruby](./ruby.md)
 - [Rust](./rust.md)
 - [Typescript](./typescript.md)
+
+## Substitutes
+
+`jtd-codebuild.json` supports the following substitutes.
+
+- `<projectRoot>`: The root directory of the project. It is same as the directory that `jtd-codebuild.json` is in.
+- `<workspaceRoot>`: The root directory of the workspace. `jtd-codebuild` searches for the closest parent which contains `jtd-codebuild-workspace.json` file, and uses that directory as the workspace root. If `jtd-codebuild` fails to find the workspace root, it uses the project root as the workspace root.

docs/codegen/config/workspace.md

@@ -0,0 +1,10 @@
+# Workspace Configuration
+
+`jtd-codebuild` supports multiple projects in a workspace. You can define a workspace configuration file `jtd-codebuild-workspace.json` to manage multiple projects in a workspace.
+
+> [!NOTE]
+> The file name should be `jtd-codebuild-workspace.json`. No other file name is allowed.
+
+## Configuration Options
+
+Currently, no configuration options are available for workspace configuration, and the only purpose of the `jtd-codebuild-workspace.json` file is to find where the workspace root is.

docs/codegen/idl/inheritance.md

@@ -1,6 +1,6 @@
 # Inheritance
 
-By default, [jtd-codegen] does not support inheritance.
+By default, [JSON Type Definition][jsontypedef.com] does not support inheritance.
 
 But by using `jtd-codebuild`, you can define inheritance between type definitions.
 You can do this by using `extends` keyword like below.
@@ -45,10 +45,11 @@ Chef:
   extends: [Person, MyRestaurantMixin]
 ```
 
-These `extends` properties will be processed by `jtd-codebuild`, and every properties will be merged into one schema.
+If a class or classes are given in the `extends` keyword, the properties of the parent classes are merged into the child class.
 
-> [IMPORTANT]
+> [!IMPORTANT]
 > Note that this feature does not programatically inherit the classes in the generated code.
 > It only merges the properties of the parent schemas into the child schema.
 
+[jsontypedef.com]: https://jsontypedef.com/docs/
 [jtd-codegen]: https://jsontypedef.com/docs/jtd-codegen/

docs/index.md

@@ -6,7 +6,8 @@
   - IDL
     - [JSON Type Definition](./codegen/idl/json-typedef.md)
     - [Inheritance](./codegen/idl/inheritance.md)
-  - [Configuration](./codegen/config/index.md)
+  - [Workspace Configuration](./codegen/config/workspace.md)
+  - [Project Configuration](codegen/config/project.md)
     - [C#](./codegen/config/csharp.md)
     - [Go](./codegen/config/go.md)
     - [Java](./codegen/config/java.md)

jtd_codebuild/cli.py

@@ -19,7 +19,7 @@ def cli(ctx: Context, path: str):
 @click.option(
     "--preset",
     "-p",
-    type=click.Choice(["config", "module", "workspace"]),
+    type=click.Choice(["config", "project", "workspace"]),
     default="config",
 )
 def init(ctx: Context, preset: str):

jtd_codebuild/commands/_init.py

@@ -2,7 +2,7 @@
 from jtd_codebuild.utils.fs import resolve
 from jtd_codebuild.preset.config import ConfigPreset
 from jtd_codebuild.preset.workspace import WorkspacePreset
-from jtd_codebuild.preset.module import ModulePreset
+from jtd_codebuild.preset.project import ProjectPreset
 from ._command import Command
 
 
@@ -21,7 +21,7 @@ def run(
             ConfigPreset(logger=self.logger).generate(path)
         elif preset == "workspace":
             WorkspacePreset(logger=self.logger).generate(path)
-        elif preset == "module":
-            ModulePreset(logger=self.logger).generate(path)
+        elif preset == "project":
+            ProjectPreset(logger=self.logger).generate(path)
         else:
             raise ValueError(f"Unknown preset {preset}")

jtd_codebuild/preset/module/__init__.py

@@ -0,0 +1,3 @@
+# flake8: noqa: F401
+
+from ._preset import ProjectPreset