rspec/rules/S2520/plsql/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
Inline adoc files when they are included exactly once.

Also fix language tags because this inlining gives us better information
on what language the code is written in.
2023-05-25 14:18:12 +02:00

58 lines
899 B
Plaintext

== Why is this an issue?
Shared coding conventions allow teams to collaborate efficiently. This rule checks that object attribute names match the provided regular expression.
=== Noncompliant code example
With the default regular expression ``++[a-zA-Z](_?+[a-zA-Z0-9])*+++`` :
[source,sql]
----
CREATE TYPE my_type AS OBJECT(
foo__bar INTEGER -- Non-Compliant
);
/
DROP TYPE my_type;
----
=== Compliant solution
[source,sql]
----
CREATE TYPE my_type AS OBJECT(
foo_bar INTEGER -- Compliant
);
/
DROP TYPE my_type;
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Rename this attribute to match the provided regular expression: xxx
=== Parameters
.format
****
----
[a-zA-Z](_?+[a-zA-Z0-9])*+
----
The regular expression the name should match
****
endif::env-github,rspecator-view[]