Open jbrooksuk opened 9 years ago
Also, this would have to be marked as a script breaking change - unless we can add aliases?
What do you think @tchule?
Agree.
At the beginning there was no "checkXXX", I started adding them to order the methods in the IDE. But if we manage to separate the checks (or some of them) from the main code, we should adopt shorter names.
Would you agree with names such as unusedVariables
and unusedFunctionParameters
?
Yes, looks good to me.
On a slightly different but still related subject, I've updated an old task on the google code site : https://code.google.com/p/phpcheckstyle/issues/detail?id=1
I've started to try to implement something but I'm not really decided yet on the proper way to do this.
Good idea. I think the best thing to do is each check is passed the Reporter and the token stack etc. This way it's able to decide how to handle each check individually.
Sent from my iPhone
On 8 Sep 2014, at 18:06, tchule notifications@github.com wrote:
On a slightly different but still related subject, I've updated an old task on the google code site : https://code.google.com/p/phpcheckstyle/issues/detail?id=1
I've started to try to implement something but I'm not really decided yet on the proper way to do this.
— Reply to this email directly or view it on GitHub.
Perhaps even using under scores in names?
unused_variables
line_length
Easier to read?
We could always run the names through a converter, so camelCase could still be default, but it could auto convert snake_case etc? This just allows for easy mistakes etc.
@tchule just a quick check that you're happy with the suggested naming conventions before I go and change them?
Personnaly I prefer the camelCase version, klike you proposed "unusedVariables" and "unusedFunctionParameters". But I'm OK with both.
Ok, well we can easily accept both - a quick conversion would fix it - but we in the documentation and example we would always use camelCase?
Yes, this would be perfect.
@tchule here's what I'm thinking:
regexp
should change from constantNaming
to constantNamePattern
, so you know it's an expected format.spaceAfterControlStatement
, although it's longer, it's more verbose.check
from keys like checkProhibitedFunctions
so just prohibitedFunctions
.showTODOs
could just be showTodo
for camelCase-ness.My thoughts are for readability and verbosity, but still keeping them short where possible. What do you think?
Also, they read better in snake_case too:
constant_naming_pattern
space_after_control_statement
prohibited_functions
show_todos
:)
Some of the checks are inconsistent. A few begin with
check
and others don't. Ideally we'd make the names short but sweet. This would require a lot of changes in the config files, but it'd end with nicer configuration values.