~jan0sch/smederee
Showing details for patch d404049b49e12c293518c91a9cabfd95480bc116.
diff -rN -u old-smederee/CODINGSTYLE.md new-smederee/CODINGSTYLE.md --- old-smederee/CODINGSTYLE.md 2025-02-01 15:43:17.393579478 +0000 +++ new-smederee/CODINGSTYLE.md 2025-02-01 15:43:17.393579478 +0000 @@ -19,9 +19,9 @@ 2. Rewrite rules SHOULD exist in the configuration to rewrite common unicode characters to their ASCII counterparts. 3. The maximum line length in the source code SHOULD not be longer than 120 characters. There MAY be rare cases where exceptions are allowed. 4. Imports SHOULD be written after the following guidelines: - 1. Imports from Java core (e.g. `import java.time._`) MUST be written (grouped) first, followed by a blank line. - 2. Multiple imports from the same package in curly braces SHALL have a space after the opening and before the closing brace (enforced by `spaces.inImportCurlyBraces=true`). - 3. Imports SHALL be sorted by their ASCII names. This SHOULD be enforced by the `rewrite.imports.sort = ascii` setting of Scalafmt. + 1. Imports from Java core (e.g. `import java.time._`) MUST be written (grouped) first, followed by a blank line. + 2. Multiple imports from the same package in curly braces SHALL have a space after the opening and before the closing brace (enforced by `spaces.inImportCurlyBraces=true`). + 3. Imports SHALL be sorted by their ASCII names. This SHOULD be enforced by the `rewrite.imports.sort = ascii` setting of Scalafmt. 5. Redundant braces SHALL be removed (enforced by `rewrite.rules` including `RedundantBraces`). 6. Redundant parentheses SHALL be removed (enforced by `rewrite.rules` including `RedundantParens`). 7. Configuration files for sbt (e.g. `*.sbt`) MUST NOT be formatted via Scalafmt. @@ -32,12 +32,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")