feat(generators): Add Singleton pattern generator#107
Merged
JerrettDavis merged 7 commits intomainfrom Feb 6, 2026
Merged
Conversation
- Add [Singleton] attribute with Mode (Eager/Lazy) and Threading options - Add [SingletonFactory] for custom factory methods - Implement PKSNG001-006 diagnostics per spec - Support partial class and partial record class
- Eager singleton returns same instance - Lazy thread-safe singleton using Lazy<T> - Custom factory method support - All diagnostic scenarios (PKSNG001-006)
- Overview, attributes, diagnostics - Examples for eager/lazy/factory patterns - Best practices and troubleshooting
- AppClock: eager singleton for consistent time source - ConfigManager: lazy singleton with custom factory - ServiceRegistry: thread-safe service locator pattern - Comprehensive tests for all examples
github-actions
bot
added
area: documentation
area: tests
area: generators
area: examples
labels
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Contributor
Test Results337 tests 337 ✅ 2m 9s ⏱️ Results for commit ccb7756. ♻️ This comment has been updated with latest results. |
Contributor
🔍 PR Validation ResultsVersion: `` ✅ Validation Steps
📊 ArtifactsDry-run artifacts have been uploaded and will be available for 7 days. This comment was automatically generated by the PR validation workflow. |
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #107 +/- ##
==========================================
+ Coverage 82.52% 87.55% +5.03%
==========================================
Files 175 180 +5
Lines 16706 17018 +312
Branches 2366 2407 +41
==========================================
+ Hits 13786 14900 +1114
+ Misses 2291 2118 -173
+ Partials 629 0 -629
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new Singleton pattern source generator to PatternKit, including the public attribute surface area, diagnostics registration, documentation, and example/demo coverage as described in issue #32.
Changes:
- Implemented
SingletonGeneratorwith eager/lazy modes, threading options, optional factory method support, and the six specified diagnostics. - Added generator tests plus a demo project (and demo tests) showcasing typical singleton use cases.
- Added end-user documentation for the singleton generator and updated analyzer release notes.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| test/PatternKit.Generators.Tests/SingletonGeneratorTests.cs | Adds generator-focused tests for singleton codegen and diagnostics scenarios. |
| test/PatternKit.Examples.Tests/SingletonGeneratorDemo/SingletonGeneratorDemoTests.cs | Adds runtime tests covering the demo singletons’ behavior. |
| src/PatternKit.Generators/Singleton/SingletonGenerator.cs | Implements the incremental source generator and diagnostics for Singleton. |
| src/PatternKit.Generators/AnalyzerReleases.Unshipped.md | Registers the new PKSNG00x diagnostics in analyzer release notes. |
| src/PatternKit.Generators.Abstractions/Singleton/SingletonAttributes.cs | Adds [Singleton], [SingletonFactory], and associated enums in the public abstractions assembly. |
| src/PatternKit.Examples/SingletonGeneratorDemo/ServiceRegistry.cs | Adds a thread-safe lazy singleton demo using a small service registry. |
| src/PatternKit.Examples/SingletonGeneratorDemo/ConfigManager.cs | Adds a lazy singleton demo using a [SingletonFactory] for configuration loading. |
| src/PatternKit.Examples/SingletonGeneratorDemo/AppClock.cs | Adds an eager singleton demo for a clock/time source. |
| docs/generators/singleton.md | Adds documentation describing usage, options, and diagnostics for the singleton generator. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
test/PatternKit.Examples.Tests/SingletonGeneratorDemo/SingletonGeneratorDemoTests.cs
Outdated
Show resolved
Hide resolved
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 7 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Add PKSNG007-009 diagnostics to AnalyzerReleases.Unshipped.md - Add PKSNG007-009 to singleton.md documentation diagnostics table - IsValidCSharpIdentifier: Reject reserved keywords (unless @-prefixed) - HasNameConflict: Check inherited members by walking base types - FindFactoryMethods: Exclude generic methods (TypeParameters.Length == 0) - HasPublicConstructor: Detect implicit public constructors - Add tests for all new validation logic - Add XML doc to thread-safe test explaining runtime tests are in demo
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 7 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
test/PatternKit.Examples.Tests/SingletonGeneratorDemo/SingletonGeneratorDemoTests.cs
Outdated
Show resolved
Hide resolved
Contributor
Code Coverage |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #32
Summary
Implements the Singleton pattern source generator as specified in issue #32.
Changes
Generator Implementation (src/PatternKit.Generators/Singleton/)
Tests ( est/PatternKit.Generators.Tests/)
Documentation (docs/generators/singleton.md)
Demo (src/PatternKit.Examples/SingletonGeneratorDemo/)
Validation