arthurpalves/coherent-swift

Naming discussion

timstudt opened this issue · 2 comments

Wouldn't it be better to call it swift-coherent or swift-cohesion?
since the most popular Swift language tools all start with swift like SwiftLint swiftformat swift-doc, it would be more aligned and most likely easier to memorise to name CLI cmd swift-cohesion.
Plus Swift supports extensible subcommands on CLI: For swift cohesion Swift would automatically look up cmd swift-cohesion.

Initially, coherent-swift was chosen due to the possibility to add coherent-kotlin for example, maintaining all options as coherent-{language}.

I do agree with the benefits you mention, but for a change like this I'd like to first investigate how we can safely make the transition.

The option that comes to mind now is to rename this repository and its CLI with a 6.0 release (in order to preserve history) while simultaneously creating a new repository with the current/old name and a 5.10 release that should deprecate coherent-swift in favour of swift-cohesion.

For this I'd very much like to have unit tests in place and a fully automated release process, to ease this transition/deprecation. Also take this as an opportunity to provide proper documentation and contribution guidelines.

The immediate actions are to create these items and prioritise the work.

I'll draft some of these items this week, given some free time I have.

totally agree, there are pros and cons in both naming and that it's a bigger task. I just wanted to kick-off discussing it..

makes sense to make it a major release (6.0), and have a higher test coverage.