Skip to content

Conversation

@abdulraqeeb33
Copy link
Contributor

@abdulraqeeb33 abdulraqeeb33 commented Oct 9, 2025

Description

One Line Summary

Integrating detekt into the project

Details

Motivation

Adding Detekt improves code quality and consistency by automatically detecting potential issues and enforcing style guidelines in Kotlin projects.
I will be creating a follow up PR that will basically add detekt as a step in the github action.

Scope

Mostly used for internal purposes. Each module has its own baseline. And all modules share a common detekt config.
As we continue working on this codebase, we will use these rules to block the PR.

Testing

Unit testing

No impact

Manual testing

Tested

Affected code checklist

  • Notifications
    • Display
    • Open
    • Push Processing
    • Confirm Deliveries
  • Outcomes
  • Sessions
  • In-App Messaging
  • REST API requests
  • Public API changes

Checklist

Overview

  • I have filled out all REQUIRED sections above
  • PR does one thing
    • If it is hard to explain how any codes changes are related to each other then it most likely needs to be more than one PR
  • Any Public API changes are explained in the PR details and conform to existing APIs

Testing

  • I have included test coverage for these changes, or explained why they are not needed
  • All automated tests pass, or I explained why that is not possible
  • I have personally tested this on my device, or explained why that is not possible

Final pass

  • Code is as readable as possible.
    • Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code.
  • I have reviewed this PR myself, ensuring it meets each checklist item
    • WIP (Work In Progress) is ok, but explain what is still in progress and what you would like feedback on. Start the PR title with "WIP" to indicate this.

This change is Reviewable

@abdulraqeeb33 abdulraqeeb33 marked this pull request as ready for review October 9, 2025 15:28
@abdulraqeeb33 abdulraqeeb33 requested review from a team and jkasten2 October 9, 2025 17:10
@abdulraqeeb33 abdulraqeeb33 self-assigned this Oct 9, 2025

}

subprojects {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this part will ignore the test files and as it doesnt make sense to run detekt on tests.

ignoreAnnotated: ["Inject"]

UnsafeCallOnNullableType:
active: true
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will help us with catching usage of !!

ignoreNamedArgument: true

MaxLineLength:
active: false
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

disabled it here as spotless is able to do the same check

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants