|
|
||
|---|---|---|
| .. | ||
| assert.go | ||
| main.go | ||
| plugin.go | ||
| README.md | ||
| rules.go | ||
| set.go | ||
README.md linter
Building
telegraf/tools/readme_linter$ go build .
Running
Run readme_linter with the filenames of the readme files you want to lint.
telegraf/tools/readme_linter$ ./readme_linter <path to readme>
You can lint multiple filenames at once. This works well with shell globs.
To lint all the plugin readmes:
telegraf/tools/readme_linter$ ./readme_linter ../../plugins/*/*/README.md
To lint readmes for inputs starting a-d:
telegraf/tools/readme_linter$ ./readme_linter ../../plugins/inputs/[a-d]*/README.md