search

arkivanov / Essenty

The most essential libraries for Kotlin Multiplatform development
Apache License 2.0
468 stars 15 forks source link

Added experimental annotations #173

Closed arkivanov closed 3 weeks ago

arkivanov commented 3 weeks ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The updates introduce ExperimentalInstanceKeeperApi and ExperimentalStateKeeperApi annotations to mark experimental APIs within the Essenty library, signaling that these APIs can be subject to changes or removal. These annotations replace the previous ExperimentalEssentyApi annotations across multiple files, ensuring a more context-specific approach to denoting experimental functionality.

Changes

Files/Paths Change Summaries
instance-keeper/src/.../ExperimentalInstanceKeeperApi.kt Introduced ExperimentalInstanceKeeperApi annotation class.
instance-keeper/src/.../InstanceKeeperExt.kt Replaced @ExperimentalEssentyApi with @ExperimentalInstanceKeeperApi in several functions.
state-keeper/src/.../ExperimentalStateKeeperApi.kt Added ExperimentalStateKeeperApi annotation class.
state-keeper/src/.../PolymorphicSerializer.kt Replaced @ExperimentalEssentyApi with @ExperimentalStateKeeperApi.
state-keeper/src/.../StateKeeperExt.kt Replaced @ExperimentalEssentyApi with @ExperimentalStateKeeperApi in multiple functions.
state-keeper/src/.../PolymorphicSerializerTest.kt Updated @OptIn annotation from ExperimentalEssentyApi to ExperimentalStateKeeperApi.
instance-keeper/api/.../instance-keeper.api, instance-keeper/api/.../instance-keeper.klib.api, instance-keeper/api/.../jvm/instance-keeper.api Added ExperimentalInstanceKeeperApi annotation class.
state-keeper/api/.../state-keeper.api, state-keeper/api/.../state-keeper.klib.api, state-keeper/api/.../jvm/state-keeper.api Added ExperimentalStateKeeperApi annotation class and modified the polymorphicSerializer function signature.
state-keeper/src/.../StateKeeperExtTest.kt Updated @OptIn annotation from ExperimentalEssentyApi to ExperimentalStateKeeperApi.

Poem

In Essenty's land of code so bright,
New annotations come to light.
Experimental APIs, heed the call,
For they may change or even fall.
Keeper of instances, state serene,
Embrace the future, sight unseen.
🌟 Rabbit's joy, in code we trust,
Building wisely, adjust we must. 🐰✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.