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

ReporterType marked as internal necessary? #313

Closed
StylianosGakis opened this issue Feb 10, 2023 · 2 comments
Closed

ReporterType marked as internal necessary? #313

StylianosGakis opened this issue Feb 10, 2023 · 2 comments

Comments

@StylianosGakis
Copy link

In version 3.11 I was using the ReporterType type in order to easily reference the reporter I was interested in by doing this https://github.com/HedvigInsurance/android/blob/ee08122b0534cc51c185bd55d99742776ccb6dfe/build-logic/convention/src/main/kotlin/KtlintConventionPlugin.kt#L22
Now it's marked as internal and I have to use a String, which is a tiny bit more prone to error. I mean of course in my case I will just replace it with the "checkstyle" string, but I thought it was a convenient way to do this without fearing that if the name changes or something like that in the future I will get an error in my build since it won't be able to reference the org.jmailen.gradle.kotlinter.support.ReporterType anymore.
Was this marked as internal for a specific purpose, or just due to not wanting to make any public API guarantees on it?

@jeremymailen
Copy link
Owner

I don't think we're intentionally trying to hide it, was probably more code hygiene given it wasn't used in the plugin outside that scope.

@StylianosGakis
Copy link
Author

Yeah I understand. Do you think my use-case makes sense for it to be public again in some future release? I reverted to using the string directly for now, but I am gonna admit I did like having the type there. Now it looks like this which I feel like is a downgrade.
No problem if you don't feel like changing it back though, just sharing my use case.

jeremymailen added a commit that referenced this issue Mar 14, 2023
- Fix issue #316 by upgrading kotlinter gradle's released version to ktlint 0.48.2.
- Remove configuration for `disabledRules` and `experimentalRules` to fully delegate this to .editorconfig
- Fix issue with resolution of rule enable / disable statements in .editorconfig
- Address issue #242 by providing readme example of excluding source files at the project tree level
- Address issue #314 by including sources in published artifacts
- Fix issue #313 by exporting `ReporterType`
- Address issue #315 by logging format log statements at level `WARNING` so they can be hidden
- Credit @mateuszkwiecinski as one of the developers of the plugin
jeremymailen added a commit that referenced this issue Mar 14, 2023
- Fix issue #316 by upgrading kotlinter gradle's released version to ktlint 0.48.2.
- Remove configuration for `disabledRules` and `experimentalRules` to fully delegate this to .editorconfig
- Fix issue with resolution of rule enable / disable statements in .editorconfig
- Address issue #242 by providing readme example of excluding source files at the project tree level
- Address issue #314 by including sources in published artifacts
- Fix issue #313 by exporting `ReporterType`
- Address issue #315 by logging format log statements at level `WARNING` so they can be hidden
- Credit @mateuszkwiecinski as one of the developers of the plugin
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

No branches or pull requests

2 participants