Code

chore: add readme linter#10916

Code

Merged

reimda merged 22 commits intomasterinfluxdata/telegraf:masterfrom readme-linterinfluxdata/telegraf:readme-linterCopy head branch name to clipboardApr 19, 2022

+562

Commits

Commits on Apr 14, 2022

• Add readme linter

  reimda

  committed
  874f974

  Copy full SHA for 874f974

• print markdown line number of failed assertion

  reimda

  committed
  140dc55

  Copy full SHA for 140dc55

• assert header text matches regexp

  reimda

  committed
  032d5ed

  Copy full SHA for 032d5ed

• Check for required sectionsDisable long line check

  reimda

  committed
  802697e

  Copy full SHA for 802697e

• Let each plugin type have its own rules.Use file path to determine plugin type.

  reimda

  committed
  30dfdd4

  Copy full SHA for 30dfdd4

• Move to tools/readme_linter

  reimda

  committed
  01ebf85

  Copy full SHA for 01ebf85

• Remove empty file

  reimda

  committed
  87adb2a

  Copy full SHA for 87adb2a

• Remove commented code

  reimda

  committed
  6e7961e

  Copy full SHA for 6e7961e

• remove more commented code

  reimda

  committed
  e3ce0b7

  Copy full SHA for e3ce0b7

• Add rule that first section must have a paragraph with some text

  reimda

  committed
  0994a58

  Copy full SHA for 0994a58

• Make long line check apply only in paragraphs

  reimda

  committed
  c31bf07

  Copy full SHA for c31bf07

• Move plugin type to separate file

  reimda

  committed
  f0bff92

  Copy full SHA for f0bff92

• Check that config section has a toml fenced code block

  reimda

  committed
  c5e76ee

  Copy full SHA for c5e76ee

• Fix revive errors

  reimda

  committed
  d0af22e

  Copy full SHA for d0af22e

• Parse markdown tables to avoid checking for long lines in them

  reimda

  committed
  3e462b8

  Copy full SHA for 3e462b8

• check for in-repo absolute links

  reimda

  committed
  c7fb673

  Copy full SHA for c7fb673

• Check that lines are available before getting line number

  reimda

  committed
  1b53473

  Copy full SHA for 1b53473

• Prevent panic when looking up line number

  reimda

  committed
  1ec35dd

  Copy full SHA for 1ec35dd

• Added docs on running the linter

  reimda

  committed
  6db81bd

  Copy full SHA for 6db81bd

• Add build instructions and remove user directory from examples

  reimda

  committed
  fc23a53

  Copy full SHA for fc23a53

Commits on Apr 19, 2022

• Add command line option to print the location in source code of failed assertion

  reimda

  committed
  529ad78

  Copy full SHA for 529ad78

• Don't (do not) use contractions in messages

  reimda

  committed
  9c4fdc2

  Copy full SHA for 9c4fdc2