feat: [FC-0072] Static code analyzer

[PavloNetrebchuk]

This PR integrates Detekt into the project to enhance Kotlin code quality through static analysis. Additionally, it addresses and resolves all existing Detekt warnings to ensure the codebase adheres to best practices and coding standards.

Changes Made

1. Detekt Integration:
   • Added Detekt Configuration:
   • Included a detekt.yml configuration file tailored to the project’s coding standards.
   • Configured Detekt rules to align with team guidelines and project requirements.
   • Build Integration:
   • Integrated Detekt into the Gradle build process using the Detekt Gradle plugin.
   • Updated build.gradle to include Detekt tasks for analysis.
2. Fixing Detekt Warnings:
   • Code Refactoring:
   • Resolved 1500 warnings related to code style, such as naming conventions, formatting issues, and unnecessary complexity.
   • Addressed potential bugs highlighted by Detekt, including unused variables, nullable types handling, and redundant code.
   • Performance Improvements:
   • Optimized functions and removed inefficient code patterns flagged by Detekt.

Motivation

Integrating Detekt ensures continuous monitoring of code quality, promotes consistency across the codebase, and helps in early detection of potential issues. By resolving existing warnings, we establish a clean foundation for future development, making the code more maintainable and less error-prone.

How to Test

1. Local Verification:
   • Run Detekt locally using ./gradlew detektAll to ensure no warnings are present.
   • Review the Detekt report to verify all issues have been addressed.
2. CI Pipeline:
   • Ensure that the CI pipeline runs Detekt checks and fails the build if new warnings are introduced.
3. Code Review:
   • Review the refactored code to confirm that functionality remains intact and improvements align with project standards.

[openedx-webhooks]

Thanks for the pull request, @PavloNetrebchuk!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/openedx-mobile-maintainers. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[github-advanced-security]

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.