View Source Comment Directives

# quokka:sort is Quokka's sorting directive. It always runs on every format pass; there is no config option to disable it. If you added # quokka:sort in source, Quokka will honor it.

This is separate from config-driven autosort, which sorts all maps, defstructs, and/or schemas when autosort: [...] is set in .formatter.exs. Use # quokka:sort for values autosort does not cover (lists, sigils, @type struct fields, and so on), or when you want to sort a specific value without enabling autosort globally.

Note on :comment_directives in config

:comment_directives is no longer a valid style in :only or :exclude (removed in 2.13.0). # quokka:sort always runs regardless of those settings. To control config-driven sorting, use :autosort instead. See Autosort → Upgrading from 2.12.x.

Other quokka:* comments are handled by other styles:

CommentStyle module
# quokka:sortalways enabled (not configurable)
# quokka:skip-sortAutosort
# quokka:skip-module-directives, # quokka:skip-module-directive-reordering, …ModuleDirectives

# quokka:sort

Opt in to sorting for a specific value. Place # quokka:sort on the line above the expression. This works whether or not autosort is enabled in config.

Replace # Please keep this list sorted! notes with # quokka:sort so Quokka maintains order during mix format.

Examples 

# quokka:sort
[:c, :a, :b]

# quokka:sort
~w(a list of words)

# quokka:sort
@country_codes ~w(
  en_US
  po_PO
  fr_CA
  ja_JP
)

# quokka:sort
a_var =
  [
    Modules,
    In,
    A,
    List
  ]

# quokka:sort
@type t :: %__MODULE__{
  c: String.t(),
  a: boolean(),
  b: pos_integer()
}

Would yield:

# quokka:sort
[:a, :b, :c]

# quokka:sort
~w(a list of words)

# quokka:sort
@country_codes ~w(
  en_US
  fr_CA
  ja_JP
  po_PO
)

# quokka:sort
a_var =
  [
    A,
    In,
    List,
    Modules
  ]

# quokka:sort
@type t :: %__MODULE__{
  a: boolean(),
  b: pos_integer,
  c: String.t()
}

Comments while sorting

# quokka:sort uses the same sorting code as autosort and follows the same comment rules: comments stay with the entry they belonged to (on lines above it after formatting). See Autosort → Comments for how that works for maps, defstructs, and schemas under config autosort.

For # quokka:skip-sort and config options, see Autosort.

  • Autosort — autosort: [:map, :defstruct, :schema] and # quokka:skip-sort
  • Module Directives — use, alias, import, skip comments, and related transforms