package ocp-indent

  1. Overview
  2. Docs
A simple tool to indent OCaml programs

Install 

dune-project
 Dependency

www.typerex.org Readme Changelog Edit opam file Versions (5)

Authors

  1. L
    Louis Gesbert <louis.gesbert@ocamlpro.com>
  2. T
    Thomas Gazagnaire <thomas@gazagnaire.org>
  3. J
    Jun Furuse

Maintainers

  1. C
    contact@ocamlpro.com

Sources

ocp-indent-1.9.0.tbz
sha256=da4ff552f9fc230d7c07f64a8ef89295907bf8d3c581132f05dcf0dd87a172b3
sha512=d734487162ab1373110a4c4d4f83128b21c39ec2d6e6cd1f9708178b190553cf60faebf62483113ceed490d1b9948c6241e798ea81ee266f3ed7fd8113552684

doc/ocp-indent.lib/IndentConfig/index.html

Module IndentConfigSource

Sourcetype threechoices =
  1. | Always
  2. | Never
  3. | Auto
Sourcetype t = {
  1. i_base : int;
    (*

    indentation values

    *)
  2. i_type : int;
  3. i_in : int;
  4. i_with : int;
  5. i_match_clause : int;
  6. i_ppx_stritem_ext : int;
  7. i_max_indent : int option;
    (*

    indentation toggles

    *)
  8. i_strict_with : threechoices;
  9. i_strict_else : threechoices;
  10. i_strict_comments : bool;
  11. i_align_ops : bool;
  12. i_align_params : threechoices;
  13. i_match_tail_cascade : bool;
}

See the man function to get the details of what the options are supposed to do (or the template .ocp-indent)

Documentation of the indentation options, in the Cmdliner 'Manpage.block' format

Sourcetype man_block = [
  1. | `S of string
  2. | `P of string
  3. | `Pre of string
  4. | `I of string * string
  5. | `Noblank
  6. | `Blocks of man_block list
]
Sourceval man : man_block list
Sourceval default : t
Sourceval update_from_string : ?extra:(string -> (string -> unit) option) -> t -> string -> t

String format is "option=value,option2=value,...". Commas can be replaced by newlines. Use ?extra to handle extra options (by side-effects only)

Sourceval to_string : ?sep:string -> t -> string

sep should be comma or newline if you want to reparse. Comma by default

Sourceval load : ?indent:t -> string -> t * string list * [ `Mod of string | `Pkg of string ] list

Load from the given filename, optionally updating from the given indent instead of the default one. On error, returns the original indent config unchanged and prints a message to stderr. The file may also contain bindings of the form 'syntax=SYNTAX_EXTENSION,...', that are returned as a the list of their names

Sourceval save : t -> string -> bool

Save the given indent config to the given filename; returns true on success

Sourceval find_conf_file : string -> string option

Looks in given and parent directories for a .ocp-indent configuration file

Sourceval local_default : ?path:string -> unit -> t * string list * [ `Mod of string | `Pkg of string ] list

Returns the local default configuration, obtained from (in order), the built-in default, the file ~/.ocp/ocp-indent.conf, a file .ocp-indent in the current directory or any parent, and the environment variable OCP_INDENT_CONFIG. Returns the list of syntax extensions that may have been activated in conf-files as well