search

mrwilson / adr-viewer

Generate easy-to-read web pages for your Architecture Decision Records
MIT License
144 stars 25 forks source link

`--lint` to check ADRs for content we need #52

Open mrwilson opened 9 months ago

mrwilson commented 9 months ago

The project assumes some things about the structure of the ADRs based on adr-tools and common variations of the ADR format.

It'd be useful to have a separate linting capability so users can test these things. Things like:

$ adr-viewer --lint --adr-path adrs/

✅ 0001-adr-one.md
❌ 0002-adr-two.md - Missing useful fields: status
❌ 0003-adr-three.exe.md - Unable to parse file as markdown in ADR format