search

wttech / aet

AET - a system that detects visual changes on web sites and performs basic page health checks
https://wttech.blog/open-source/
Apache License 2.0
146 stars 49 forks source link

Create naming convention for parameters #343

Open plutasnyy opened 6 years ago

plutasnyy commented 6 years ago

Version used

Context of the issue/feature

Currently, we don't have a naming convention for parameters. For example please look at layout comparator: pixelThreshold, percentageThreshold, or at replacing text collector: attributeName. There we use camel case, but in other modules e.g cookie comparator, we have cookie-name, cookie-value. I think that it could be a good improvement and it will make more clearly for aet's users.

Names of collectors and comparators are using the dash to seperating words, we would like to be consistent or maybe we would like to use camel case?

malaskowski commented 6 years ago

@plutasnyy I like this idea very much to finally introduce some naming convention for AET suite DSL and attributes. I'm with option to make camel case everywhere. The thing to consider is that we probably should support old "dash" params for some time (e.g. deprecate them) to remove in a feature version. I mean, if we have modify-cookie with params like cookie-name, for some time: <modify-cookie cookie-name="xyz"/> will be equivalent to <modifyCookie cookieName="xyz"/>