diff --git a/src/codegen/cli/README.md b/src/codegen/cli/README.md new file mode 100644 index 000000000..287d79787 --- /dev/null +++ b/src/codegen/cli/README.md @@ -0,0 +1,13 @@ +# Codegen CLI +A codegen module that handles all `codegen` CLI commands. + +### Dependencies +- [codegen.sdk](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/sdk) +- [codegen.shared](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/shared) + +## Best Practices + +- Each folder in `cli` should correspond to a command group. The name of the folder should be the name of the command group. Ex: `task` for codegen task commands. +- The command group folder should have a file called `commands.py` where the CLI group (i.e. function decorated with `@click.group()`) and CLI commands are defined (i.e. functions decorated with ex: `@task.command()`) and if necessary a folder called `utils` (or a single `utils.py`) that holds any additional files with helpers/utilities that are specific to the command group. +- Store utils specific to a CLI command group within its folder. +- Store utils that can be shared across command groups in an appropriate file in cli/utils. If none exists, create a new appropriately named one! diff --git a/src/codegen/git/README.md b/src/codegen/git/README.md new file mode 100644 index 000000000..5dab61a69 --- /dev/null +++ b/src/codegen/git/README.md @@ -0,0 +1,6 @@ +# Codegen Git +A codegen module to supports git operations on codebase. + +### Dependencies +- [codegen.sdk](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/sdk) +- [codegen.shared](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/shared) diff --git a/src/codegen/gsbuild/README.md b/src/codegen/gsbuild/README.md new file mode 100644 index 000000000..72ba434fc --- /dev/null +++ b/src/codegen/gsbuild/README.md @@ -0,0 +1,2 @@ +# Codegen GS Build +A codegen module that builds the codegen SDK. diff --git a/src/codegen/gscli/README.md b/src/codegen/gscli/README.md index 6054dca33..ad8774b53 100644 --- a/src/codegen/gscli/README.md +++ b/src/codegen/gscli/README.md @@ -1,6 +1,2 @@ -# Best Practices - -- Each folder in `cli` should correspond to a command group. The name of the folder should be the name of the command group. Ex: `task` for codegen task commands. -- The command group folder should have a file called `commands.py` where the CLI group (i.e. function decorated with `@click.group()`) and CLI commands are defined (i.e. functions decorated with ex: `@task.command()`) and if necessary a folder called `utils` (or a single `utils.py`) that holds any additional files with helpers/utilities that are specific to the command group. -- Store utils specific to a CLI command group within its folder. -- Store utils that can be shared across command groups in an appropriate file in cli/utils. If none exists, create a new appropriately named one! +# Codegen GS CLI +This module to be moved out into `src/code_generation` diff --git a/src/codegen/gscli/utils/__init__.py b/src/codegen/gscli/utils/__init__.py deleted file mode 100644 index e69de29bb..000000000 diff --git a/src/codegen/runner/README.md b/src/codegen/runner/README.md new file mode 100644 index 000000000..3803c4e1c --- /dev/null +++ b/src/codegen/runner/README.md @@ -0,0 +1,7 @@ +# Codegen Runner +A codegen module to run codemods against a Codebase graph with a managed lifecycle. + +### Dependencies +- [codegen.sdk](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/sdk) +- [codegen.git](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/git) +- [codegen.shared](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/shared) diff --git a/src/codegen/sdk/README.md b/src/codegen/sdk/README.md new file mode 100644 index 000000000..83611b169 --- /dev/null +++ b/src/codegen/sdk/README.md @@ -0,0 +1,6 @@ +# Codegen SDK +A codegen module that contains the core Codebase graph parsing and manipulation logic. + +### Dependencies +- [codegen.git](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/git) +- [codegen.shared](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/shared) diff --git a/src/codegen/shared/README.md b/src/codegen/shared/README.md new file mode 100644 index 000000000..080bd8251 --- /dev/null +++ b/src/codegen/shared/README.md @@ -0,0 +1,6 @@ +# Codegen Shared +A codegen module to contain a miscellaneous set of shared utilities. + +### Dependencies +This module should NOT contain any high level dependencies on other codegen modules. +It should only depend on standard libraries and other shared utilities.