~jan0sch/smederee
Showing details for patch 03d86f012b41925f9ba9a96ac78bcf215a8c61ff.
diff -rN -u old-smederee/CODINGSTYLE.md new-smederee/CODINGSTYLE.md --- old-smederee/CODINGSTYLE.md 2025-01-11 17:46:18.999992914 +0000 +++ new-smederee/CODINGSTYLE.md 2025-01-11 17:46:18.999992914 +0000 @@ -28,12 +28,12 @@ ``` 4. The maximum line length in the source code SHOULD not be longer than 120 characters. There MAY be rare cases where exceptions are allowed. 5. Imports SHOULD be written after the following guidelines and automatically applied by running Scalafix: - 1. Imports from Java core (e.g. `import java.time._`) MUST be written (grouped) first, followed by a blank line. - 2. Imports from the Scala core (e.g. `import scala.util.Failure`) MUST be written (grouped) last, prefixed by a blank line. - 3. Other imports SHOULD be grouped in between the Java and Scala core imports. - 4. Within the other imports test framework imports (e.g. `munit.` or `org.scalacheck.`) SHOULD be put last and grouped. - 5. Multiple imports from the same package in curly braces SHALL be rewritten as single import per line. This intends to reduce possible merge conflicts by import changes. The option `groupedImports = Explode` for Scalafix is intended to rewrite affected code automatically. - 6. Imports SHALL be sorted by their ASCII names. This SHOULD be enforced by the `importsOrder` setting of Scalafix. + 1. Imports from Java core (e.g. `import java.time._`) MUST be written (grouped) first, followed by a blank line. + 2. Imports from the Scala core (e.g. `import scala.util.Failure`) MUST be written (grouped) last, prefixed by a blank line. + 3. Other imports SHOULD be grouped in between the Java and Scala core imports. + 4. Within the other imports test framework imports (e.g. `munit.` or `org.scalacheck.`) SHOULD be put last and grouped. + 5. Multiple imports from the same package in curly braces SHALL be rewritten as single import per line. This intends to reduce possible merge conflicts by import changes. The option `groupedImports = Explode` for Scalafix is intended to rewrite affected code automatically. + 6. Imports SHALL be sorted by their ASCII names. This SHOULD be enforced by the `importsOrder` setting of Scalafix. 6. Redundant braces SHALL be removed (enforced by `rewrite.rules` including `RedundantBraces`). 7. Redundant parentheses SHALL be removed (enforced by `rewrite.rules` including `RedundantParens`). 8. Configuration files for sbt (e.g. `*.sbt`) MUST NOT be formatted via Scalafmt. @@ -44,12 +44,12 @@ 1. Build definition and settings SHOULD be formatted to have one setting per line if possible. 2. Dependencies SHALL be defined in the `lazy val library` block inside the `build.sbt` file, following these rules: - 1. The version number SHALL be defined as a string in the `object Version` having a name clearly identifying the dependency e.g. `val cats = "2.8.0"`. - 2. The dependencies SHALL be defined as values having meaningful names and they should be vertically aligned like in the following example: - ```scala - val catsCore = "org.typelevel" %% "cats-core" % Version.cats - val catsEffect = "org.typelevel" %% "cats-effect" % Version.catsEffect - ``` + 1. The version number SHALL be defined as a string in the `object Version` having a name clearly identifying the dependency e.g. `val cats = "2.8.0"`. + 2. The dependencies SHALL be defined as values having meaningful names and they should be vertically aligned like in the following example: + ```scala + val catsCore = "org.typelevel" %% "cats-core" % Version.cats + val catsEffect = "org.typelevel" %% "cats-effect" % Version.catsEffect + ``` 3. Plugins for sbt SHALL be defined inside the `project/plugins.sbt` file and be vertically aligned like in the following example: ```scala addSbtPlugin("io.spray" % "sbt-revolver" % "0.9.1") diff -rN -u old-smederee/README.md new-smederee/README.md --- old-smederee/README.md 2025-01-11 17:46:18.999992914 +0000 +++ new-smederee/README.md 2025-01-11 17:46:18.999992914 +0000 @@ -11,7 +11,7 @@ - [Java](https://openjdk.org/) 17 (or higher) - [PostgreSQL](https://www.postgresql.org/) 13 (or higher) - - The time zone of the DBMS is expected to be set to `Etc/UTC`! + - The time zone of the DBMS is expected to be set to `Etc/UTC`! - [Darcs](http://darcs.net/) - [colordiff](https://www.colordiff.org/) (for coloured diffs) @@ -57,8 +57,8 @@ 1. a regular endpoint (`HttpRoutes`) with the intended implementation 2. a protected endpoint (`AuthedRoutes`) with: - - a simple redirect (`SeeOther`) or error page - - put within a middleware with **fall through** + - a simple redirect (`SeeOther`) or error page + - put within a middleware with **fall through** ### Tests ###