rspec/rules/S1578/dart/rule.adoc
2024-09-03 07:51:12 +00:00

35 lines
907 B
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

== Why is this an issue?
Shared coding conventions allow teams to collaborate effectively. For that reason, file names should conform to a defined standard.
In Dart the convention is to name files using lowercase with underscore.This rule raises an issue when the names of analyzed files dont match this convention.
This convention also helps to operate with different file systems, which may be case-insensitive.
These file names will violate convention:
* MyFile.dart
* myFile.dart
* my-file.dart
* My_File.dart
And the proper name in this case will be:
* my_file.dart
== Resources
* Dart Docs - https://dart.dev/tools/linter-rules/file_names[Dart Linter rule - file_names]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
The file name 'xxx' isn't a lower_case_with_underscores identifier.
endif::env-github,rspecator-view[]