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

Add rule rrd amount of comments #273

Closed
rrd108 opened this issue Sep 14, 2024 · 7 comments · Fixed by #377
Closed

Add rule rrd amount of comments #273

rrd108 opened this issue Sep 14, 2024 · 7 comments · Fixed by #377
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed P3 Low priority

Comments

@rrd108
Copy link
Owner

rrd108 commented Sep 14, 2024

We should check how much comments we have in a file and if it too much (without jsdocs) we should fire a warning

Any number we decide will be debatablee. My suggestion is more than 5%

@David-Pena
Copy link
Collaborator

If more than 5% of the total lines are comments, trigger a warning? @rrd108

@rrd108
Copy link
Owner Author

rrd108 commented Sep 14, 2024

Yep.

Or reather character count as comments can be in the same line as the code.

What do you think?

@David-Pena
Copy link
Collaborator

Or reather character count as comments can be in the same line as the code.

In that case would 5% be a good number? should it be higher or lower?

@David-Pena David-Pena added enhancement New feature or request help wanted Extra attention is needed P3 Low priority labels Sep 15, 2024
@rrd108
Copy link
Owner Author

rrd108 commented Sep 16, 2024

Let's try with this and check a few files and then we can discuss

@rrd108
Copy link
Owner Author

rrd108 commented Sep 16, 2024

jsdoc comments should be ignored

@David-Pena David-Pena self-assigned this Sep 25, 2024
@David-Pena
Copy link
Collaborator

I want to keep helping with bugs so Ill unasign myself from this

@David-Pena
Copy link
Collaborator

I created a PR for this #377

rrd108 added a commit that referenced this issue Oct 4, 2024
feat: add new rrd amount of comments rule w tests (#273)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed P3 Low priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants