styleguide.md

Coding style

• Do not break 80 column max-width unless for the occasional long string literals (e.g. Documentation).

• Multiline and wrapping string literals should go on a line below and above code e.g.

  foo(
      """one morning gregor samsa

woke up from troubled dreams """ ) ~~~

• Use the @api macro wherever possible.

• Shorthand function expressions can be either:

  • One line (if the line does not exceed 80 characters)
  • Or multiple lines but the first line must end with the =

• Multiline functions must start with a begin.

• Anonymous functions should be one line if they do not overflow the line beyond 80 chars

  • Otherwise the arguments should come in the line as the assignment. e.g.

    comm.on_msg = (msg) ->
        push!(sig, decodeJSON(sig, msg.content["data"]["value"]))

• Split long function calls like this:

  backend = Compose.Patchable(
      Compose.default_graphic_width,
      Compose.default_graphic_height,
  )

  Notice the extra comma at the end. This is to keep diffs clean.

• Long ternary expressions should be of the form:

  foo(x) ?
      case1 :
      case2

• In infix expressions longer than 80 characters, the right-hand side should be indented e.g.

  render(t.tile) <<
      Elem(
          "watch-state",
           name=t.name,
           attr=t.attr,
           trigger=t.trigger,
           elem=t.elem,
           source=t.source
      )

  This applies to |>, & and << as well.