Copyright header rule for Kotlin files - #1515

[dector]

🚧 Draft

[dector]

Added location property to config. Do you think it's a way to go or should I explore other solutions?

[arturbosch]

I like the location idea.
It brings to me the idea that we can use the Config as a "data container", storing/caching additional information before actually performing the run (HashMap).
The hard part is that the additional information step is rule dependant.
So basically we need to have a new method for Rule like initData(config: Config) which runs once before the visiting process of the KtFile's.
For this we need to call initData in the core module in the main thread.
This sounds like a generic way for rules to cache data between KtFile's.

[dector]

Glad that you've liked that.

This sounds like a generic way for rules to cache data between KtFile's.

Sounds awesome! Will explore it. Probably, I'll not have enough time in next 10 days, but will try to find short time-frames.

[dector]

Sorry for the delay. 😅

Let me double check your suggestions:

• Should Config serve a purpose of data cache for rules? I'm not sure that it's a very good idea as it'll bloat responsibilities for the class. Besides that what should be do with other config implementations (CompositeConfig and Rule itself as it's extending ConfigAware that is extending Config)?
• Do you mean that rule.initData() should be invoked somewhere in Detektor.run() (or runSync/runAsync). If I get it right, we'll need to build rule sets once more for this. Is that a lightweight operation?

Thanks!

[schalkms]

Sorry for the late answer @dector
We'd really like to merge this rule because it provides good value to detekt.

• ping @arturbosch

[arturbosch]

I've rebased on top of master and implemented a way to share the cache license header for this rule.
However I can't push my changes to this PR for whatever reasons...

Normally I check out the fork of a contributor, do some changes and can push them back to this branch. Maybe this time I'm not allowed to do this because it is a draft or something?

[BraisGabin]

That's a permission that the author of the PR can give when the PR is created

[arturbosch]

@dector please allow me to push to this branch :)

[dector]

@arturbosch Hm.. "Edits from maintainers" are enabled for this PR. Let me undraft it.

[arturbosch]

Unfortunately I couldn't push into this PR and created a new PR with the caching changes on top of your commits ... :(