Automatically run awesome-lint in CI?
jepler opened this issue · 1 comments
jepler commented
Some recent PRs mentioned tidying the markdown code with https://github.com/sindresorhus/awesome-lint -- is it something that we could/should do automatically during CI, similar to how we do pylint & black?
andypiper commented
Current lint results:
npx awesome-lint https://github.com/adafruit/awesome-circuitpython
✖ Linting
README.md:223:1
✖ 1:1 Missing main list heading remark-lint:awesome-heading
✖ 1:1 License was not detected by GitHub remark-lint:awesome-github
✖ 26:1 ToC item "In the news" does not match corresponding heading "News" remark-lint:awesome-toc
✖ 37:126 https://circuitpython.org/downloads remark-lint:double-link
✖ 42:3 https://learn.adafruit.com/circuitpython-essentials remark-lint:double-link
✖ 51:3 https://www.reddit.com/r/circuitpython/ remark-lint:double-link
✖ 51:68 List item description must start with valid casing remark-lint:awesome-list-item
✖ 57:180 List item link and description must be separated with a dash remark-lint:awesome-list-item
✖ 59:159 https://twitter.com/AoyamaProd remark-lint:double-link
✖ 62:3 https://twitter.com/AoyamaProd remark-lint:double-link
✖ 64:3 https://www.amazon.com/author/rleander remark-lint:double-link
✖ 65:3 https://www.amazon.com/author/rleander remark-lint:double-link
✖ 70:62 https://circuitpython.org/downloads remark-lint:double-link
✖ 72:3 https://learn.adafruit.com/circuitpython-essentials remark-lint:double-link
✖ 95:39 https://circuitpython.org/downloads remark-lint:double-link
✖ 121:156 List item description must start with valid casing remark-lint:awesome-list-item
✖ 123:3 https://youtu.be/-bBHXimlfPQ remark-lint:double-link
✖ 144:205 "’" is used without matching "‘" remark-lint:match-punctuation
✖ 144:306 "’" is used without matching "‘" remark-lint:match-punctuation
✖ 164:3 https://www.reddit.com/r/circuitpython/ remark-lint:double-link
✖ 164:124 https://www.reddit.com/r/circuitpython/ remark-lint:double-link
✖ 171:3 https://podcasts.apple.com/us/podcast/circuitpython-weekly-meeting/id1451685016 remark-lint:double-link
✖ 171:307 https://podcasts.apple.com/us/podcast/circuitpython-weekly-meeting/id1451685016 remark-lint:double-link
✖ 172:59 List item description must start with valid casing remark-lint:awesome-list-item
✖ 197:3 https://youtu.be/-bBHXimlfPQ remark-lint:double-link
✖ 223:1 Marker should be 2, was 1 remark-lint:ordered-list-marker-value
✖ 224:1 Marker should be 3, was 1 remark-lint:ordered-list-marker-value
✖ 225:1 Marker should be 4, was 1 remark-lint:ordered-list-marker-value
✖ 226:1 Marker should be 5, was 1 remark-lint:ordered-list-marker-value
✖ 227:1 Marker should be 6, was 1 remark-lint:ordered-list-marker-value
✖ 228:1 Marker should be 7, was 1 remark-lint:ordered-list-marker-value
✖ 229:1 Marker should be 8, was 1 remark-lint:ordered-list-marker-value
✖ 230:1 Marker should be 9, was 1 remark-lint:ordered-list-marker-value
✖ 231:1 Marker should be 10, was 1 remark-lint:ordered-list-marker-value
34 errors