Refactor package structure

fd4s / fs2-kafka

Functional Kafka Streams for Scala

https://fd4s.github.io/fs2-kafka

Apache License 2.0

295 stars 100 forks source link

Refactor package structure #492

Open bplommer opened 3 years ago

bplommer commented 3 years ago

Following the creation of the consumer package for the traits that make up KafkaConsumer, I suggest we move things into consumer, producer, producer.transactional and adminclient packages.

In future, we can consider putting these in separate modules

To keep binary compatibility in 1.x we can move the files but keep the current package declarations, create aliases in the new packages, and deprecate the non-aliased versions. Then for 2.0 we can complete the change.

bplommer commented 3 years ago

I tried aliasing the packages and it didn't work very well - instead I suggest we move the files without aliasing in 1.x, and then rename them for 2.x but create ScalaFix rules to assist the migration.