rspec/rules/S100/ruby/rule.adoc

== Why is this an issue?

Shared naming conventions allow teams to collaborate efficiently.

This rule raises an issue when a method name does not match a provided regular expression.

For example, with the default provided regular expression, the following method:

[source,ruby]
----
def methodName # Noncompliant
   expr..
end
----

should be renamed to

[source,ruby]
----
def method_name
   expr..
end
----


ifdef::env-github,rspecator-view[]

'''
== Implementation Specification
(visible only on this page)

include::../message.adoc[]

=== Parameters

.format
****
_STRING_

----
^(@{0,2}[\da-z_]+[!?=]?)|([*+-/%=!><~]+)|(\[]=?)$
----

Regular expression used to check the function
****


'''
== Comments And Links
(visible only on this page)

include::../comments-and-links.adoc[]

endif::env-github,rspecator-view[]