Skip to content

first#505

Merged
ignatandrei merged 3 commits into
mainfrom
Strings.ResourceGenerator
May 29, 2026
Merged

first#505
ignatandrei merged 3 commits into
mainfrom
Strings.ResourceGenerator

Conversation

@ignatandrei
Copy link
Copy Markdown
Owner

@ignatandrei ignatandrei commented May 29, 2026

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added comprehensive documentation and usage examples for TypedStateBuilder.Generator, a new Roslyn source code generator for creating compile-time safe builders using the type-state pattern.
    • Updated generator collection count from 270 to 271 examples across all documentation pages and indexes.

Review Change Stack

Copilot AI review requested due to automatic review settings May 29, 2026 04:07
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 29, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This pull request adds a new Roslyn source code generator example (TypedStateBuilder.Generator) as the 271st entry to the RSCG Examples index. The changes include a complete example project, extensive documentation, data registry updates, and site integration across all index pages, category pages, and navigation elements.

Changes

TypedStateBuilder.Generator Example Addition

Layer / File(s) Summary
Generator registry and metadata entries
README.md, later.md, v2/RSCGExamplesData/GeneratorDataRec.json, v2/docFind.json, v2/rscg_examples/TypedStateBuilder.Generator/description.json, v2/rscg_examples/TypedStateBuilder.Generator/nuget.txt, v2/rscg_examples_site/static/exports/RSCG.json
Adds TypedStateBuilder.Generator metadata to JSON indices, increments total generator count from 270 to 271, and updates version timestamps to 2026-05-16 across root-level tracking files.
Example C# project implementation
v2/rscg_examples/TypedStateBuilder.Generator/src/Builder.slnx, src/Builder/Builder.csproj, src/Builder/Person.cs, src/Builder/Program.cs, src/Builder/globals.cs
Demonstrates the TypedStateBuilder pattern with a PersonBuilder class featuring annotated step/validation fields, a validation method enforcing string non-whitespace and minimum length, a Person record, and a top-level executable that chains builder calls and outputs the result.
Comprehensive documentation
v2/rscg_examples/TypedStateBuilder.Generator/readme.txt, v2/rscg_examples_site/docs/RSCG-Examples/TypedStateBuilder.Generator.md
Documents the type-state pattern, compile-time builder safety guarantees, feature comparisons, branching rules, step semantics and overloads, validation behavior, build method constraints, and shows representative generated output with attribute/state interfaces.
Site pages, lists, and navigation
v2/book/examples/TypedStateBuilder.Generator.html, v2/book/list.html, v2/rscg_examples_site/docs/RSCG-Examples/index.md, v2/rscg_examples_site/docs/about.md, v2/rscg_examples_site/docs/indexRSCG.md, v2/rscg_examples_site/docs/Categories/Builder.md, v2/rscg_examples_site/docs/Categories/_PrimitiveBuilder.mdx, v2/rscg_examples_site/docs/Authors/Georgiy_Petrov.md, v2/rscg_examples_site/src/components/HomepageFeatures/index.js
Updates all index, category, author, and list pages to reference and count the new example; increments Builder category count from 8 to 9; updates Mermaid flowchart edges and homepage feature card text from 270 to 271 examples.
CodeTour and build configuration
v2/.tours/TypedStateBuilder.Generator.tour, v2/rscg_examples/TypedStateBuilder.Generator/video.json, v2/book/pandocHTML.yaml
Adds interactive CodeTour steps linking to example files, video.json script with narration/navigation steps, and includes the new HTML documentation page in Pandoc build input files.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

  • ignatandrei/RSCG_Examples#500: Follows the same pattern of adding a new RSCG generator example by updating GeneratorDataRec.json, docFind.json, book/list.html, and other site indexing files.
  • ignatandrei/RSCG_Examples#503: Similar addition of a new RSCG example with updates to the same core registry and navigation structures.
  • ignatandrei/RSCG_Examples#414: Previous work on the same generator registry data structure (GeneratorDataRec.json) and related exports.

Poem

🐰 A builder born from type-state dreams,
Now indexed bright in the RSCG streams,
271 strong, the list runs deep,
With PersonBuilder's promise to keep—
Compile-time safe, no invalid maze,
The TypedStateBuilder lights the way!

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check ❓ Inconclusive The title 'first' is vague and generic, providing no meaningful information about the actual changeset which adds comprehensive documentation for TypedStateBuilder.Generator (the 271st RSCG). Use a descriptive title that reflects the main change, such as 'Add TypedStateBuilder.Generator as 271st RSCG example' or 'Document TypedStateBuilder.Generator with examples and metadata'.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch Strings.ResourceGenerator

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@ignatandrei ignatandrei merged commit bbe0ffb into main May 29, 2026
2 of 4 checks passed
@ignatandrei ignatandrei deleted the Strings.ResourceGenerator branch May 29, 2026 04:11
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants