Skip to content

Commit 3ebd9dd

Browse files
committed
Document the thriftcheck command
https://go.dev/doc/comment#cmd
1 parent 41e9264 commit 3ebd9dd

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

cmd/main.go

+26
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,32 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
/*
16+
Thriftcheck lints Thrift IDL files.
17+
18+
Usage:
19+
20+
thriftcheck [options] [path ...]
21+
22+
Options:
23+
24+
-I, --include value
25+
include path (can be specified multiple times)
26+
-c, --config string
27+
configuration file path (default ".thriftcheck.toml")
28+
--errors-only
29+
only report errors (not warnings)
30+
-h, --help
31+
show command help
32+
-l, --list
33+
list all available checks with their status and exit
34+
--stdin-filename string
35+
filename used when piping from stdin (default "stdin")
36+
-v, --verbose
37+
enable verbose (debugging) output
38+
--version
39+
print the version and exit
40+
*/
1541
package main
1642

1743
import (

0 commit comments

Comments
 (0)