search

art-institute-of-chicago / data-aggregator

An API of public data collected from several different systems at the Art Institute of Chicago
GNU Affero General Public License v3.0
65 stars 6 forks source link

Laravel Linter #3

Open IllyaMoskvin opened 5 years ago

IllyaMoskvin commented 5 years ago

This pull request includes changes and recommendations for crafting your application "The Laravel Way". Feel free to commit any additional changes to the shift-13376 branch.

Before merging, you should:

If you want help with your upgrade, check out the Shift Human Services or join the Shifty Coders Slack room to get answers to all your Laravel questions.

IllyaMoskvin commented 5 years ago

:warning: Shift found uses of the old array() syntax. Laravel adopted the short array syntax [] since it became available in PHP 5.4.

IllyaMoskvin commented 5 years ago

:warning: Shift found instances of string based class references. Laravel adopted the ::class static property since it became available in PHP 5.5. You should update your code to use references like App\SomeModel::class instead of strings like 'App\SomeModel'.

IllyaMoskvin commented 5 years ago

:warning: The following files reference Laravel facades through the global namespace. For example, you're referencing \DB or importing use DB. Instead import Illuminate\Support\Facades\DB and reference DB.

While global references are allowed through aliases, you should import the facade explicitly. This can improve clarity not only for developers, but static analysis used by your IDE.

IllyaMoskvin commented 5 years ago

:warning: The following classes do not extend the standard Laravel Model and Controller class. This may add complexity which makes your application harder to upgrade. Often a trait can be used instead of inheritance. You should review the following classes:

IllyaMoskvin commented 5 years ago

:warning: The following controllers contain actions outside of the 7 resource actions (index, create, store, show, edit, update, destroy). For more details, review the docs or watch Cruddy by Design to see if you can rework these into resource controllers.

IllyaMoskvin commented 5 years ago

:warning: Shift detected the following HTTP components using the Request or Input facade to access the request. Within these components you should leverage the request object which is automatically injected to any controller action or Middleware.

IllyaMoskvin commented 5 years ago

:warning: Laravel 5.2 added the env configuration option. Laravel recommends you only use env() within configuration files and use config() everywhere else.

Shift found potential uses of env() in:

IllyaMoskvin commented 5 years ago

:x: Shift could not run composer install for your application. As such, the analysis for lines of code are unavailable.

IllyaMoskvin commented 5 years ago

:warning: Shift found the following config files differ from the defaults. While you are welcome to customize your configuration, you should leverage ENV variables rather than hardcode values. If you find you're adding a lot of configuration options, consider creating a domain specific config file, such as core.php. Both will make app upgrades and deployments easier.

IllyaMoskvin commented 5 years ago

:information_source: As noted, much of the code detected above can be automatically fixed using the Laravel Fixer. Save yourself time and clean up your codebase quickly with this new Shift.