Muncher rules review - Githubissues

stackmuncher / stm_app

This software engineer profile builder turns your code into a detailed list of skills for an online directory of software developers.

https://stackmuncher.com

GNU Affero General Public License v3.0

22 stars 1 forks source link

Muncher rules review #36

Open rimutaka opened 2 years ago

rimutaka commented 2 years ago

Adding more munchers prompts a review of what is already in place. Relates to #8, #7.

[ ] rename "brackets only" to "white space"
[ ] rename "inline comments" to "other comments" in the front end
[ ] recheck all regex for \s use and replace it with [:blank:] to exclude line breaks
[ ] add a rule for sibling file names check - a .h file can belong to C or C++
[ ] add .cc, .C and other variations to C++
[ ] add .cu CUDA files somewhere

Older munchers

These munchers need a full review and testing.

csharp
js
powershell
python
rust
scss
sql
ts

Ignore list

A rule with no muncher is essentially an instruction to ignore.

[ ] check if the current will do that or fail
[ ] check if we need a catch-all rule with an ignore list of directories, e.g. node-modules or bin that is checked before the file type is checked
[ ] add ignore list for images, binaries Some files may need to be added to anti-patterns such as including /bin/ in your repo. Not sure it's a good idea.

rimutaka commented 2 years ago

Testing a language search in GH:

curl \
  -H "Accept: application/vnd.github.v3+json" \
https://api.github.com/search/repositories?q=language:Go+sort:updated