Big rewrite to make it distinct from SwiftUI Environment Values #22
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR performs a comprehensive rewrite of the global environment management system in SwiftEnvironment by replacing the old SwiftUI-based EnvironmentValues with a new GlobalValues structure and updating the related API, macros, tests, and documentation. Key changes include:
- Replacing EnvironmentValues references with GlobalValues in tests, property wrappers, and extensions.
- Introducing the @globalentry macro and its compiler plugin for defining global entries.
- Cleaning up deprecated files and updating the README to reflect new usage and dependency versions.
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| Tests/SwiftEnvironmentTests/IntegrationTests.swift | Updated tests to utilize GlobalValues instead of EnvironmentValues. |
| Tests/SwiftEnvironmentTests/DummyDependency.swift | Shifted from EnvironmentValues to GlobalValues for dummy dependency setup. |
| Sources/SwiftEnvironmentMacro/* | Added new macro plugin and associated error/expansion logic. |
| Sources/SwiftEnvironment/GlobalValues.swift | Introduced GlobalValues structure to manage global state. |
| Sources/SwiftEnvironment/Environment/GlobalEnvironment.swift | Updated property wrapper to work with GlobalValues. |
| README.md | Updated documentation to reflect API changes and new installation steps. |
| Package.swift | Added swift-syntax dependency and updated dependency versions. |
Comments suppressed due to low confidence (1)
README.md:68
- The reference 'GlobalValue.myValue' appears to be a naming inconsistency. It likely should be 'GlobalValues.myValue' to match the new API conventions.
let value = GlobalValue.myValue
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request introduces significant changes to the
SwiftEnvironmentlibrary, focusing on refactoring its global environment management system. The changes include replacingEnvironmentValueswith a newGlobalValuesstructure, updating documentation to reflect the new design, and removing deprecated files. These updates aim to simplify the codebase, enhance flexibility, and improve clarity in managing global environment values.Refactoring Global Environment Management:
GlobalValues: Added a newGlobalValuesstructure to replace theSwiftEnvironmentValuesclass. This structure introduces methods for managing singleton, transient, and weak global values, along with support for dynamic member lookup and publishers for observing changes. (Sources/SwiftEnvironment/Environment/GlobalValues.swift)GlobalEnvironmentProperty Wrapper: Updated theGlobalEnvironmentproperty wrapper to useGlobalValuesinstead ofEnvironmentValues. This change simplifies value resolution and observation logic. (Sources/SwiftEnvironment/Environment/GlobalEnvironment.swift) [1] [2]Documentation Updates:
README.md: Revised the documentation to reflect the newGlobalValuesstructure and its usage. Added sections on defining, accessing, and setting global values, along with advanced options like transient values and weak references. (README.md) [1] [2]Code Cleanup and Removal:
SwiftEnvironmentValuesimplementation (SwiftEnvironmentValues.swift,EnvironmentSource.swift,SwiftUIEnvironment+Extensions.swift) to streamline the codebase. (Sources/SwiftEnvironment/GlobalEnvironment/SwiftEnvironmentValues.swift) [1] (Sources/SwiftEnvironment/GlobalEnvironment/EnvironmentSource.swift) [2] (Sources/SwiftEnvironment/Extensions/SwiftUIEnvironment+Extensions.swift) [3]Dependency Updates:
swift-syntaxDependency: UpdatedPackage.swiftto include theswift-syntaxpackage for macro support, enabling the new@GlobalEntrymacro functionality. (Package.swift) [1] [2]