Spatie Phecks Example

This is an example repository of a Phecks implementation using Spatie's styleguides.

php artisan phecks:run

List of Spatie's style guide

Configuration files must use kebab-case (ConfigFilesMustUseRightCaseCheck).
Configuration keys must use snake_case (ConfigKeysMustUseRightCaseCheck).
Avoid using the env helper outside of configuration files. Create a configuration value from the env variable like above.

The names given to artisan commands should all be kebab-cased. (CommandNamesShouldUseKebabCaseCheck)

Public-facing urls must use kebab-case (PublicFacingUrlsMustUseKebabCaseCheck).
Prefer to use the route tuple notation when possible.
Route names must use camelCase (RouteNamesMustUseCamelCaseCheck).
All routes have an HTTP verb, that's why we like to put the verb first when defining a route. It makes a group of routes very readable. Any other route options should come after it.
Route parameters should use camelCase (RouteParametersMustUseCamelCaseCheck).
A route url should not start with / unless the url would be an empty string.

Try to keep controllers simple and stick to the default CRUD keywords (index, create, store, show, edit, update, destroy). Extract a new controller if you need other actions. (ControllerMethodsMustStickToCrudCheck).

Translations must be rendered with the __ function. We prefer using this over @lang in Blade views because __ can be used in both Blade views and regular PHP code.

Resources classes must be suffixed with Resource.
Listeners classes must be suffixed with Listener, and not refer to an Event, but to what they do.
Commands classes must be suffixed with Command. (ConsoleClassesMustBeSuffixedWithCommandCheck).
Mailables must be suffixed with Mail.
Enums don't need to be suffixed with Enum.