feat(compiler): new README of generated #803

samchon · 2025-11-18T06:24:32Z

This pull request introduces several improvements and refactoring to the backend agent codebase, focusing on template generation, phase handling, and benchmarking. The main changes include a refactor of the file generation pipeline to use a unified options object, enhanced README generation with dynamic benchmarking and status emojis, and consolidation of template access methods. These updates improve code clarity, flexibility, and provide better visibility into the agent's workflow and performance.

Template Generation and Phase Handling

Refactored getAutoBeGenerated to accept a single props object instead of multiple parameters, and to use a unified phase option for determining which files to generate. This simplifies usage and makes phase selection explicit. [1] [2]
Consolidated template access methods: now all compiler templates (common, interface, realize, test) are accessed via a single getTemplate method, reducing duplicated logic and improving maintainability. [1] [2] [3]

README and Benchmark Enhancements

Updated README template generation to inject dynamic status emojis for each phase (analyze, prisma, interface, test, realize), and to include aggregate and function-calling benchmarks. This provides instant visual feedback and performance metrics in generated documentation. [1] [2] [3] [4]
Added helper functions for benchmarking and status emoji calculation, making README generation more informative and automated.

Interface and Test File Generation

Updated interface compiler's write method to accept an exclusion list, allowing selective file generation and simplifying downstream usage in orchestrators and DTO generation. [1] [2] [3]

Build and Template Management

Added new build step to generate the common template in the compiler, ensuring all template variants are available and up-to-date. [1] [2]

These changes collectively improve the flexibility, maintainability, and visibility of the backend agent's code and outputs.

Copilot

Pull Request Overview

This pull request refactors the backend agent's file generation pipeline to use a unified approach for template management and options handling. The main purpose is to consolidate template access through a single getTemplate method on the compiler interface, enhance README generation with dynamic status emojis and benchmarking metrics, and improve code maintainability.

Key changes:

Renamed stage to phase in IAutoBeGetFilesOptions and refactored getAutoBeGenerated to accept a props object instead of individual parameters
Consolidated template access by moving getTemplate methods from individual compilers (interface, test, realize) to a unified method on IAutoBeCompiler
Enhanced README template with dynamic placeholder replacement for phase status emojis and benchmark metrics (aggregate and function-calling statistics)

Reviewed Changes

Copilot reviewed 24 out of 28 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
`packages/interface/src/facade/IAutoBeGetFilesOptions.ts`	Renamed `stage` property to `phase` for clarity
`packages/interface/src/compiler/IAutoBeCompiler.ts`	Added unified `getTemplate` method accepting `Required<IAutoBeGetFilesOptions>`
`packages/interface/src/compiler/IAutoBeInterfaceCompiler.ts`	Updated `write` method to accept `exclude` parameter; removed individual `getTemplate` method
`packages/interface/src/compiler/IAutoBeTestCompiler.ts`	Removed `getTemplate` method (moved to parent interface)
`packages/interface/src/compiler/IAutoBeRealizeCompiler.ts`	Removed `getTemplate` method (moved to parent interface)
`packages/compiler/src/AutoBeCompiler.ts`	Implemented unified `getTemplate` method with phase-based template composition
`packages/compiler/src/interface/AutoBeInterfaceCompiler.ts`	Implemented `exclude` filtering; removed template spreading from `write` method
`packages/compiler/src/test/AutoBeTestCompiler.ts`	Removed `getTemplate` method implementation
`packages/compiler/src/realize/AutoBeRealizeCompiler.ts`	Removed `getTemplate` method implementation
`packages/compiler/build/template.ts`	Added build step for common template generation
`packages/agent/src/factory/getAutoBeGenerated.ts`	Refactored to use props object; added README placeholder replacement and benchmark helper functions
`packages/agent/src/factory/getAutoBeRealizeGenerated.ts`	Removed template spreading (now handled by caller)
`packages/agent/src/factory/getCriticalCompiler.ts`	Updated to use new unified `getTemplate` method and updated `write` signature
`packages/agent/src/AutoBeAgentBase.ts`	Updated `getFiles` call to use props object pattern
`packages/agent/src/orchestrate/test/compile/getTestScenarioArtifacts.ts`	Updated `interface.write` call to include empty exclude array
`packages/agent/src/orchestrate/realize/utils/getRealizeWriteDto.ts`	Updated `interface.write` call to include empty exclude array
`packages/agent/src/orchestrate/realize/orchestrateRealizeAuthorizationWrite.ts`	Updated to use unified `getTemplate` method
`packages/agent/src/orchestrate/realize/internal/compileRealizeFiles.ts`	Updated to use unified `getTemplate` method
`test/src/features/compiler/test_compiler_interface_write.ts`	Updated `interface.write` call to include empty exclude array
`test/src/features/compiler/test_compiler_interface_name.ts`	Updated `interface.write` call to include empty exclude array
`test/src/features/realize/internal/validate_agent_realize_correct.ts`	Updated to use unified `getTemplate` method with phase parameter
`test/src/features/realize/internal/validate_agent_realize_authorization_correct.ts`	Updated to use unified `getTemplate` method with phase parameter; added explicit type annotation
`test/src/features/realize/internal/validate_agent_realize_authorization.ts`	Updated to use unified `getTemplate` method with phase parameter; added explicit type annotation
`internals/template/common/README.md`	Enhanced with dynamic placeholder replacement for phase emojis and benchmark tables
`internals/template/common/LICENSE`	Added MIT license file for generated projects
`internals/template/common/.gitignore`	Added gitignore configuration for generated projects
`internals/template/common/.eslintrc.cjs`	Added ESLint configuration for generated projects
`internals/template/common/typos.toml`	Added typos spell checker configuration for generated projects

Comments suppressed due to low confidence (1)

internals/template/common/README.md:120

There's a spelling error in the column header. "Succcess" should be "Success" (three 'c's instead of two).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-18T06:29:37Z

packages/agent/src/factory/getAutoBeGenerated.ts

+        authorizations: props.state.realize.authorizations,
+        functions: props.state.realize.functions,
        options: {
          dbms: options?.dbms ?? "postgres",


Inconsistent variable reference. This uses options?.dbms ?? "postgres" which refers to props.options, but the local options variable (line 25) is of type Required<IAutoBeGetFilesOptions> with a guaranteed dbms property. Change this to options.dbms to use the local variable consistently.

Suggested change

dbms: options?.dbms ?? "postgres",

dbms: options.dbms,

Copilot · 2025-11-18T06:29:37Z

packages/agent/src/factory/getAutoBeGenerated.ts

    ),
  );
-  if (options?.stage === "analyze") return ret;
+  if (props.options?.phase === "analyze") return ret;


Inconsistent variable reference. This uses props.options?.phase but the local options variable (line 25) is of type Required<IAutoBeGetFilesOptions> with a guaranteed phase property. Change this to options.phase to use the local variable consistently.

Suggested change

if (props.options?.phase === "analyze") return ret;

if (options.phase === "analyze") return ret;

Copilot · 2025-11-18T06:29:38Z

packages/agent/src/factory/getAutoBeGenerated.ts

+        props.state.prisma.compiled.reason;
  }
-  if (options?.stage === "prisma") return ret;
+  if (props.options?.phase === "prisma") return ret;


Inconsistent variable reference. This uses props.options?.phase but the local options variable (line 25) is of type Required<IAutoBeGetFilesOptions> with a guaranteed phase property. Change this to options.phase to use the local variable consistently.

Copilot · 2025-11-18T06:29:38Z

packages/agent/src/factory/getAutoBeGenerated.ts

    );
  }
-  if (options?.stage === "interface") return ret;
+  if (props.options?.phase === "interface") return ret;


Inconsistent variable reference. This uses props.options?.phase but the local options variable (line 25) is of type Required<IAutoBeGetFilesOptions> with a guaranteed phase property. Change this to options.phase to use the local variable consistently.

Copilot · 2025-11-18T06:29:38Z

packages/compiler/src/AutoBeCompiler.ts

+import { AutoBeCompilerCommonTemplate } from "./raw/AutoBeCompilerCommonTemplate";
+import { AutoBeCompilerInterfaceTemplate } from "./raw/AutoBeCompilerInterfaceTemplate";
+import { AutoBeCompilerRealizeTemplateOfPostgres } from "./raw/AutoBeCompilerRealizeTemplateOfPostgres";
+import { AutoBeCompilerRealizeTemplateOfSQLite } from "./raw/AutoBeCompilerRealizeTemplateOfSQLite";
+import { AutoBeCompilerTestTemplate } from "./raw/AutoBeCompilerTestTemplate";


AutoBeCompilerRealizeTemplate is not imported but is needed in the getTemplate method (lines 71-76) to include the base realize template files. The import statement should be added: import { AutoBeCompilerRealizeTemplate } from "./raw/AutoBeCompilerRealizeTemplate";

Copilot · 2025-11-18T06:29:38Z

packages/compiler/src/AutoBeCompiler.ts

+    if (options.phase === "realize")
+      Object.assign(
+        result,
+        options.dbms === "postgres"
+          ? AutoBeCompilerRealizeTemplateOfPostgres
+          : AutoBeCompilerRealizeTemplateOfSQLite,
+      );


Missing base realize template. Before adding the dbms-specific templates, the base AutoBeCompilerRealizeTemplate should be included. Add Object.assign(result, AutoBeCompilerRealizeTemplate); before the conditional dbms-specific template assignment.

Copilot · 2025-11-18T06:29:38Z

packages/agent/src/factory/getAutoBeGenerated.ts

      }),
    );
-  if (options?.stage === "test") return ret;
+  if (props.options?.phase === "test") return ret;


Inconsistent variable reference. This uses props.options?.phase but the local options variable (line 25) is of type Required<IAutoBeGetFilesOptions> with a guaranteed phase property. Change this to options.phase to use the local variable consistently.

Copilot · 2025-11-18T06:29:39Z

packages/agent/src/factory/getAutoBeGenerated.ts

+        value.metric.validationFailure.toLocaleString(),
+        value.metric.invalidJson.toLocaleString(),
+        value.metric.success.toLocaleString(),
+        ((value.metric.success / value.metric.attempt) * 100).toFixed(2) + " %",


Potential division by zero. If value.metric.attempt is 0, this will produce NaN. Consider adding a check: value.metric.attempt > 0 ? ((value.metric.success / value.metric.attempt) * 100).toFixed(2) + " %" : "0.00 %".

Suggested change

((value.metric.success / value.metric.attempt) * 100).toFixed(2) + " %",

value.metric.attempt > 0

? ((value.metric.success / value.metric.attempt) * 100).toFixed(2) + " %"

: "0.00 %",

Copilot · 2025-11-18T06:29:39Z

packages/agent/src/factory/getAutoBeGenerated.ts

    const schemaFiles: Record<string, string> =
      (options?.dbms ?? "postgres") === "postgres"
-        ? state.prisma.schemas
-        : await compiler.prisma.write(state.prisma.result.data, options!.dbms!);
+        ? props.state.prisma.schemas
+        : await props.compiler.prisma.write(
+            props.state.prisma.result.data,
+            options!.dbms!,
+          );


Variable shadowing issue. This code uses options?.dbms ?? "postgres" and options!.dbms! which refer to props.options, but a local options variable of type Required<IAutoBeGetFilesOptions> is defined at line 25 with a guaranteed dbms property. This code should use the local options.dbms instead to avoid the optional chaining and non-null assertions.

Copilot · 2025-11-18T06:29:39Z

packages/agent/src/factory/getAutoBeGenerated.ts

+        authorizations: props.state.realize.authorizations,
+        functions: props.state.realize.functions,
        options: {
          dbms: options?.dbms ?? "postgres",


The variable reference is inconsistent with the local options that was created at the top of the function. This line uses options?.dbms ?? "postgres" when it should just use options.dbms since options is already guaranteed to have a dbms property (defined as Required<IAutoBeGetFilesOptions>).

Suggested change

dbms: options?.dbms ?? "postgres",

dbms: options.dbms,

feat(compiler): new README of generated

aa92108

samchon requested a review from Copilot November 18, 2025 06:24

samchon self-assigned this Nov 18, 2025

samchon added this to WrtnLabs Nov 18, 2025

samchon added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 18, 2025

Copilot started reviewing on behalf of samchon November 18, 2025 06:25 View session

Copilot finished reviewing on behalf of samchon November 18, 2025 06:27

Copilot AI reviewed Nov 18, 2025

View reviewed changes

samchon added 2 commits November 18, 2025 15:39

enhance rEADME

08e5668

complete documentation

a01b845

samchon marked this pull request as ready for review November 18, 2025 06:58

samchon added 3 commits November 18, 2025 15:59

fix AutoBeCompleteEventMovie

9c01c2a

fix correction type

b84f86e

Merge branch 'main' into feat/readme

d602d3d

samchon merged commit 67321da into main Nov 18, 2025
4 checks passed

samchon deleted the feat/readme branch November 18, 2025 07:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(compiler): new README of generated #803

feat(compiler): new README of generated #803

Uh oh!

samchon commented Nov 18, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Copilot AI Nov 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	if (props.options?.phase === "analyze") return ret;
	if (options.phase === "analyze") return ret;

-        ((value.metric.success / value.metric.attempt) * 100).toFixed(2) + " %",
+        value.metric.attempt > 0
+          ? ((value.metric.success / value.metric.attempt) * 100).toFixed(2) + " %"
+          : "0.00 %",

feat(compiler): new README of generated #803

feat(compiler): new README of generated #803

Uh oh!

Conversation

samchon commented Nov 18, 2025

Template Generation and Phase Handling

README and Benchmark Enhancements

Interface and Test File Generation

Build and Template Management

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants