2023-11-08 23:16:29 +00:00
|
|
|
module Ameba::Rule::Naming
|
2017-11-04 20:54:27 +00:00
|
|
|
# A rule that enforces method names to be in underscored case.
|
|
|
|
#
|
|
|
|
# For example, these are considered valid:
|
|
|
|
#
|
|
|
|
# ```
|
|
|
|
# class Person
|
|
|
|
# def first_name
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# def date_of_birth
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# def homepage_url
|
|
|
|
# end
|
|
|
|
# end
|
|
|
|
# ```
|
|
|
|
#
|
|
|
|
# And these are invalid method names:
|
|
|
|
#
|
|
|
|
# ```
|
|
|
|
# class Person
|
|
|
|
# def firstName
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# def date_of_Birth
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# def homepageURL
|
|
|
|
# end
|
|
|
|
# end
|
|
|
|
# ```
|
2017-11-14 07:24:36 +00:00
|
|
|
#
|
|
|
|
# YAML configuration example:
|
|
|
|
#
|
|
|
|
# ```
|
2023-11-08 23:16:29 +00:00
|
|
|
# Naming/MethodNames:
|
2017-11-14 07:24:36 +00:00
|
|
|
# Enabled: true
|
|
|
|
# ```
|
2021-01-18 15:45:35 +00:00
|
|
|
class MethodNames < Base
|
2017-11-22 06:44:29 +00:00
|
|
|
properties do
|
2018-05-03 15:57:47 +00:00
|
|
|
description "Enforces method names to be in underscored case"
|
2017-11-22 06:44:29 +00:00
|
|
|
end
|
|
|
|
|
2018-04-17 04:29:43 +00:00
|
|
|
MSG = "Method name should be underscore-cased: %s, not %s"
|
|
|
|
|
2017-11-04 20:54:27 +00:00
|
|
|
def test(source, node : Crystal::Def)
|
|
|
|
return if (expected = node.name.underscore) == node.name
|
2022-12-08 13:06:16 +00:00
|
|
|
|
2023-11-12 01:50:17 +00:00
|
|
|
issue_for node, MSG % {expected, node.name}, prefer_name_location: true
|
2017-11-04 20:54:27 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|