OxL Reference

warning naming

warning Standard: [IV.2]

What it means#

Names should follow part IV.2: UpperCamelCase for types, interfaces, services, actors, topics and enum variants; lowerCamelCase for functions, methods, variables, fields and parameters; UPPER_SNAKE_CASE for constants and static; snake_case for modules and packages. oxl fmt does not rename; the analyzer warns.

Example#

oxl✓ checked in CI
fn PlaceOrder() { }      // <- naming (functions use lowerCamelCase)

data order_item { id: u64 }      // <- naming (types use UpperCamelCase)
error
naming

How to fix#

oxl✓ checked in CI
fn placeOrder() { }

data OrderItem { id: u64 }

Rename the item to the convention. Renaming a public item is a breaking API change for packages that depend on it.

See also#

OxL 1.0.0-beta · Documentation version 1.0.0-beta© OxwaldLink · generated from the Standard, the std sources and the guides