kubuszok/re-scale/guide-code-style

Code style

• License header: Apache-2.0, with Migration notes block for audited files
• Braces required (-no-indent): {} for all trait/class/enum/method defs
• Split packages: package ssg / package md / package core (never flat)
• No `return`: use boundary/break
• No `null`: use Nullable[A]
• No `scala.Enumeration`: use Scala 3 enum, preferably extends java.lang.Enum
• Case classes must be `final`
• No Java-style getters/setters: no-logic getX()/setX(v) → public var x
• Preserve all original comments from the source
• Fix bugs, don't work around them: when a test reveals a pre-existing bug, fix it

File header metadata

After porting, stamp the file's header with tracking properties:

re-scale fileinfo --given <path> --then "set original-src=<source>,authors=<names>,status=ported"

Query a file's properties without reading the full file:

re-scale fileinfo --given <path> --then "select *"

See /file-metadata for the full query/filter/batch-update API.

Formatting

Scalafmt config is .scalafmt.conf at project root. Run:

re-scale build fmt