CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
telegraf/tools/readme_linter
History
Sven Rebhan 04de888cdd
chore(tools): Add metadata check to README linter (#16587) 		2025-03-28 14:55:27 -05:00
..
README.md chore: add readme linter (#10916) 2022-04-19 11:59:25 -06:00
assert.go chore(tools): Add metadata check to README linter (#16587) 2025-03-28 14:55:27 -05:00
main.go chore(tools): Add metadata check to README linter (#16587) 2025-03-28 14:55:27 -05:00
plugin.go chore(readme_linter): Update plugin type guess logic (#15010) 2024-03-18 16:06:28 -05:00
rules.go chore(tools): Add metadata check to README linter (#16587) 2025-03-28 14:55:27 -05:00
set.go chore: add readme linter (#10916) 2022-04-19 11:59:25 -06:00

README.md

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