added example #398
added example #398
Conversation
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughAdds a new example "requiredenum" (RSCG #226) with docs, sample project, metadata, and site integration; bumps catalog counts 225→226; updates NoExamples and later lists; introduces OutputFiles.HasFilesGenerated and threads it into MultiGeneratorV2 to let the Docusaurus template omit the "Generated Files" block when empty; minor whitespace/docs cleanups. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor GeneratorProcess
participant DataModel as Description.Data
participant MultiGen as MultiGeneratorV2
participant Template as ScribanTemplate
participant Site as DocusaurusPage
GeneratorProcess->>MultiGen: WroteDocusaurus(Description, otherDesc, category)
MultiGen->>DataModel: Evaluate outputFiles.HasFilesGenerated()
DataModel-->>MultiGen: HasFilesGenerated (true/false)
MultiGen->>Template: Render with { Description, HasFilesGenerated, otherDesc, category }
alt HasFilesGenerated == true
Template->>Site: Include "Generated Files" Tabs and items
else
Template->>Site: Omit "Generated Files" section
end
Site-->>GeneratorProcess: Page produced
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Poem
✨ Finishing Touches
🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new example for the "requiredenum" source generator to the RSCG examples collection. The requiredenum generator helps ensure all enum values are handled in switch statements by raising compile-time errors for missing cases.
- Added complete documentation and examples for the requiredenum source generator
- Updated counters throughout the site from 225 to 226 examples
- Integrated the new example into the categorization system under the Enum category
Reviewed Changes
Copilot reviewed 30 out of 32 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| v2/rscg_examples_site/static/exports/RSCG.json | Added requiredenum entry to the JSON export |
| v2/rscg_examples_site/src/components/HomepageFeatures/index.js | Updated homepage counter from 225 to 226 examples |
| v2/rscg_examples_site/docs/indexRSCG.md | Updated main index with new count and requiredenum entry |
| v2/rscg_examples_site/docs/about.md | Updated about page counter |
| v2/rscg_examples_site/docs/RSCG-Examples/requiredenum.md | Added comprehensive documentation for requiredenum |
| v2/rscg_examples_site/docs/RSCG-Examples/index.md | Added requiredenum to category listings |
| Multiple example files | Created complete source code example demonstrating requiredenum usage |
| Multiple category files | Updated Enum category to include requiredenum |
| v2/book/ files | Updated book generation files with new example |
| Configuration files | Updated various configuration and data files to include requiredenum |
Comments suppressed due to low confidence (1)
v2/Generator/DocusaurusExample.txt:1
- This template change explains the missing generated files sections in the other documentation files. The conditional logic now properly handles cases where no generated files exist, which is good for maintainability.
---
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
v2/rscg_examples_site/docs/RSCG-Examples/JinShil.MixinSourceGenerator.md
Show resolved
Hide resolved
v2/rscg_examples_site/docs/RSCG-Examples/FactoryGenerator.Abstractions.md
Show resolved
Hide resolved
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (45)
v2/rscg_examples/requiredenum/nuget.txt (1)
1-1: Polish wording for clarity.Minor grammar tweak reads more naturally.
-RequiredEnum is an open-source analyzer that helps handle all enum values for switch. +RequiredEnum is an open-source analyzer that helps ensure all enum values are handled in switch statements.v2/rscg_examples/requiredenum/readme.txt (4)
7-8: Package casing consistency (optional).NuGet IDs are case-insensitive, but using the canonical casing improves polish.
-[NuGet](https://www.nuget.org/packages/RequiredEnum/): `dotnet add package requiredenum` +[NuGet](https://www.nuget.org/packages/RequiredEnum/): `dotnet add package RequiredEnum`
11-11: Fix grammar and make behavior explicit.Tighten the sentence and clarify that the analyzer reports an error.
-Just add 'Required' prefix for any name of enum in your project and you will get the error when one of cases weren't handle in a switch statement. +Prefix any enum name with 'Required' in your project, and the analyzer will report an error if any case is not handled in a switch statement.
13-31: Switch example may undermine “exhaustive” intent if default is allowed.If RequiredEnum flags missing explicit enum members and disallows default, consider removing the default branch in the sample to illustrate the diagnostic more clearly.
switch (test) { case RequiredNumbers.Zero: break; case RequiredNumbers.One: break; - default: - throw new ArgumentOutOfRangeException(); + // Missing RequiredNumbers.Two on purpose to trigger the analyzer }If the analyzer permits default, alternatively add the missing case instead.
32-32: Clarify compile-time nature and fix grammar.Use “compile-time error” and correct the wording.
-This code will throw the error ('Two' case wasn't handle) and it can't be compiled. +This code will produce a compile-time error (“Two” case isn’t handled) and will not compile.v2/rscg_examples/requiredenum/src/EnumDemo/RequiredCarTypes.cs (2)
6-10: Remove stray spaces before commas.Minor style fix for consistency.
- Dacia , - Tesla , - BMW , - Mercedes , + Dacia, + Tesla, + BMW, + Mercedes,
5-10: Consider explicit enum values for stability (optional).Assigning values prevents accidental renumbering.
public enum RequiredCarTypes { - None, - Dacia, - Tesla, - BMW, - Mercedes, + None = 0, + Dacia = 1, + Tesla = 2, + BMW = 3, + Mercedes = 4, }later.md (2)
11-131: Remove duplicate bare URLs to satisfy markdownlint (MD034).Each item includes both a Markdown link and a bare URL. Keep the Markdown link and drop the trailing bare URL copies.
Apply this pattern across the list (sample shown):
-1) [BigMachines]( https://github.com/archi-Doc/BigMachines) , https://github.com/archi-Doc/BigMachines +1) [BigMachines](https://github.com/archi-Doc/BigMachines) -2) [Dexie]( https://github.com/b-straub/DexieNET) , https://github.com/b-straub/DexieNET +2) [Dexie](https://github.com/b-straub/DexieNET) -3) [epj.RouteGenerator]( https://github.com/ewerspej/epj.RouteGenerator) , https://github.com/ewerspej/epj.RouteGenerator +3) [epj.RouteGenerator](https://github.com/ewerspej/epj.RouteGenerator)
13-133: Minor punctuation: remove spaces before colons.For consistency, use “Why I have not tested: later”.
-Why I have not tested : later +Why I have not tested: laterv2/Generator/DocusaurusExample.txt (1)
97-115: Gate the entire “Generated Files” section (title + note) behind the condition.Right now the header and note render even when there are no files, leaving an empty section.
-### Generated Files - -Those are taken from $(BaseIntermediateOutputPath)\GX -{{~ if Description.Data.outputFiles.HasFilesGenerated ~}} -<Tabs> +{{~ if Description.Data.outputFiles.HasFilesGenerated ~}} +### Generated Files + +Those are taken from $(BaseIntermediateOutputPath)\GX +<Tabs> @@ -</Tabs> -{{~ end ~}} +</Tabs> +{{~ end ~}}v2/rscg_examples/requiredenum/src/EnumDemo/Program.cs (1)
24-26: Optional: consider removing the default case to better surface missing enum members.If the generator allows, dropping default makes an omitted case immediately visible at compile-time.
Would you like me to adjust the snippet and verify the generator still flags missing members without default?
v2/rscg_examples_site/docs/NoExamples.md (1)
257-265: Replace bare URLs with Markdown links (MD034).Convert “Name URL” to “Name” to satisfy the linter and improve readability.
-63) HttpClientCodeGenerator https://github.com/Jalalx/HttpClientCodeGenerator +63) [HttpClientCodeGenerator](https://github.com/Jalalx/HttpClientCodeGenerator) -64) https://github.com/Agentew04/CliToolkit https://github.com/Agentew04/CliToolkit +64) [CliToolkit](https://github.com/Agentew04/CliToolkit) -65) https://github.com/AlexNav73/CoreCraft https://github.com/AlexNav73/CoreCraft +65) [CoreCraft](https://github.com/AlexNav73/CoreCraft)Repeat for the remaining items in this block.
v2/rscg_examples/requiredenum/src/EnumDemo/EnumDemo.csproj (2)
10-13: Path note (optional): consider cross-platform-friendly output path.Backslashes work in MSBuild, but using
$(BaseIntermediateOutputPath)GX or $ (BaseIntermediateOutputPath)/GX is a bit cleaner across OSes.-<CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)\GX</CompilerGeneratedFilesOutputPath> +<CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)/GX</CompilerGeneratedFilesOutputPath>
16-19: Package assets: IncludeAssets is redundant with PrivateAssets=all.Harmless, but you can drop IncludeAssets to reduce noise.
- <PackageReference Include="RequiredEnum" Version="0.0.1"> - <PrivateAssets>all</PrivateAssets> - <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets> - </PackageReference> + <PackageReference Include="RequiredEnum" Version="0.0.1"> + <PrivateAssets>all</PrivateAssets> + </PackageReference>v2/rscg_examples/requiredenum/src/.tours/requiredenum.tour (2)
9-11: Nit: capitalize “NuGet”.Use the official capitalization for consistency in docs/UI.
- "description": "First, we add Nuget [requiredenum](https://www.nuget.org/packages/requiredenum/) in csproj ", + "description": "First, we add NuGet [requiredenum](https://www.nuget.org/packages/requiredenum/) in the .csproj.",
15-23: Make CodeTour patterns actionable."this is the code" likely won’t match anything. Use identifiers present in files to auto-focus the editor.
- "description": "File RequiredCarTypes.cs ", - "pattern": "this is the code" + "description": "Enum declaration in RequiredCarTypes.cs", + "pattern": "enum RequiredCarTypes" @@ - "description": "File Program.cs \r\n>> dotnet run --project EnumDemo/EnumDemo.csproj ", - "pattern": "this is the code" + "description": "Program.cs — run: `dotnet run --project EnumDemo/EnumDemo.csproj`", + "pattern": "static void Main"v2/rscg_examples/requiredenum/video.json (1)
18-21: Portability: hardcoded Windows paths reduce reproducibility.Consider making paths relative or parameterized so the script works across environments.
-{"typeStep":"exec","arg":"explorer.exe /select,D:\\gth\\RSCG_Examples\\v2\\rscg_examples\\requiredenum\\src\\EnumDemo.sln"}, +{"typeStep":"exec","arg":"${EXPLORER:-explorer.exe} /select,${REPO_ROOT}\\v2\\rscg_examples\\requiredenum\\src\\EnumDemo.sln"}, @@ -{"typeStep":"stepvscode","arg": "-r -g D:\\gth\\RSCG_Examples\\v2\\rscg_examples\\requiredenum\\src\\EnumDemo\\EnumDemo.csproj"}, +{"typeStep":"stepvscode","arg": "-r -g ${REPO_ROOT}/v2/rscg_examples/requiredenum/src/EnumDemo/EnumDemo.csproj"},Also applies to: 24-24
v2/rscg_examples_site/docs/about.md (1)
9-10: Grammar tweak for clarity/pluralization.Use plural “Generators” and tighten the sentence.
-of 226 Roslyn Source Code Generator (RSCG) +of 226 Roslyn Source Code Generators (RSCGs)v2/rscg_examples_site/src/components/HomepageFeatures/index.js (1)
7-7: Avoid manual counts in UI (optional)Consider deriving the examples count from the exported JSON at build/runtime to prevent future drift.
v2/rscg_examples_site/docs/indexRSCG.md (2)
12-12: Fix extra space in parenthesesRemove the extra space before 14 for cleaner typography.
-This is the list of 226 ( 14 from Microsoft) RSCG with examples +This is the list of 226 (14 from Microsoft) RSCG with examples
23-23: Fix markdownlint MD039: no spaces inside link textTrailing space inside [] breaks MD039.
-|226| [requiredenum by Yaroslav ](/docs/requiredenum)|2025-08-14 => 14 August 2025 | [Enum](/docs/Categories/Enum) | +|226| [requiredenum by Yaroslav](/docs/requiredenum)|2025-08-14 => 14 August 2025 | [Enum](/docs/Categories/Enum) |v2/rscg_examples/requiredenum/description.json (1)
12-17: Refine description.json entries
- Update “goodFor” to a clearer sentence and remove the trailing space.
- Replace placeholder arrays with empty arrays.
- "goodFor":["Raise an error at compile time if not have switch handle case all enums values "], + "goodFor": ["Raise a compile-time error if a switch does not handle all enum values."], "csprojDemo":"EnumDemo.csproj", "csFiles":["Program.cs","RequiredCarTypes.cs"], - "excludeDirectoryGenerated":[""], - "includeAdditionalFiles":[""] + "excludeDirectoryGenerated": [], + "includeAdditionalFiles": []v2/book/examples/requiredenum.html (7)
5-5: Fix NuGet capitalization.
Use “NuGet” (official casing).-Nuget : <a href="https://www.nuget.org/packages/requiredenum/" target="_blank">https://www.nuget.org/packages/requiredenum/</a> +NuGet : <a href="https://www.nuget.org/packages/requiredenum/" target="_blank">https://www.nuget.org/packages/requiredenum/</a>
5-5: Add rel="noopener noreferrer" to external links opened in new tabs.
Prevents reverse tabnabbing; low-effort hardening.-<a href="https://www.nuget.org/packages/requiredenum/" target="_blank"> +<a href="https://www.nuget.org/packages/requiredenum/" target="_blank" rel="noopener noreferrer">(Apply similarly to other target="_blank" anchors in this file.)
Also applies to: 7-7, 11-11, 42-44, 50-52
15-15: Tighten wording for the “About” sentence.
Grammar/readability.-Raise an error at compile time if not have switch handle case all enums values +Raise a compile-time error when a switch does not handle all values of an enum.
21-23: Clarify instruction phrasing.
Minor grammar.-Add reference to the <a href="https://www.nuget.org/packages/requiredenum/" target="_blank">requiredenum</a> in the csproj +Add a reference to <a href="https://www.nuget.org/packages/requiredenum/" target="_blank" rel="noopener noreferrer">requiredenum</a> in the .csproj.
23-23: Provide alt text on images.
Accessibility.-<img src="images/requiredenum/EnumDemo.csproj.png" width="580" height="580" /> +<img src="images/requiredenum/EnumDemo.csproj.png" width="580" height="580" alt="EnumDemo.csproj PackageReference to requiredenum" />(Apply similar descriptive alt text to Program.cs.png and RequiredCarTypes.cs.png.)
Also applies to: 30-30, 36-36
38-39: Remove empty “generated files” section or populate it.
This example is an analyzer; no generated files are shown—avoid an empty header.- <h3>And here are the <i>generated</i> files</h3> - + <!-- No generated files for this analyzer example -->
9-9: Narrow author label.
Add a space after colon.-<p>Author :Yaroslav</p> +<p>Author: Yaroslav</p>v2/rscg_examples_site/docs/RSCG-Examples/requiredenum.md (9)
4-4: Polish description sentence.
Grammar.-description: Raise an error at compile time if not have switch handle case all enums values +description: Raise a compile-time error when a switch doesn’t handle all enum values.
25-41: Tidy “Info” block: consistent links/casing.
Use one canonical link line; keep “NuGet” casing.-Name: **requiredenum** - -RequiredEnum is an open-source analyzer that helps handle all enum values for switch. - -Author: Yaroslav - -NuGet: -*https://www.nuget.org/packages/requiredenum/* - - -You can find more details at https://github.com/emptycoder/RequiredEnum - -Source: https://github.com/emptycoder/RequiredEnum +Name: **requiredenum** +Description: Analyzer that enforces exhaustive switch handling for “Required*” enums. +Author: Yaroslav +NuGet: https://www.nuget.org/packages/requiredenum/ +Source: https://github.com/emptycoder/RequiredEnum
58-63: Fix phrasing in Original Readme quote.
Minor grammar inside quoted instructions.-Just add 'Required' prefix for any name of enum in your project and you will get the error when one of cases weren't handle in a switch statement. +Add the 'Required' prefix to any enum name in your project to get an error when one of the cases isn’t handled in a switch statement.
95-95: Repeat of description: fix grammar.
Keep consistent with front matter.-Raise an error at compile time if not have switch handle case all enums values +Raise a compile-time error when a switch doesn’t handle all enum values.
120-122: Replace hard tabs with spaces.
Satisfy MD010.- <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles> - <CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)\GX</CompilerGeneratedFilesOutputPath> - </PropertyGroup> + <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles> + <CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)\GX</CompilerGeneratedFilesOutputPath> + </PropertyGroup>
194-199: Hide “Generated Files” for analyzer-only examples.
No files are shown; remove or conditionally render.-### Generated Files - -Those are taken from $(BaseIntermediateOutputPath)\GX +<!-- Analyzer example: no generated files -->
203-205: Trim space inside link text.
Satisfy MD039.-[Download Example project requiredenum ](/sources/requiredenum.zip) +[Download Example project requiredenum](/sources/requiredenum.zip)
210-215: Update social copy.
“on Twitter” and consider “X (Twitter)”.- <li><a href="https://twitter.com/intent/tweet?source=https%3A%2F%2Fignatandrei.github.io%2FRSCG_Examples%2Fv2%2Fdocs%2Frequiredenum&text=requiredenum:%20https%3A%2F%2Fignatandrei.github.io%2FRSCG_Examples%2Fv2%2Fdocs%2Frequiredenum" target="_blank" title="Tweet">Share in Twitter</a></li> + <li><a href="https://twitter.com/intent/tweet?source=https%3A%2F%2Fignatandrei.github.io%2FRSCG_Examples%2Fv2%2Fdocs%2Frequiredenum&text=requiredenum:%20https%3A%2F%2Fignatandrei.github.io%2FRSCG_Examples%2Fv2%2Fdocs%2Frequiredenum" target="_blank" rel="noopener noreferrer" title="Tweet">Share on X (Twitter)</a></li>(Add rel="noopener noreferrer" to all target="_blank" links in this list.)
217-217: Avoid bare URL; make it a link or remove.
Satisfy MD034.-https://ignatandrei.github.io/RSCG_Examples/v2/docs/requiredenum +[Page link](/docs/requiredenum)README.md (7)
1-1: Polish the title formattingMake it cleaner and consistent with the rest of the doc.
-# RSCG - 226 Examples of Roslyn Source Code Generators / 14 created by Microsoft / +# RSCG — 226 Examples of Roslyn Source Code Generators (14 by Microsoft)
23-24: Tighten grammar in the intro sentence-Those are the 226 Roslyn Source Code Generators that I have tested you can see and download source code example. -( including 14 from Microsoft ) +These are the 226 Roslyn Source Code Generators I have tested. You can see and download source code examples + (including 14 from Microsoft).
25-46: Clarify wording in the new “requiredenum” entry and keep style consistentSmall copy edits for clarity.
-Author: Yaroslav +Author: Yaroslav -RequiredEnum is an open-source analyzer that helps handle all enum values for switch. +RequiredEnum is an open-source analyzer that helps ensure all enum values are handled in switch statements. -Nuget: [https://www.nuget.org/packages/requiredenum/](https://www.nuget.org/packages/requiredenum/) +NuGet: [requiredenum](https://www.nuget.org/packages/requiredenum/)If you prefer, I can apply the same “NuGet:” label normalization to nearby entries.
5188-5188: Fix typo and phrasing (“refelection”)-Why I have not tested : System.Text.Json has already not refelection serializer +Why I have not tested: System.Text.Json already offers a reflection-free serializer (source generators)
5258-5258: Fix typo: “atchived” → “archived”-Why I have not tested : atchived +Why I have not tested: archived
5284-5599: Remove duplicate bare URLs and satisfy markdownlint (MD034)Each item currently shows both a markdown link and a bare URL copy. Keep one markdown link (prefer human-friendly text) and drop the trailing bare URL. Apply across this whole section.
Example for a couple of entries:
-18) [https://github.com/Agentew04/CliToolkit]( https://github.com/Agentew04/CliToolkit) , https://github.com/Agentew04/CliToolkit +18) [Agentew04/CliToolkit](https://github.com/Agentew04/CliToolkit) -19) [https://github.com/AlexNav73/CoreCraft]( https://github.com/AlexNav73/CoreCraft) , https://github.com/AlexNav73/CoreCraft +19) [AlexNav73/CoreCraft](https://github.com/AlexNav73/CoreCraft)If you want, I can generate a one-off script to auto-fix this pattern.
5606-5606: Header style consistencyAlign with earlier headings and remove extra spaces.
-## Do not want to test 111 ( old ISourceGenerator ) +## Do not want to test 111 (old ISourceGenerator)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (3)
v2/Generator/all.csvis excluded by!**/*.csvv2/rscg_examples_site/static/exports/RSCG.xlsxis excluded by!**/*.xlsxv2/rscg_examples_site/static/sources/requiredenum.zipis excluded by!**/*.zip
📒 Files selected for processing (29)
README.md(8 hunks)later.md(1 hunks)v2/Generator/DocusaurusExample.txt(2 hunks)v2/RSCGExamplesData/GeneratorDataRec.json(1 hunks)v2/RSCGExamplesData/NoExample.json(0 hunks)v2/book/examples/requiredenum.html(1 hunks)v2/book/list.html(2 hunks)v2/book/pandocHTML.yaml(1 hunks)v2/rscg_examples/requiredenum/description.json(1 hunks)v2/rscg_examples/requiredenum/nuget.txt(1 hunks)v2/rscg_examples/requiredenum/readme.txt(1 hunks)v2/rscg_examples/requiredenum/src/.tours/requiredenum.tour(1 hunks)v2/rscg_examples/requiredenum/src/EnumDemo.sln(1 hunks)v2/rscg_examples/requiredenum/src/EnumDemo/EnumDemo.csproj(1 hunks)v2/rscg_examples/requiredenum/src/EnumDemo/Program.cs(1 hunks)v2/rscg_examples/requiredenum/src/EnumDemo/RequiredCarTypes.cs(1 hunks)v2/rscg_examples/requiredenum/video.json(1 hunks)v2/rscg_examples_site/docs/Categories/Enum.md(2 hunks)v2/rscg_examples_site/docs/Categories/_PrimitiveEnum.mdx(1 hunks)v2/rscg_examples_site/docs/NoExamples.md(4 hunks)v2/rscg_examples_site/docs/RSCG-Examples/FactoryGenerator.Abstractions.md(0 hunks)v2/rscg_examples_site/docs/RSCG-Examples/JinShil.MixinSourceGenerator.md(0 hunks)v2/rscg_examples_site/docs/RSCG-Examples/Schema.md(0 hunks)v2/rscg_examples_site/docs/RSCG-Examples/index.md(4 hunks)v2/rscg_examples_site/docs/RSCG-Examples/requiredenum.md(1 hunks)v2/rscg_examples_site/docs/about.md(1 hunks)v2/rscg_examples_site/docs/indexRSCG.md(2 hunks)v2/rscg_examples_site/src/components/HomepageFeatures/index.js(1 hunks)v2/rscg_examples_site/static/exports/RSCG.json(1 hunks)
💤 Files with no reviewable changes (4)
- v2/RSCGExamplesData/NoExample.json
- v2/rscg_examples_site/docs/RSCG-Examples/Schema.md
- v2/rscg_examples_site/docs/RSCG-Examples/JinShil.MixinSourceGenerator.md
- v2/rscg_examples_site/docs/RSCG-Examples/FactoryGenerator.Abstractions.md
🧰 Additional context used
🪛 LanguageTool
v2/rscg_examples_site/docs/about.md
[grammar] ~9-~9: There might be a mistake here.
Context: ... 226 Roslyn Source Code Generator (RSCG) that can be useful for you. That means, ...
(QB_NEW_EN)
v2/rscg_examples/requiredenum/readme.txt
[grammar] ~11-~11: There might be a mistake here.
Context: ...ect and you will get the error when one of cases weren't handle in a switch statem...
(QB_NEW_EN)
v2/rscg_examples_site/docs/RSCG-Examples/requiredenum.md
[grammar] ~7-~7: There might be a mistake here.
Context: ...enum --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; im...
(QB_NEW_EN)
[grammar] ~8-~8: There might be a mistake here.
Context: ...'; import TabItem from '@theme/TabItem'; import TOCInline from '@theme/TOCInline'...
(QB_NEW_EN)
[grammar] ~9-~9: There might be a mistake here.
Context: ...mport TOCInline from '@theme/TOCInline'; import SameCategory from '../Categories/...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...Enum?style=social) ## Details ### Info :::info Name: requiredenum Require...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...s for switch. Author: Yaroslav NuGet: *https://www.nuget.org/packages/required...
(QB_NEW_EN)
[grammar] ~43-~43: There might be a mistake here.
Context: ...emptycoder/RequiredEnum ::: ### Author :::note Yaroslav 
[grammar] ~44-~44: There might be a mistake here.
Context: ...er/RequiredEnum ::: ### Author :::note Yaroslav 
[grammar] ~45-~45: There might be a mistake here.
Context: ...dEnum ::: ### Author :::note Yaroslav 
[grammar] ~46-~46: There might be a mistake here.
Context: ...text](https://github.com/emptycoder.png) ::: ### Original Readme :::note <h1 al...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ...emptycoder.png) ::: ### Original Readme :::note
RequiredEnum...
(QB_NEW_EN)
[grammar] ~62-~62: There might be a mistake here.
Context: ...ect and you will get the error when one of cases weren't handle in a switch statem...
(QB_NEW_EN)
[grammar] ~92-~92: There might be a mistake here.
Context: ...dEnum/LICENSE) license. ::: ### About :::note Raise an error at compile time ...
(QB_NEW_EN)
[grammar] ~95-~95: There might be a mistake here.
Context: ... Raise an error at compile time if not have switch handle case all enums values ...
(QB_NEW_EN)
🪛 Biome (2.1.2)
v2/rscg_examples/requiredenum/video.json
[error] 35-36: Property key must be double quoted
(parse)
[error] 36-36: unexpected character =
(parse)
[error] 36-36: expected , but instead found " "
Remove " "
(parse)
[error] 36-36: expected : but instead found }
Remove }
(parse)
[error] 37-38: Expected an array, an object, or a literal but instead found ']'.
Expected an array, an object, or a literal here.
(parse)
🪛 markdownlint-cli2 (0.17.2)
v2/rscg_examples_site/docs/indexRSCG.md
23-23: Spaces inside link text
(MD039, no-space-in-links)
README.md
5284-5284: Bare URL used
(MD034, no-bare-urls)
5288-5288: Bare URL used
(MD034, no-bare-urls)
5291-5291: Bare URL used
(MD034, no-bare-urls)
5295-5295: Bare URL used
(MD034, no-bare-urls)
5298-5298: Bare URL used
(MD034, no-bare-urls)
5302-5302: Bare URL used
(MD034, no-bare-urls)
5305-5305: Bare URL used
(MD034, no-bare-urls)
5309-5309: Bare URL used
(MD034, no-bare-urls)
5312-5312: Bare URL used
(MD034, no-bare-urls)
5316-5316: Bare URL used
(MD034, no-bare-urls)
5319-5319: Bare URL used
(MD034, no-bare-urls)
5323-5323: Bare URL used
(MD034, no-bare-urls)
5326-5326: Bare URL used
(MD034, no-bare-urls)
5330-5330: Bare URL used
(MD034, no-bare-urls)
5333-5333: Bare URL used
(MD034, no-bare-urls)
5337-5337: Bare URL used
(MD034, no-bare-urls)
5340-5340: Bare URL used
(MD034, no-bare-urls)
5344-5344: Bare URL used
(MD034, no-bare-urls)
5347-5347: Bare URL used
(MD034, no-bare-urls)
5351-5351: Bare URL used
(MD034, no-bare-urls)
5354-5354: Bare URL used
(MD034, no-bare-urls)
5358-5358: Bare URL used
(MD034, no-bare-urls)
5361-5361: Bare URL used
(MD034, no-bare-urls)
5365-5365: Bare URL used
(MD034, no-bare-urls)
5368-5368: Bare URL used
(MD034, no-bare-urls)
5372-5372: Bare URL used
(MD034, no-bare-urls)
5375-5375: Bare URL used
(MD034, no-bare-urls)
5379-5379: Bare URL used
(MD034, no-bare-urls)
5382-5382: Bare URL used
(MD034, no-bare-urls)
5386-5386: Bare URL used
(MD034, no-bare-urls)
5389-5389: Bare URL used
(MD034, no-bare-urls)
5393-5393: Bare URL used
(MD034, no-bare-urls)
5396-5396: Bare URL used
(MD034, no-bare-urls)
5400-5400: Bare URL used
(MD034, no-bare-urls)
5403-5403: Bare URL used
(MD034, no-bare-urls)
5407-5407: Bare URL used
(MD034, no-bare-urls)
5410-5410: Bare URL used
(MD034, no-bare-urls)
5414-5414: Bare URL used
(MD034, no-bare-urls)
5417-5417: Bare URL used
(MD034, no-bare-urls)
5421-5421: Bare URL used
(MD034, no-bare-urls)
5424-5424: Bare URL used
(MD034, no-bare-urls)
5428-5428: Bare URL used
(MD034, no-bare-urls)
5431-5431: Bare URL used
(MD034, no-bare-urls)
5435-5435: Bare URL used
(MD034, no-bare-urls)
5438-5438: Bare URL used
(MD034, no-bare-urls)
5442-5442: Bare URL used
(MD034, no-bare-urls)
5445-5445: Bare URL used
(MD034, no-bare-urls)
5449-5449: Bare URL used
(MD034, no-bare-urls)
5452-5452: Bare URL used
(MD034, no-bare-urls)
5456-5456: Bare URL used
(MD034, no-bare-urls)
5459-5459: Bare URL used
(MD034, no-bare-urls)
5463-5463: Bare URL used
(MD034, no-bare-urls)
5466-5466: Bare URL used
(MD034, no-bare-urls)
5470-5470: Bare URL used
(MD034, no-bare-urls)
5473-5473: Bare URL used
(MD034, no-bare-urls)
5477-5477: Bare URL used
(MD034, no-bare-urls)
5480-5480: Bare URL used
(MD034, no-bare-urls)
5484-5484: Bare URL used
(MD034, no-bare-urls)
5487-5487: Bare URL used
(MD034, no-bare-urls)
5491-5491: Bare URL used
(MD034, no-bare-urls)
5494-5494: Bare URL used
(MD034, no-bare-urls)
5498-5498: Bare URL used
(MD034, no-bare-urls)
5501-5501: Bare URL used
(MD034, no-bare-urls)
5505-5505: Bare URL used
(MD034, no-bare-urls)
5508-5508: Bare URL used
(MD034, no-bare-urls)
5512-5512: Bare URL used
(MD034, no-bare-urls)
5515-5515: Bare URL used
(MD034, no-bare-urls)
5519-5519: Bare URL used
(MD034, no-bare-urls)
5522-5522: Bare URL used
(MD034, no-bare-urls)
5526-5526: Bare URL used
(MD034, no-bare-urls)
5529-5529: Bare URL used
(MD034, no-bare-urls)
5533-5533: Bare URL used
(MD034, no-bare-urls)
5536-5536: Bare URL used
(MD034, no-bare-urls)
5540-5540: Bare URL used
(MD034, no-bare-urls)
5543-5543: Bare URL used
(MD034, no-bare-urls)
5547-5547: Bare URL used
(MD034, no-bare-urls)
5550-5550: Bare URL used
(MD034, no-bare-urls)
5554-5554: Bare URL used
(MD034, no-bare-urls)
5557-5557: Bare URL used
(MD034, no-bare-urls)
5561-5561: Bare URL used
(MD034, no-bare-urls)
5564-5564: Bare URL used
(MD034, no-bare-urls)
5568-5568: Bare URL used
(MD034, no-bare-urls)
5571-5571: Bare URL used
(MD034, no-bare-urls)
5575-5575: Bare URL used
(MD034, no-bare-urls)
5578-5578: Bare URL used
(MD034, no-bare-urls)
5582-5582: Bare URL used
(MD034, no-bare-urls)
5585-5585: Bare URL used
(MD034, no-bare-urls)
5589-5589: Bare URL used
(MD034, no-bare-urls)
5592-5592: Bare URL used
(MD034, no-bare-urls)
5596-5596: Bare URL used
(MD034, no-bare-urls)
5599-5599: Bare URL used
(MD034, no-bare-urls)
5603-5603: Bare URL used
(MD034, no-bare-urls)
6268-6268: Bare URL used
(MD034, no-bare-urls)
6274-6274: Bare URL used
(MD034, no-bare-urls)
v2/rscg_examples_site/docs/RSCG-Examples/requiredenum.md
34-34: Bare URL used
(MD034, no-bare-urls)
37-37: Bare URL used
(MD034, no-bare-urls)
39-39: Bare URL used
(MD034, no-bare-urls)
92-92: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
120-120: Hard tabs
Column: 1
(MD010, no-hard-tabs)
121-121: Hard tabs
Column: 1
(MD010, no-hard-tabs)
122-122: Hard tabs
Column: 1
(MD010, no-hard-tabs)
203-203: Spaces inside link text
(MD039, no-space-in-links)
217-217: Bare URL used
(MD034, no-bare-urls)
later.md
11-11: Bare URL used
(MD034, no-bare-urls)
17-17: Bare URL used
(MD034, no-bare-urls)
23-23: Bare URL used
(MD034, no-bare-urls)
29-29: Bare URL used
(MD034, no-bare-urls)
35-35: Bare URL used
(MD034, no-bare-urls)
41-41: Bare URL used
(MD034, no-bare-urls)
47-47: Bare URL used
(MD034, no-bare-urls)
53-53: Bare URL used
(MD034, no-bare-urls)
59-59: Bare URL used
(MD034, no-bare-urls)
65-65: Bare URL used
(MD034, no-bare-urls)
71-71: Bare URL used
(MD034, no-bare-urls)
77-77: Bare URL used
(MD034, no-bare-urls)
83-83: Bare URL used
(MD034, no-bare-urls)
89-89: Bare URL used
(MD034, no-bare-urls)
95-95: Bare URL used
(MD034, no-bare-urls)
101-101: Bare URL used
(MD034, no-bare-urls)
107-107: Bare URL used
(MD034, no-bare-urls)
113-113: Bare URL used
(MD034, no-bare-urls)
119-119: Bare URL used
(MD034, no-bare-urls)
125-125: Bare URL used
(MD034, no-bare-urls)
131-131: Bare URL used
(MD034, no-bare-urls)
v2/rscg_examples_site/docs/NoExamples.md
253-253: Bare URL used
(MD034, no-bare-urls)
257-257: Bare URL used
(MD034, no-bare-urls)
261-261: Bare URL used
(MD034, no-bare-urls)
261-261: Bare URL used
(MD034, no-bare-urls)
265-265: Bare URL used
(MD034, no-bare-urls)
265-265: Bare URL used
(MD034, no-bare-urls)
269-269: Bare URL used
(MD034, no-bare-urls)
269-269: Bare URL used
(MD034, no-bare-urls)
273-273: Bare URL used
(MD034, no-bare-urls)
273-273: Bare URL used
(MD034, no-bare-urls)
277-277: Bare URL used
(MD034, no-bare-urls)
277-277: Bare URL used
(MD034, no-bare-urls)
281-281: Bare URL used
(MD034, no-bare-urls)
281-281: Bare URL used
(MD034, no-bare-urls)
285-285: Bare URL used
(MD034, no-bare-urls)
285-285: Bare URL used
(MD034, no-bare-urls)
289-289: Bare URL used
(MD034, no-bare-urls)
289-289: Bare URL used
(MD034, no-bare-urls)
293-293: Bare URL used
(MD034, no-bare-urls)
293-293: Bare URL used
(MD034, no-bare-urls)
297-297: Bare URL used
(MD034, no-bare-urls)
297-297: Bare URL used
(MD034, no-bare-urls)
301-301: Bare URL used
(MD034, no-bare-urls)
301-301: Bare URL used
(MD034, no-bare-urls)
305-305: Bare URL used
(MD034, no-bare-urls)
305-305: Bare URL used
(MD034, no-bare-urls)
309-309: Bare URL used
(MD034, no-bare-urls)
309-309: Bare URL used
(MD034, no-bare-urls)
313-313: Bare URL used
(MD034, no-bare-urls)
313-313: Bare URL used
(MD034, no-bare-urls)
317-317: Bare URL used
(MD034, no-bare-urls)
317-317: Bare URL used
(MD034, no-bare-urls)
321-321: Bare URL used
(MD034, no-bare-urls)
321-321: Bare URL used
(MD034, no-bare-urls)
325-325: Bare URL used
(MD034, no-bare-urls)
325-325: Bare URL used
(MD034, no-bare-urls)
329-329: Bare URL used
(MD034, no-bare-urls)
329-329: Bare URL used
(MD034, no-bare-urls)
333-333: Bare URL used
(MD034, no-bare-urls)
333-333: Bare URL used
(MD034, no-bare-urls)
337-337: Bare URL used
(MD034, no-bare-urls)
337-337: Bare URL used
(MD034, no-bare-urls)
341-341: Bare URL used
(MD034, no-bare-urls)
341-341: Bare URL used
(MD034, no-bare-urls)
345-345: Bare URL used
(MD034, no-bare-urls)
345-345: Bare URL used
(MD034, no-bare-urls)
349-349: Bare URL used
(MD034, no-bare-urls)
349-349: Bare URL used
(MD034, no-bare-urls)
353-353: Bare URL used
(MD034, no-bare-urls)
357-357: Bare URL used
(MD034, no-bare-urls)
361-361: Bare URL used
(MD034, no-bare-urls)
365-365: Bare URL used
(MD034, no-bare-urls)
369-369: Bare URL used
(MD034, no-bare-urls)
373-373: Bare URL used
(MD034, no-bare-urls)
377-377: Bare URL used
(MD034, no-bare-urls)
381-381: Bare URL used
(MD034, no-bare-urls)
385-385: Bare URL used
(MD034, no-bare-urls)
389-389: Bare URL used
(MD034, no-bare-urls)
393-393: Bare URL used
(MD034, no-bare-urls)
397-397: Bare URL used
(MD034, no-bare-urls)
401-401: Bare URL used
(MD034, no-bare-urls)
405-405: Bare URL used
(MD034, no-bare-urls)
409-409: Bare URL used
(MD034, no-bare-urls)
413-413: Bare URL used
(MD034, no-bare-urls)
417-417: Bare URL used
(MD034, no-bare-urls)
421-421: Bare URL used
(MD034, no-bare-urls)
425-425: Bare URL used
(MD034, no-bare-urls)
429-429: Bare URL used
(MD034, no-bare-urls)
433-433: Bare URL used
(MD034, no-bare-urls)
437-437: Bare URL used
(MD034, no-bare-urls)
441-441: Bare URL used
(MD034, no-bare-urls)
445-445: Bare URL used
(MD034, no-bare-urls)
449-449: Bare URL used
(MD034, no-bare-urls)
453-453: Bare URL used
(MD034, no-bare-urls)
457-457: Bare URL used
(MD034, no-bare-urls)
461-461: Bare URL used
(MD034, no-bare-urls)
465-465: Bare URL used
(MD034, no-bare-urls)
469-469: Bare URL used
(MD034, no-bare-urls)
473-473: Bare URL used
(MD034, no-bare-urls)
477-477: Bare URL used
(MD034, no-bare-urls)
481-481: Bare URL used
(MD034, no-bare-urls)
485-485: Bare URL used
(MD034, no-bare-urls)
489-489: Bare URL used
(MD034, no-bare-urls)
493-493: Bare URL used
(MD034, no-bare-urls)
497-497: Bare URL used
(MD034, no-bare-urls)
501-501: Bare URL used
(MD034, no-bare-urls)
505-505: Bare URL used
(MD034, no-bare-urls)
509-509: Bare URL used
(MD034, no-bare-urls)
513-513: Bare URL used
(MD034, no-bare-urls)
517-517: Bare URL used
(MD034, no-bare-urls)
521-521: Bare URL used
(MD034, no-bare-urls)
525-525: Bare URL used
(MD034, no-bare-urls)
529-529: Bare URL used
(MD034, no-bare-urls)
533-533: Bare URL used
(MD034, no-bare-urls)
537-537: Bare URL used
(MD034, no-bare-urls)
541-541: Bare URL used
(MD034, no-bare-urls)
545-545: Bare URL used
(MD034, no-bare-urls)
549-549: Bare URL used
(MD034, no-bare-urls)
553-553: Bare URL used
(MD034, no-bare-urls)
557-557: Bare URL used
(MD034, no-bare-urls)
561-561: Bare URL used
(MD034, no-bare-urls)
565-565: Bare URL used
(MD034, no-bare-urls)
569-569: Bare URL used
(MD034, no-bare-urls)
573-573: Bare URL used
(MD034, no-bare-urls)
577-577: Bare URL used
(MD034, no-bare-urls)
581-581: Bare URL used
(MD034, no-bare-urls)
585-585: Bare URL used
(MD034, no-bare-urls)
589-589: Bare URL used
(MD034, no-bare-urls)
593-593: Bare URL used
(MD034, no-bare-urls)
597-597: Bare URL used
(MD034, no-bare-urls)
601-601: Bare URL used
(MD034, no-bare-urls)
605-605: Bare URL used
(MD034, no-bare-urls)
609-609: Bare URL used
(MD034, no-bare-urls)
613-613: Bare URL used
(MD034, no-bare-urls)
617-617: Bare URL used
(MD034, no-bare-urls)
621-621: Bare URL used
(MD034, no-bare-urls)
625-625: Bare URL used
(MD034, no-bare-urls)
629-629: Bare URL used
(MD034, no-bare-urls)
633-633: Bare URL used
(MD034, no-bare-urls)
637-637: Bare URL used
(MD034, no-bare-urls)
641-641: Bare URL used
(MD034, no-bare-urls)
645-645: Bare URL used
(MD034, no-bare-urls)
649-649: Bare URL used
(MD034, no-bare-urls)
653-653: Bare URL used
(MD034, no-bare-urls)
657-657: Bare URL used
(MD034, no-bare-urls)
661-661: Bare URL used
(MD034, no-bare-urls)
665-665: Bare URL used
(MD034, no-bare-urls)
669-669: Bare URL used
(MD034, no-bare-urls)
673-673: Bare URL used
(MD034, no-bare-urls)
677-677: Bare URL used
(MD034, no-bare-urls)
681-681: Bare URL used
(MD034, no-bare-urls)
685-685: Bare URL used
(MD034, no-bare-urls)
689-689: Bare URL used
(MD034, no-bare-urls)
693-693: Bare URL used
(MD034, no-bare-urls)
697-697: Bare URL used
(MD034, no-bare-urls)
701-701: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: call-workflow-passing-data / build (24.3.0)
🔇 Additional comments (17)
v2/book/pandocHTML.yaml (1)
242-242: Approve code changes:v2/book/examples/requiredenum.htmlexists and is referenced exactly once in pandocHTML.yaml.v2/RSCGExamplesData/GeneratorDataRec.json (1)
1362-1368: Approve code changes
JSON is valid and the new “requiredenum” ID is unique with no duplicates.v2/rscg_examples/requiredenum/src/EnumDemo/Program.cs (1)
1-27: LGTM for the demo program.Clear, readable example of switch exhaustiveness over RequiredCarTypes.
v2/rscg_examples/requiredenum/src/EnumDemo/EnumDemo.csproj (1)
5-5: Verify NuGet package availability for RequiredEnum 0.0.1
Dotnet CLI isn’t available in this environment; please rundotnet restore v2/rscg_examples/requiredenum/src/EnumDemo/EnumDemo.csprojlocally to confirm the package resolves successfully.v2/rscg_examples/requiredenum/src/EnumDemo.sln (1)
2-25: LGTM: solution and configuration blocks look correct.Project path and GUIDs resolve cleanly; Debug/Release mappings are consistent.
v2/rscg_examples_site/docs/Categories/_PrimitiveEnum.mdx (1)
23-23: LGTM: category entry added.New link follows existing numbering/style.
v2/rscg_examples_site/docs/Categories/Enum.md (2)
3-3: Count updated correctly11 items listed; count matches.
25-26: Slug verified — requiredenum.md definesslug: /requiredenum, so the link/docs/requiredenumwill resolve correctly.v2/book/list.html (2)
20-20: Header count bumped to 226 — OK
929-932: Example page inclusion verifiedrequiredenum.html exists under v2/book/examples and is listed in pandocHTML.yaml.
v2/rscg_examples_site/docs/indexRSCG.md (1)
10-10: Title updated to 226 — OKv2/rscg_examples_site/static/exports/RSCG.json (1)
1805-1812: Entry looks correct; JSON remains valid.
Name/link/category/date consistent; trailing commas handled; position after Schema OK.v2/rscg_examples_site/docs/RSCG-Examples/requiredenum.md (2)
87-87: License link likely 404s on GitHub.
Use the file path with blob/main.-RequiredEnum distributed under [MIT](https://github.com/emptycoder/RequiredEnum/LICENSE) license. +RequiredEnum is distributed under [MIT](https://github.com/emptycoder/RequiredEnum/blob/main/LICENSE) license.
125-129: Package ID consistency (requiredenum vs RequiredEnum).
NuGet ID casing and exact name differ across the page; please align to the actual package ID.- <PackageReference Include="RequiredEnum" Version="0.0.1"> + <PackageReference Include="requiredenum" Version="0.0.1">If the canonical ID is “RequiredEnum”, use that casing everywhere (badge, text, html page).
v2/rscg_examples_site/docs/RSCG-Examples/index.md (2)
3-4: Counts updated correctly.
Title/description reflect 226.
692-747: Enum category updated and graph edge added.
New item and mermaid edge look consistent with slug /docs/requiredenum.Also applies to: 1661-1662
README.md (1)
3-3: Confirm “Latest Update” synchronization
The entry “## Latest Update : 2025-08-14 => 14 August 2025” is present in README.md (line 3) and later.md (line 3). Please verify that the same date is applied on the v2 site pages and any badges.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (14)
v2/Generator/MultiGeneratorV2.cs (1)
927-931: Use camelCase for the local and map it to the template prop.Follow C# local naming and keep the template field name unchanged.
- bool HasFilesGenerated = it?.Data?.outputFiles?.HasFilesGenerated() ?? false; + bool hasFilesGenerated = it.Data?.outputFiles?.HasFilesGenerated() ?? false; ... - var output = templateScriban.Render(new {Description=it,HasFilesGenerated, otherDesc, category}, member => member.Name); + var output = templateScriban.Render(new { Description = it, HasFilesGenerated = hasFilesGenerated, otherDesc, category }, member => member.Name);v2/rscg_examples_site/docs/RSCG-Examples/requiredenum.md (13)
4-4: Polish the description for clarity.Improve grammar in front matter and About.
-description: Raise an error at compile time if not have switch handle case all enums values +description: Raise a compile-time error when a switch does not handle all enum values. ... - Raise an error at compile time if not have switch handle case all enums values + Raise a compile-time error when a switch does not handle all enum values.Also applies to: 95-95
18-18: Unify NuGet package name and links.Use consistent casing (“RequiredEnum”) and a proper markdown link; align CLI with the package ID.
-[](https://www.nuget.org/packages/requiredenum/) +[](https://www.nuget.org/packages/RequiredEnum/) ... -NuGet: -*https://www.nuget.org/packages/requiredenum/* +NuGet: [RequiredEnum](https://www.nuget.org/packages/RequiredEnum/) ... -[NuGet](https://www.nuget.org/packages/RequiredEnum/): `dotnet add package requiredenum` +[NuGet](https://www.nuget.org/packages/RequiredEnum/): `dotnet add package RequiredEnum`Also applies to: 34-36, 58-59
37-41: Avoid bare URLs; make them clickable and readable.Convert raw links to markdown links.
-You can find more details at https://github.com/emptycoder/RequiredEnum - -Source: https://github.com/emptycoder/RequiredEnum +You can find more details at [emptycoder/RequiredEnum](https://github.com/emptycoder/RequiredEnum). + +Source: [emptycoder/RequiredEnum](https://github.com/emptycoder/RequiredEnum) ... -https://ignatandrei.github.io/RSCG_Examples/v2/docs/requiredenum +[requiredenum docs](https://ignatandrei.github.io/RSCG_Examples/v2/docs/requiredenum)Also applies to: 215-216
87-87: Fix likely broken LICENSE link path.Link to LICENSE in the default branch.
-RequiredEnum distributed under [MIT](https://github.com/emptycoder/RequiredEnum/LICENSE) license. +RequiredEnum is distributed under the [MIT](https://github.com/emptycoder/RequiredEnum/blob/main/LICENSE) license.
120-122: Replace hard tabs in code block with spaces.This avoids markdownlint MD010 and renders consistently.
- <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles> - <CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)\GX</CompilerGeneratedFilesOutputPath> - </PropertyGroup> + <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles> + <CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)\GX</CompilerGeneratedFilesOutputPath> + </PropertyGroup>
138-138: Do not leak local filesystem paths in TabItem values.Use neutral identifiers; values only need to be unique within Tabs.
- <TabItem value="D:\gth\RSCG_Examples\v2\rscg_examples\requiredenum\src\EnumDemo\Program.cs" label="Program.cs" > + <TabItem value="program" label="Program.cs" > ... - <TabItem value="D:\gth\RSCG_Examples\v2\rscg_examples\requiredenum\src\EnumDemo\RequiredCarTypes.cs" label="RequiredCarTypes.cs" > + <TabItem value="requiredcarstypes" label="RequiredCarTypes.cs" >Also applies to: 173-173
194-194: Remove empty “Generated Files” heading.With the new HasFilesGenerated gating, this static heading is redundant.
-### Generated Files
197-197: Fix double space in heading.-### Download Example (.NET C#) +### Download Example (.NET C#)
201-201: Trim space inside link text.-[Download Example project requiredenum ](/sources/requiredenum.zip) +[Download example project: requiredenum](/sources/requiredenum.zip)
210-210: Minor wording: “on X (Twitter)”.- <li><a href="https://twitter.com/intent/tweet?source=https%3A%2F%2Fignatandrei.github.io%2FRSCG_Examples%2Fv2%2Fdocs%2Frequiredenum&text=requiredenum:%20https%3A%2F%2Fignatandrei.github.io%2FRSCG_Examples%2Fv2%2Fdocs%2Frequiredenum" target="_blank" title="Tweet">Share in Twitter</a></li> + <li><a href="https://twitter.com/intent/tweet?source=https%3A%2F%2Fignatandrei.github.io%2FRSCG_Examples%2Fv2%2Fdocs%2Frequiredenum&text=requiredenum:%20https%3A%2F%2Fignatandrei.github.io%2FRSCG_Examples%2Fv2%2Fdocs%2Frequiredenum" target="_blank" title="Tweet">Share on X (Twitter)</a></li>
46-46: Improve image alt text.- +
92-92: Fix heading level jump (MD001).Make “About” an h2 after the previous section.
-### About +## About
1-219: Fix NuGet package URL casing in requiredenum.md
Lines 18 & 34 link to/packages/requiredenum/— update both to/packages/RequiredEnum/No absolute TabItem
valuepaths detected.
Sidebar_position values align with repo-wide settings—no changes needed.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (1)
v2/rscg_examples_site/static/exports/RSCG.xlsxis excluded by!**/*.xlsx
📒 Files selected for processing (7)
v2/Generator/DocusaurusExample.txt(2 hunks)v2/Generator/MultiGeneratorV2.cs(1 hunks)v2/Generator/OutputFiles.cs(1 hunks)v2/rscg_examples_site/docs/RSCG-Examples/FactoryGenerator.Abstractions.md(0 hunks)v2/rscg_examples_site/docs/RSCG-Examples/JinShil.MixinSourceGenerator.md(0 hunks)v2/rscg_examples_site/docs/RSCG-Examples/Schema.md(0 hunks)v2/rscg_examples_site/docs/RSCG-Examples/requiredenum.md(1 hunks)
💤 Files with no reviewable changes (3)
- v2/rscg_examples_site/docs/RSCG-Examples/FactoryGenerator.Abstractions.md
- v2/rscg_examples_site/docs/RSCG-Examples/Schema.md
- v2/rscg_examples_site/docs/RSCG-Examples/JinShil.MixinSourceGenerator.md
🚧 Files skipped from review as they are similar to previous changes (1)
- v2/Generator/DocusaurusExample.txt
🧰 Additional context used
🧬 Code graph analysis (1)
v2/Generator/MultiGeneratorV2.cs (3)
v2/Generator/OutputFiles.cs (1)
HasFilesGenerated(42-42)v2/Generator/Data.cs (1)
Data(4-27)v2/Generator/Description.cs (1)
Description(4-32)
🪛 LanguageTool
v2/rscg_examples_site/docs/RSCG-Examples/requiredenum.md
[grammar] ~7-~7: There might be a mistake here.
Context: ...enum --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; im...
(QB_NEW_EN)
[grammar] ~8-~8: There might be a mistake here.
Context: ...'; import TabItem from '@theme/TabItem'; import TOCInline from '@theme/TOCInline'...
(QB_NEW_EN)
[grammar] ~9-~9: There might be a mistake here.
Context: ...mport TOCInline from '@theme/TOCInline'; import SameCategory from '../Categories/...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...Enum?style=social) ## Details ### Info :::info Name: requiredenum Require...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...s for switch. Author: Yaroslav NuGet: *https://www.nuget.org/packages/required...
(QB_NEW_EN)
[grammar] ~43-~43: There might be a mistake here.
Context: ...emptycoder/RequiredEnum ::: ### Author :::note Yaroslav 
[grammar] ~44-~44: There might be a mistake here.
Context: ...er/RequiredEnum ::: ### Author :::note Yaroslav 
[grammar] ~45-~45: There might be a mistake here.
Context: ...dEnum ::: ### Author :::note Yaroslav 
[grammar] ~46-~46: There might be a mistake here.
Context: ...text](https://github.com/emptycoder.png) ::: ### Original Readme :::note <h1 al...
(QB_NEW_EN)
[grammar] ~49-~49: There might be a mistake here.
Context: ...emptycoder.png) ::: ### Original Readme :::note
RequiredEnum...
(QB_NEW_EN)
[grammar] ~62-~62: There might be a mistake here.
Context: ...ect and you will get the error when one of cases weren't handle in a switch statem...
(QB_NEW_EN)
[grammar] ~92-~92: There might be a mistake here.
Context: ...dEnum/LICENSE) license. ::: ### About :::note Raise an error at compile time ...
(QB_NEW_EN)
[grammar] ~95-~95: There might be a mistake here.
Context: ... Raise an error at compile time if not have switch handle case all enums values ...
(QB_NEW_EN)
[grammar] ~194-~194: There might be a mistake here.
Context: ... ### Generated Files ## Useful ### Download Example (.NET C#) ...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
v2/rscg_examples_site/docs/RSCG-Examples/requiredenum.md
34-34: Bare URL used
(MD034, no-bare-urls)
37-37: Bare URL used
(MD034, no-bare-urls)
39-39: Bare URL used
(MD034, no-bare-urls)
92-92: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
120-120: Hard tabs
Column: 1
(MD010, no-hard-tabs)
121-121: Hard tabs
Column: 1
(MD010, no-hard-tabs)
122-122: Hard tabs
Column: 1
(MD010, no-hard-tabs)
201-201: Spaces inside link text
(MD039, no-space-in-links)
215-215: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: call-workflow-passing-data / build (24.3.0)
🔇 Additional comments (1)
v2/Generator/OutputFiles.cs (1)
42-42: Helper looks good and is null-safe.The boolean helper is concise and correctly handles nulls.
| @@ -0,0 +1,218 @@ | |||
| --- | |||
| sidebar_position: 2260 | |||
There was a problem hiding this comment.
Fix sidebar position (typo).
Should be 226, not 2260.
-sidebar_position: 2260
+sidebar_position: 226📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| sidebar_position: 2260 | |
| sidebar_position: 226 |
🤖 Prompt for AI Agents
In v2/rscg_examples_site/docs/RSCG-Examples/requiredenum.md around line 2, the
frontmatter value sidebar_position is set to 2260 by typo; change it to 226 so
the sidebar ordering is correct.
Summary by CodeRabbit
New Features
Documentation
Bug Fixes