Closed imahmedismail closed 2 months ago
LGTM
Once the changes have been made @imahmedismail Could you resolve the conflicts, I merged other PR
This update enhances the Kinde SDK with improved module documentation for clarity and usability, consistent naming conventions, and type specifications to boost code readability. Several modules had their documentation disabled to streamline visibility. New utility functions were added to support OAuth2 flows, and two development dependencies were introduced to enhance code quality and analysis.
Files | Change Summary |
---|---|
lib/kinde_sdk/kinde_cache.ex |
Added comprehensive documentation for KindeSDK.KindeCache module. |
lib/kinde_sdk/kinde_client_sdk.ex |
Renamed attributes to snake case; added a new type definition; refactored get_token function. |
lib/kinde_sdk/model/*.ex |
Changed @moduledoc to false for multiple modules, disabling their documentation. |
lib/kinde_sdk/sdk/*.ex |
Added detailed module documentation for AuthorizationCode , ClientCredentials , and Pkce . |
lib/kinde_sdk/sdk/utils.ex |
Introduced new utility functions for OAuth2 tasks and enhanced existing ones. |
mix.exs |
Added credo and dialyxir dependencies for improved code quality. |
test/client_test_helper.exs |
Refactored JWT payload handling logic for clarity; improved readability of numeric literals. |
test/kinde_client_sdk_test.exs |
Reformatted numeric literals for readability without altering test behavior. |
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?
All changes are as per description given in explanation of PR.
I've added 2 most important packages i.e. credo and dialyxir - which pointed out many of the issues in the code. I've fixed most of them but few are still remaining, which can either be done by me or maybe other developers working on it. Alongwith that I've also added the module, function docs to Utils module.
Note: This is an open-source contribution