cli: Add lint subcommand. (#92)

Author: varungandhi-src

Development.md

@@ -50,6 +50,14 @@ and can be inspected using `protoc`:
 protoc --decode=scip.Index -I /path/to/scip scip.proto < index.scip
 ```
 
+There is also a `lint` subcommand which performs various well-formedness
+checks on a SCIP index. It is meant primarily for people working on a SCIP indexer,
+and is not recommended for use in other settings.
+
+```
+scip lint /path/to/index.scip
+```
+
 ## Testing and adding new SCIP semantics
 
 It is helpful to use reprolang to check the existing code navigation behavior,

Readme.md

@@ -70,9 +70,10 @@ DESCRIPTION:
 
 COMMANDS:
    convert   Convert a SCIP index to an LSIF index
+   lint      Flag potential issues with a SCIP index
+   print     Print a SCIP index in a human-readable format for debugging
    snapshot  Generate snapshot files for golden testing
    stats     Output useful statistics about a SCIP index
-   print     Print a SCIP index in a human-readable format for debugging
    help, h   Shows a list of commands or help for one command
 
 GLOBAL OPTIONS:
@@ -94,6 +95,27 @@ OPTIONS:
    --to value    Output path for LSIF index (default: dump.lsif)
 ```
 
+### `scip lint`
+
+```
+NAME:
+   scip lint - Flag potential issues with a SCIP index
+
+USAGE:
+   scip lint [command options] [arguments...]
+
+DESCRIPTION:
+   Example usage:
+
+     scip lint /path/to/index.scip
+
+   You may want to filter the output using `grep -v <pattern>`
+   to narrow down on certain classes of errors.
+
+OPTIONS:
+   --help, -h  show help (default: false)
+```
+
 ### `scip print`
 
 ```