rspec/rules/S2519/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

62 lines
905 B
Plaintext

== Why is this an issue?
Shared coding conventions allow teams to collaborate efficiently. This rule checks that all record field names match the provided regular rexpression.
=== Noncompliant code example
With the default regular expression ``++[a-zA-Z](_?+[a-zA-Z0-9])*+++``:
[source,sql]
----
DECLARE
TYPE my_type IS RECORD(
foo__bar PLS_INTEGER -- Non-Compliant
);
BEGIN
NULL;
END;
/
----
=== Compliant solution
[source,sql]
----
DECLARE
TYPE my_type IS RECORD(
foo_bar PLS_INTEGER -- Compliant
);
BEGIN
NULL;
END;
/
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Rename this record field to match the provided regular expression: xxx.
=== Parameters
.regexp
****
----
[a-zA-Z](_?+[a-zA-Z0-9])*+
----
The regular expression the field should match.
****
endif::env-github,rspecator-view[]