Skip to content

docs(hz): add README, clarifying comments, and fix broken tests#1492

Merged
xiaost merged 1 commit intomainfrom
docs/hz-tool-improve
Apr 16, 2026
Merged

docs(hz): add README, clarifying comments, and fix broken tests#1492
xiaost merged 1 commit intomainfrom
docs/hz-tool-improve

Conversation

@xiaost
Copy link
Copy Markdown
Contributor

@xiaost xiaost commented Apr 9, 2026

Add a comprehensive README.md documenting hz's architecture, dual-mode execution model, code generation pipeline, and template system.

Add comments to unclear code across 17 source files in cmd/hz/ covering the model type system, router tree construction, template generation, handler/client codegen, argument serialization, and plugin architecture.

Fix two pre-existing test failures:

  • generator/model_test: add missing GoType field to Enum test data
  • thrift/plugin_test: generate fixture programmatically instead of depending on a never-committed binary file (request_thrift.out)

@xiaost xiaost requested review from a team as code owners April 9, 2026 09:31
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.36%. Comparing base (85b257b) to head (542f4f3).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1492      +/-   ##
==========================================
+ Coverage   86.32%   86.36%   +0.03%     
==========================================
  Files         148      148              
  Lines       14169    14169              
==========================================
+ Hits        12232    12237       +5     
+ Misses       1410     1407       -3     
+ Partials      527      525       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@xiaost xiaost force-pushed the docs/hz-tool-improve branch from 0e00f41 to 90ff7b4 Compare April 9, 2026 09:36
Add a comprehensive README.md documenting hz's architecture, dual-mode
execution model, code generation pipeline, and template system.

Add comments to unclear code across 17 source files in cmd/hz/ covering
the model type system, router tree construction, template generation,
handler/client codegen, argument serialization, and plugin architecture.

Fix two pre-existing test failures:
- generator/model_test: add missing GoType field to Enum test data
- thrift/plugin_test: generate fixture programmatically instead of
  depending on a never-committed binary file (request_thrift.out)
@xiaost xiaost force-pushed the docs/hz-tool-improve branch from 90ff7b4 to 542f4f3 Compare April 9, 2026 09:44
@xiaost xiaost merged commit b4039b7 into main Apr 16, 2026
36 checks passed
@xiaost xiaost deleted the docs/hz-tool-improve branch April 16, 2026 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants