rspec/rules/S2304/vbnet/rule.adoc

54 lines
1.1 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2020-06-30 12:48:07 +02:00
Shared coding conventions allow teams to collaborate efficiently. This rule checks that all namespace names match a provided regular expression.
2021-02-02 15:02:10 +01:00
2020-06-30 12:48:07 +02:00
The default configuration is the one recommended by Microsoft:
2020-06-30 12:48:07 +02:00
* Pascal casing, starting with an upper case character, e.g. Microsoft, System
* Short abbreviations of 2 letters can be capitalized, e.g. System.IO
* Longer abbreviations need to be lower cased
=== Noncompliant code example
2020-06-30 12:48:07 +02:00
2021-01-27 13:42:22 +01:00
With the default regular expression: ``++^([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?(\.([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2}))*$++``
2022-02-04 17:28:24 +01:00
[source,vbnet]
2020-06-30 12:48:07 +02:00
----
Namespace foo ' Noncompliant
End Namespace
----
=== Compliant solution
2020-06-30 12:48:07 +02:00
2022-02-04 17:28:24 +01:00
[source,vbnet]
2020-06-30 12:48:07 +02:00
----
Namespace Foo ' Compliant
End Namespace
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Rename this namespace to match the regular expression "rrr".
=== Parameters
.format
****
----
^([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?(\.([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2}))*$
----
Regular expression used to check the namespace names against.
****
endif::env-github,rspecator-view[]