Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Automatically run awesome-lint in CI? #35

Open
jepler opened this issue Nov 24, 2021 · 1 comment · May be fixed by #51
Open

Automatically run awesome-lint in CI? #35

jepler opened this issue Nov 24, 2021 · 1 comment · May be fixed by #51

Comments

@jepler
Copy link
Member

jepler commented Nov 24, 2021

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
Copy link

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

jepler added a commit that referenced this issue May 30, 2022
@jepler
Run awesome-lint during CI. Closes #35
3af44c5
jepler added a commit that referenced this issue May 30, 2022
@jepler
Run awesome-lint during CI. Closes #35
1ac98e2
@jepler jepler linked a pull request May 30, 2022 that will close this issue
Open
jepler added a commit that referenced this issue Jan 31, 2024
@jepler
Run awesome-lint during CI. Closes #35
33b8a44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Run awesome-lint during CI adafruit/awesome-circuitpython
2 participants
@andypiper @jepler