share/man/nitmetrics.md

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