share/man/nitmetrics.md

   1 % NITMETRICS(1)
   2
   3 # NAME
   4
   5 Computes various metrics on Nit programs.
   6
   7 # SYNOPSYS
   8
   9 nitmetrics [*options*]...
  10
  11 # OPTIONS
  12
  13 `-W`, `--warn`
  14 :   Show more warnings
  15
  16 `-w`, `--warning`
  17 :   Show/hide a specific warning
  18
  19 `-q`, `--quiet`
  20 :   Do not show warnings
  21
  22 `--stop-on-first-error`
  23 :   Stop on first error
  24
  25 `--no-color`
  26 :   Do not use color to display errors and warnings
  27
  28 `--log`
  29 :   Generate various log files
  30
  31 `--log-dir`
  32 :   Directory where to generate log files
  33
  34 `-h`, `-?`, `--help`
  35 :   Show Help (This screen)
  36
  37 `--version`
  38 :   Show version and exit
  39
  40 `--set-dummy-tool`
  41 :   Set toolname and version to DUMMY. Useful for testing
  42
  43 `-v`, `--verbose`
  44 :   Verbose
  45
  46 `--bash-completion`
  47 :   Generate bash_completion file for this program
  48
  49 `--stub-man`
  50 :   Generate a stub manpage in pandoc markdown format
  51
  52 `--disable-phase`
  53 :   DEBUG: Disable a specific phase; use `list` to get the list.
  54
  55 `-I`, `--path`
  56 :   Set include path for loaders (may be used more than once)
  57
  58 `--only-parse`
  59 :   Only proceed to parse step of loaders
  60
  61 `--only-metamodel`
  62 :   Stop after meta-model processing
  63
  64 `--ignore-visibility`
  65 :   Do not check, and produce errors, on visibility issues.
  66
  67 `--all`
  68 :   Compute all metrics
  69
  70 `--mmodules`
  71 :   Compute metrics about mmodules
  72
  73 `--mclasses`
  74 :   Compute metrics about mclasses
  75
  76 `--mendel`
  77 :   Compute mendel metrics
  78
  79 `--inheritance`
  80 :   Compute metrics about inheritance usage
  81
  82 `--refinement`
  83 :   Compute metrics about refinement usage
  84
  85 `--self`
  86 :   Compute metrics about the usage of explicit and implicit self
  87
  88 `--ast`
  89 :   Compute metrics about the usage of nodes and identifiers in the AST
  90
  91 `--nullables`
  92 :   Compute metrics on nullables send
  93
  94 `--static-types`
  95 :   Compute explicit static types metrics
  96
  97 `--tables`
  98 :   Compute tables metrics
  99
 100 `--rta`
 101 :   Compute RTA metrics
 102
 103 `--csv`
 104 :   Export metrics in CSV format
 105
 106 `--generate_hyperdoc`
 107 :   Generate Hyperdoc
 108
 109 `--poset`
 110 :   Complete metrics on posets
 111
 112 `-d`, `--dir`
 113 :   Directory where some statistics files are generated
 114
 115 `--no-colors`
 116 :   Disable colors in console outputs
 117
 118 # SEE ALSO
 119
 120 The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>