Proposal - use normalized group/project names

[michalstutzmann]

@azolotko thanks for the great work here! The plugin works like a charm (also the latest fix works with SBT 1.7.x).

I would like to propose a little usability improvement. Maybe we don't have to always use group/project IDs but just the normalized GitLab project/group names.

What if we added the following settings:

val gitlabGroupId = settingKey[Option[GitlabGroupId]](
  "GitLab group ID"
)

val gitlabNormalizedGroupName = settingKey[String](
  "GitLab normalized group name"
)

val gitlabNormalizedProjectName = settingKey[String](
  "GitLab normalized project name"
)

And then in the project settings provide some defaults:

gitlabNormalizedGroupName := organizationName.value, // TODO: should be also normalized here
gitlabNormalizedProjectName := normalizedName.value

This part then could be default as well:

gitlabRepositories ++= Seq(
  GitlabProjectRepository(gitlabDomain.value, gitlabProjectId.value.getOrElse(GitlabProjectId(gitlabNormalizedProjectName.value))),
  GitlabGroupRepository(gitlabDomain.value, gitlabGroupId.value.getOrElse(GitlabGroupId(gitlabNormalizedGroupName.value)))
),

User input would reduce to this in non-default case:

gitlabNormalizedGroupName := "group-xxx",
gitlabNormalizedProjectName := "project-xxx"

Have tested that on my side, can provide a PR if you like it.

[azolotko]

@michalstutzmann thank you so much for the proposal!

gitlabNormalizedProjectName := normalizedName.value makes total sense to me as a default.

I'm less sure about gitlabNormalizedGroupName := organizationName.value though. In my limited experience with GitLab, I've never seen this naming pattern before. Group names never matched organizationName (in any form): they were either product names or team names.

[michalstutzmann]

@azolotko agree with your point regarding the organizationName.

There's also an alternative using scmInfo setting, but not all projects have to have it defined. For those using sbt-git scmInfo is filled automatically: sbt/sbt-git#113 .

Provided:

    val gitlabNormalizedGroupName = settingKey[Option[String]](
  "GitLab normalized group name"
    )
    
    val gitlabNormalizedProjectName = settingKey[Option[String]](
      "GitLab normalized project name"
    )

Depend on the standard SBT's scmInfo setting:

    import java.nio.file.Paths
    gitlabNormalizedGroupName := scmInfo.value.map(value => Paths.get(value.browseUrl.getPath).getParent.toString),
    gitlabNormalizedProjectName := scmInfo.value.map(value => Paths.get(value.browseUrl.getPath).getFileName.toString.stripSuffix(".git"))

[azolotko]

I think the most convenient alternative would be if the plugin just took info from git itself. Getting ids (or names) from a remote URL should be fairly straightforward. At least when there's only one git remote.