awesome-appwrite icon indicating copy to clipboard operation
awesome-appwrite copied to clipboard

πŸš€ Feature: awesome linting workflow

Open saintmalik opened this issue 3 years ago β€’ 2 comments

πŸ”– 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?

  • [X] I checked and didn't find similar issue

🏒 Have you read the Code of Conduct?

saintmalik avatar Oct 29 '21 08:10 saintmalik

@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?

adityaoberai avatar Jan 27 '22 12:01 adityaoberai

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?

saintmalik avatar Jan 27 '22 18:01 saintmalik

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

rudrakshkarpe avatar Oct 05 '23 07:10 rudrakshkarpe

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

adityaoberai avatar Oct 06 '23 14:10 adityaoberai