History

Sven Rebhan b2967cb515 chore: Update go to v1.23.0 (#15766 ) Co-authored-by: Pawel Zak <pawel.zak.pawel@gmail.com>		2024-08-30 14:23:51 -05:00
..
README.md	chore: add readme linter (#10916 )	2022-04-19 11:59:25 -06:00
assert.go	chore: eliminate unnecessary use of quoted strings in printf (#12722 )	2023-02-23 06:49:36 -07:00
main.go	feat(tools/readme_linter): Check for global configuration section (#12426 )	2023-01-12 16:55:21 +01:00
plugin.go	chore(readme_linter): Update plugin type guess logic (#15010 )	2024-03-18 16:06:28 -05:00
rules.go	chore: Update go to v1.23.0 (#15766 )	2024-08-30 14:23:51 -05:00
set.go	chore: add readme linter (#10916 )	2022-04-19 11:59:25 -06:00

README.md linter

Building

telegraf/tools/readme_linter$ go build .

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