One thing that I have noticed in general for our pekko projects is that due
to generally renaming our package from akka to org.apache.pekko this also
happened to the package statements to Scala source files within the
project. There are a few points to make on this

- The use of packages within Scala source files is not entirely consistent,
i.e. compare
https://github.com/apache/incubator-pekko-projection/blob/main/project/AddMetaInfLicenseFiles.scala
to
https://github.com/apache/incubator-pekko-projection/blob/main/project/Dependencies.scala
- Since we are dealing with the sbt build, the packages here are entirely
redundant/irrelevant when it comes to actual artifact (i.e. maven jar)
releases.
- Although a minor nitpick, there is an argument that the package names
also add more boilerplate than necessary to the core build.sbt
- The current usage of package names (specifically when org.apache.pekko is
used within a project) does not correspond to the project structure. If we
want to follow convention then technically speaking the source folders
should be placed under org / apache / pekko however similar to the previous
point this can also add unnecessary "noise".

Considering these points, what do people think is the best course of action
here? We have 3 options (aside from sticking with the status quo).
- Don't use packages at all. This would remove boilerplate from build.sbt
and also means we don't need to change the directory structure.
- Use pekko package. This would be closer to the beforehand akka codebase
however it would also be inconsistent with the rest of the pekko sources
(which need to legitimately use org.apache.pekko since they will be in the
artifact release) and if we want to follow package/dir convention then we
should place those sources in pekko subdir.
- Use org.apache.pekko package. This is largely what we use now (as pointed
out before there are some inconsistencies) however as mentioned before
there is a bit of a boilerplate and following package/dir convention would
mean deeply nesting the sources into 3 folders.

Thoughts?


-- 

Matthew de Detrich

*Aiven Deutschland GmbH*

Immanuelkirchstraße 26, 10405 Berlin

Amtsgericht Charlottenburg, HRB 209739 B

Geschäftsführer: Oskari Saarenmaa & Hannu Valtonen

*m:* +491603708037

*w:* aiven.io *e:* [email protected]

Reply via email to