share/man/nitmetrics.md

   1 % NITMETRICS(1)
   2
   3 # NAME
   4
   5 nitmetrics -- computes various metrics on Nit programs.
   6
   7 # SYNOPSIS
   8
   9 nitmetrics [*options*]... FILE...
  10
  11 # OPTIONS
  12
  13 ## METRICS
  14
  15 `--all`
  16 :   Compute all metrics
  17
  18 `--mmodules`
  19 :   Compute metrics about mmodules
  20
  21 `--mclasses`
  22 :   Compute metrics about mclasses
  23
  24 `--mendel`
  25 :   Compute mendel metrics
  26
  27 `--inheritance`
  28 :   Compute metrics about inheritance usage
  29
  30 `--refinement`
  31 :   Compute metrics about refinement usage
  32
  33 `--self`
  34 :   Compute metrics about the usage of explicit and implicit self
  35
  36 `--ast`
  37 :   Compute metrics about the usage of nodes and identifiers in the AST
  38
  39 `--nullables`
  40 :   Compute metrics on nullables send
  41
  42 `--static-types`
  43 :   Compute explicit static types metrics
  44
  45 `--tables`
  46 :   Compute tables metrics
  47
  48 `--rta`
  49 :   Compute RTA metrics
  50
  51 `--generate_hyperdoc`
  52 :   Generate Hyperdoc
  53
  54 `--poset`
  55 :   Complete metrics on posets
  56
  57 `--detect-variance-constraints`
  58 :   Detects the definition-site variance constraints on formal parameters.
  59
  60     Infers the possible variance annotations of formal types in Nit programs by identifying the existing constraints on the usage of those formal type.
  61
  62 ## OUTPUT
  63
  64 `--csv`
  65 :   Also export metrics in CSV format.
  66
  67 `-d`, `--dir`
  68 :   Directory where some statistics files are generated.
  69
  70 `--no-colors`
  71 :   Disable colors in console outputs.
  72
  73 # SEE ALSO
  74
  75 The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>