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.

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

🚀 Feature: awesome linting workflow #324

Closed
2 tasks done
saintmalik opened this issue Oct 29, 2021 · 4 comments
Closed
2 tasks done

🚀 Feature: awesome linting workflow #324

saintmalik opened this issue Oct 29, 2021 · 4 comments
Assignees

Comments

@saintmalik
Copy link

🔖 Feature description

A github action workflow that checks pull requests submitted to make sure the changes are not breaking any awesome linting rules.

🎤 Pitch

Knowing that Awesome LInting has good rules that makes an Awesome Listing Repos, free from errors, repeated links, lists that doesnt have comma's, wrong use of full stops and more.

All this get handled by the Awesome linting workflow checks.

👀 Have you spent some time to check if this issue has been raised before?

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

@adityaoberai adityaoberai self-assigned this Jan 27, 2022
@adityaoberai
Copy link
Member

@saintmalik very sorry for the delay in responding and thanks a lot for suggesting this feature.

I would love to know if you have worked with Awesome Linting in the past and whether it allows custom formatting since we recently restructured the entire Readme?

@saintmalik
Copy link
Author

Yeah, i have worked with Awesome Linting in the past, i use it in one of my projects, what do you mean by custom formatting?, so after running a linting test here are the results.

  ✖    1:1    License was not detected by GitHub                                                            remark-lint:awesome-github
  ✖    1:1    Missing or invalid Table of Contents                                                          remark-lint:awesome-toc
  ✖    1:21   Invalid badge source                                                                          remark-lint:awesome-badge
  ✖    3:25   Titles should use ' as a quote                                                                remark-lint:link-title-style
  ✖    5:1    Don’t add a trailing : to headings                                                            remark-lint:no-heading-punctuation
  ✖    6:3    Incorrect indentation before bullet: remove 2 spaces                                          remark-lint:list-item-bullet-indent
  ✖    6:5    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖    7:3    Incorrect indentation before bullet: remove 2 spaces                                          remark-lint:list-item-bullet-indent
  ✖    7:5    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖    8:3    Incorrect indentation before bullet: remove 2 spaces                                          remark-lint:list-item-bullet-indent
  ✖    8:5    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖    9:3    Incorrect indentation before bullet: remove 2 spaces                                          remark-lint:list-item-bullet-indent
  ✖    9:5    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   10:7    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   11:7    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   12:7    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   13:7    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   14:7    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   15:7    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   16:3    Incorrect indentation before bullet: remove 2 spaces                                          remark-lint:list-item-bullet-indent
  ✖   16:5    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   17:7    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   18:7    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   19:7    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   20:7    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   21:7    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   22:7    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   23:7    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   24:7    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   25:7    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   26:7    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   27:3    Incorrect indentation before bullet: remove 2 spaces                                          remark-lint:list-item-bullet-indent
  ✖   27:5    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   28:3    Incorrect indentation before bullet: remove 2 spaces                                          remark-lint:list-item-bullet-indent
  ✖   28:5    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   29:3    Incorrect indentation before bullet: remove 2 spaces                                          remark-lint:list-item-bullet-indent
  ✖   29:5    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   30:3    Incorrect indentation before bullet: remove 2 spaces                                          remark-lint:list-item-bullet-indent
  ✖   30:5    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   31:3    Incorrect indentation before bullet: remove 2 spaces                                          remark-lint:list-item-bullet-indent
  ✖   31:5    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   32:3    Incorrect indentation before bullet: remove 2 spaces                                          remark-lint:list-item-bullet-indent
  ✖   32:5    Invalid list item link URL                                                                    remark-lint:awesome-list-item
  ✖   33:3    Incorrect indentation before bullet: remove 2 spaces                                          remark-lint:list-item-bullet-indent
  ✖   33:5    Invalid list item link URL                                                                    remark-lint:awesome-list-item

Seems its the custom formatting that caused most errors right?

@rudrakshkarpe
Copy link

@adityaoberai if you don't mind. I'd like to work on this issue and improve GitHub actions with awesome linting rules.

@adityaoberai
Copy link
Member

At the moment, since we follow custom formatting purposefully, and we don't have plans to change that soon, I'm closing this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants