data-model/tools/yang-linter/README.md

   1 # YANG linter
   2
   3 As much as possible automatic yang linter
   4
   5 ## Usage
   6
   7 ```
   8 ./src/main/bash/yang-linter [options] <directory>
   9 ```
  10
  11 ### Example
  12
  13 ```
  14 ./src/main/bash/yang-linter --3gpp
  15 ```
  16
  17 ## Options
  18
  19 ```
  20   -3, --3gpp            Clone and lint 3GPP SA5 yang modules and exit
  21   -h, --help            Show this help message and exit
  22
  23   -i=IMPORTDIR, --imports=IMPORTDiR
  24                         Defines an import directory for standard yang modules
  25
  26   -s, --status          Show app status information and exit
  27
  28   -t=TARGETDIR, --target=TARGETDIR
  29                         Defines the target output directory
  30
  31   -v, --version         Show version number and exit
  32
  33   <directory>           The folder containng yang modules
  34 ```
  35
  36 ## Open Items
  37
  38 Ideas for additional pyang plugins:
  39
  40 - pyang --format yang --yang-contact
  41 - pyang --format yang --yang-organization
  42 - pyang --format yang --yang-reference
  43 - pyang --format yang --yang-revision-order
  44 - pyang --format yang --yang-revision-default
  45 - pyang --format yang --yang-description