Skip to content

Commit 85c254c

Browse files
authored
Add README.md for all top level codegen modules (#86)
# Motivation <!-- Why is this change necessary? --> # Content <!-- Please include a summary of the change --> # Testing <!-- How was the change tested? --> # Please check the following before marking your PR as ready for review - [x] I have added tests for my changes - [x] I have updated the documentation or added new documentation as needed - [x] I have read and agree to the [Contributor License Agreement](../CLA.md)
1 parent 4899a30 commit 85c254c

File tree

8 files changed

+42
-6
lines changed

8 files changed

+42
-6
lines changed

src/codegen/cli/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Codegen CLI
2+
A codegen module that handles all `codegen` CLI commands.
3+
4+
### Dependencies
5+
- [codegen.sdk](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/sdk)
6+
- [codegen.shared](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/shared)
7+
8+
## Best Practices
9+
10+
- 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.
11+
- 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.
12+
- Store utils specific to a CLI command group within its folder.
13+
- 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!

src/codegen/git/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Codegen Git
2+
A codegen module to supports git operations on codebase.
3+
4+
### Dependencies
5+
- [codegen.sdk](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/sdk)
6+
- [codegen.shared](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/shared)

src/codegen/gsbuild/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Codegen GS Build
2+
A codegen module that builds the codegen SDK.

src/codegen/gscli/README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,2 @@
1-
# Best Practices
2-
3-
- 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.
4-
- 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.
5-
- Store utils specific to a CLI command group within its folder.
6-
- 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!
1+
# Codegen GS CLI
2+
This module to be moved out into `src/code_generation`

src/codegen/gscli/utils/__init__.py

Whitespace-only changes.

src/codegen/runner/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Codegen Runner
2+
A codegen module to run codemods against a Codebase graph with a managed lifecycle.
3+
4+
### Dependencies
5+
- [codegen.sdk](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/sdk)
6+
- [codegen.git](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/git)
7+
- [codegen.shared](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/shared)

src/codegen/sdk/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Codegen SDK
2+
A codegen module that contains the core Codebase graph parsing and manipulation logic.
3+
4+
### Dependencies
5+
- [codegen.git](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/git)
6+
- [codegen.shared](https://github.com/codegen-sh/codegen-sdk/tree/develop/src/codegen/shared)

src/codegen/shared/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Codegen Shared
2+
A codegen module to contain a miscellaneous set of shared utilities.
3+
4+
### Dependencies
5+
This module should NOT contain any high level dependencies on other codegen modules.
6+
It should only depend on standard libraries and other shared utilities.

0 commit comments

Comments
 (0)