fix: refactor projectgraphgenerator to expose read-only graph results - #462
Merged
cdsap merged 1 commit intoSep 12, 2026
Merged
Conversation
cdsap
deleted the
issue/459-hermes-refactor-projectgraphgenerator-to-ex-a1
branch
September 12, 2026 22:25
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.
Summary
Problem
ProjectGraphGenerator.generate() returns MutableList at project-generator/src/main/kotlin/io/github/cdsap/projectgenerator/ProjectGraphGenerator.kt:16, although callers only read the generated graph and ProjectGraph itself is immutable.
Why this matters
The mutable return type leaks construction details across the domain boundary and permits callers to alter generated graph state after creation, increasing coupling and making behavior harder to reason about.
Proposed change
Change generate() to return List while retaining a private mutable accumulator during construction. Add or update a focused test documenting that the generated graph is consumed as a read-only result.
Notes
This clarifies the domain boundary: graph construction remains internally mutable, while the generated graph is returned as an immutable domain result. Because the library is published, review downstream source compatibility before applying the signature change.
Fixes #459
Changes
project-generator/src/main/kotlin/io/github/cdsap/projectgenerator/ProjectGraphGenerator.ktproject-generator/src/test/kotlin/io/github/cdsap/projectgenerator/ProjectGraphGeneratorTest.ktVerification
./gradlew :project-generator:unitTest./gradlew :cli:test./gradlew ktlintCheck