Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup detekt #17

Closed
wants to merge 28 commits into from
Closed

Setup detekt #17

wants to merge 28 commits into from

Conversation

eldcn
Copy link
Contributor

@eldcn eldcn commented May 26, 2024

Name of the PR

♻️ Current situation & Problem

Link any open issues or pull requests (PRs) related to this PR. Please ensure that all non-trivial PRs are first tracked and discussed in an existing GitHub issue or discussion.

⚙️ Release Notes

Add a bullet point list summary of the feature and possible migration guides if this is a breaking change so this section can be added to the release notes.
Include code snippets that provide examples of the feature implemented or links to the documentation if it appends or changes the public interface.

📚 Documentation

Please ensure that you properly document any additions in conformance to Spezi Documentation Guide.
You can use this section to describe your solution, but we encourage contributors to document your reasoning and changes using in-line documentation.

✅ Testing

Please ensure that the PR meets the testing requirements set by CodeCov and that new functionality is appropriately tested.
This section describes important information about the tests and why some elements might not be testable.

📝 Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

@@ -22,6 +22,8 @@ import kotlinx.coroutines.SupervisorJob
@InstallIn(SingletonComponent::class)
class CoroutinesModule {

val _thisShouldVariableNamingAndMagicNumber = 12345

Choose a reason for hiding this comment

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

⚠️ [detekt] <detekt.VariableNaming> reported by reviewdog 🐶
Variable names should match the pattern: [a-z][A-Za-z0-9]*

@@ -22,6 +22,8 @@ import kotlinx.coroutines.SupervisorJob
@InstallIn(SingletonComponent::class)
class CoroutinesModule {

val _thisShouldVariableNamingAndMagicNumber = 12345

Choose a reason for hiding this comment

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

⚠️ [detekt] <detekt.MagicNumber> reported by reviewdog 🐶
This expression contains a magic number. Consider defining it to a well named constant.

@@ -22,6 +22,11 @@ import kotlinx.coroutines.SupervisorJob
@InstallIn(SingletonComponent::class)
class CoroutinesModule {


Choose a reason for hiding this comment

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

⚠️ [detekt] <detekt.NoConsecutiveBlankLines> reported by reviewdog 🐶
Needless blank line(s)




val _thisShouldFaileWithVariableNamingMagicNumberIndentationEmptyLine = 12345

Choose a reason for hiding this comment

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

⚠️ [detekt] <detekt.NoMultipleSpaces> reported by reviewdog 🐶
Unnecessary long whitespace




val _thisShouldFaileWithVariableNamingMagicNumberIndentationEmptyLine = 12345

Choose a reason for hiding this comment

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

⚠️ [detekt] <detekt.VariableNaming> reported by reviewdog 🐶
Variable names should match the pattern: [a-z][A-Za-z0-9]*




val _thisShouldFaileWithVariableNamingMagicNumberIndentationEmptyLine = 12345

Choose a reason for hiding this comment

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

⚠️ [detekt] <detekt.MagicNumber> reported by reviewdog 🐶
This expression contains a magic number. Consider defining it to a well named constant.

@eldcn eldcn marked this pull request as draft May 27, 2024 03:07




Choose a reason for hiding this comment

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

⚠️ [detekt] <detekt.NoTrailingSpaces> reported by reviewdog 🐶
Trailing space(s)


val _thisShouldFaileWithVariableNamingMagicNumberIndentationEmptyLine = 12345


Choose a reason for hiding this comment

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

⚠️ [detekt] <detekt.NoConsecutiveBlankLines> reported by reviewdog 🐶
Needless blank line(s)

/**
* Hilt module for binding the implementation of [DispatchersProvider] to its interface.
*/
@Module
@InstallIn(SingletonComponent::class)


Choose a reason for hiding this comment

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

⚠️ [detekt] <detekt.NoConsecutiveBlankLines> reported by reviewdog 🐶
Needless blank line(s)




val _thisShouldFaileWithVariableNsdamingMagicNumberIndentationEmptyLine = 12345

Choose a reason for hiding this comment

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

⚠️ [detekt] <detekt.NoMultipleSpaces> reported by reviewdog 🐶
Unnecessary long whitespace




val _thisShouldFaileWithVariableNsdamingMagicNumberIndentationEmptyLine = 12345

Choose a reason for hiding this comment

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

⚠️ [detekt] <detekt.VariableNaming> reported by reviewdog 🐶
Variable names should match the pattern: [a-z][A-Za-z0-9]*




val _thisShouldFaileWithVariableNsdamingMagicNumberIndentationEmptyLine = 12345

Choose a reason for hiding this comment

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

⚠️ [detekt] <detekt.MagicNumber> reported by reviewdog 🐶
This expression contains a magic number. Consider defining it to a well named constant.



// FIXME: Should cause NoConsecutiveBlankLines, ForbiddenComment, VariableNaming, NoMultipleSpaces, MagicNumber
val _thisShouldFailSeveralWarnings = 123

Choose a reason for hiding this comment

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

⚠️ [detekt] <detekt.NoMultipleSpaces> reported by reviewdog 🐶
Unnecessary long whitespace



// FIXME: Should cause NoConsecutiveBlankLines, ForbiddenComment, VariableNaming, NoMultipleSpaces, MagicNumber
val _thisShouldFailSeveralWarnings = 123

Choose a reason for hiding this comment

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

⚠️ [detekt] <detekt.VariableNaming> reported by reviewdog 🐶
Variable names should match the pattern: [a-z][A-Za-z0-9]*

@@ -22,11 +22,17 @@ import kotlinx.coroutines.SupervisorJob
@InstallIn(SingletonComponent::class)
class CoroutinesModule {



// FIXME: Should cause NoConsecutiveBlankLines, ForbiddenComment, VariableNaming, NoMultipleSpaces, MagicNumber

Choose a reason for hiding this comment

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

⚠️ [detekt] <detekt.ForbiddenComment> reported by reviewdog 🐶
This comment contains 'FIXME:' that has been defined as forbidden.



// FIXME: Should cause NoConsecutiveBlankLines, ForbiddenComment, VariableNaming, NoMultipleSpaces, MagicNumber
val _thisShouldFailSeveralWarnings = 123

Choose a reason for hiding this comment

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

⚠️ [detekt] <detekt.MagicNumber> reported by reviewdog 🐶
This expression contains a magic number. Consider defining it to a well named constant.

@eldcn eldcn closed this May 28, 2024
@eldcn eldcn mentioned this pull request May 28, 2024
1 task
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.

1 participant