feat: add toBeCasedCorrectly arch test assertion #1455
+36
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What:
Description:
This PR adds a new arch test assertion that compares the file path and namespace casing with each other to detect casing errors.
As most developers work on Mac OS or Windows, which by default have case insensitive file systems, these casing spelling errors might not be caught until deployed on linux environments.
This feature helps solve this issue by comparing both namespace and file path with each other.
Important:
This PR depends on the following PR in the
pest-plugin-archplugin: pestphp/pest-plugin-arch#27Example:
File path:
app/Providers/AppServiceProvider.phpThe wrongly cased namespace part 'providers' will not cause a 'Class not found' exception on Mac OS, but will on linux.
With this feature, we can add the following test:
This will catch the miss-cased namespaces / file paths