typelevel/typelevel.g8

A typelevel.g8 based on sbt-typelevel

A Giter8 template for sbt-typelevel!

sbt new typelevel/typelevel.g8

Features

• sbt-typelevel and all its goodies
• sbt-typelevel-site
• Nix Flake using typelevel-nix
• Basic .gitignore
• Scala code of conduct

Template license

Written in 2022 by @valencik

To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this template to the public domain worldwide. This template is distributed without any warranty. See http://creativecommons.org/publicdomain/zero/1.0/.

typelevel.g8's Issues

Steward not updating Scala versions in default.properties

Basically a sub issue of #105
We still don't have default.properties working correctly.

Scalafix integration

Opt-in scalafix support is available in sbt-typelevel 0.4.10. I think organize imports is a great addition to the base template :)

Allow license selection during creation

Right now the template emits apache license for you; it would be better to ask the user what license they want

Notes from live demo

• Perhaps add instructions about needing to git init and create a commit
• Can we pull name info from git config?

Consider adding a CHANGELOG boilerplate

I've used the Keep a changelog format in a few projects now and I'm a fan of it, perhaps we could add this to typelevel.g8 as well?

Add to Scala Steward

scala-steward-org/repos#993

Rename to just 'typelevel.g8'

We should drop the 'proto-' prefix now that this has been accepted in typelevel/governance#39

Right? cc. @armanbilge @rossabaker

Add Dependencies to outer build.sbt

Looks like Scala Steward will only update the inner template dependencies if they are also added to the outside build.sbt

https://github.com/scala-steward-org/scala-steward/blob/main/docs/faq.md#can-scala-steward-update-dependencies-in-giter8-templates-

I don’t think Scala Steward will update anything in default.properties

Investigate post-update hook to automatically regenerate the inner workflow

Issue encountered in #27

Steward not updating libs and default.properties

Our Steward is still running but not updating our build.sbt dependencies or our default.properties files.

Perhaps broken in fe46ccc

Add a `.scalafmt.conf`

We can populate it with some defaults or just leave it empty. But since sbt-typelevel enables sbt-scalafmt I think it requires it to be present.

Relationship to ce3.g8

I forgot we also had this: https://github.com/typelevel/ce3.g8

Do we need both? Are there any ideas that should come from one to the other? /cc @kubukoz

What to do about Scala 3.4?

I think the recommended path forward is that libraries continue publishing for 3.3, and 3.4+ would be yet another cross version.
So we don't want to merge this as is. But perhaps we want to add an option to additionally compile against 3.4?

Originally posted by @valencik in #131 (comment)

flake.lock questions

When a user generates a template and uses the provided flake.nix via nix develop (see https://github.com/typelevel/typelevel-nix for more details) it generates a flake.lock file.

1. Should the user be encouraged to commit this file to their git repo?
   Judging from https://github.com/http4s/http4s/blob/series/0.23/flake.lock the answer is yes, we should commit the lock file to the repo.

2. Should we be templating the lockfile for the user so it's generated as part of the giter8 init process?
   If not, I think we ought to add a little mention of the expectations to the outer README here.

cc. @rossabaker

Setup CI

I guess there's a g8Test command?
https://github.com/http4s/http4s.g8/blob/c204d5591dec49424582b2b871b05d9fb297fc58/build.sbt#L7

We can host the template itself with sbt-typelevel, just disable publishing with:

ThisBuild / tlCiReleaseTags := false
ThisBuild / tlCiReleaseBranches := Nil

Include Scala Code of Conduct?

Code of Conducts are good.

Ask about s01 during template initialization?

This thing.

// true by default, set to false to publish to s01.oss.sonatype.org
ThisBuild / tlSonatypeUseLegacyHost := true

I wonder if more projects want false these days. Typelevel itself has moved to s01.

GitHub workflows are missing

https://github.com/valencik/proto-typelevel.g8/blob/8f176566bfebe5edb0ef535b548041b1f67a4b18/src/main/g8/default.properties#L16

We can also check this in CI with githubWorkflowCheck.

Consider adding a README boilerplate for Typelevel projects

There are certain elements that are generally present on all Typelevel READMEs, things like

• Code of Conduct
• Discord link - maybe just as a badge?
• CI badges

Perhaps we could standardise those things a bit in typelevel.g8?

Update start year in template

typelevel.g8/src/main/g8/build.sbt

Line 6 in 67ee77a

ThisBuild / startYear := Some(2023)

If we could make this a configurable property that seems even better, then I think we would only need to bump it in one place and the user can easily set it to a different year.

Add typelevel.g8 to sbt-typelevel team

I was chatting with @armanbilge, and perhaps we should add the typelevel.g8 repo to the list of repos in the sbt-typelevel team so everyone there has permissions here.

cc. @rossabaker I think we need your powers to do this.