Laravel naming convention for blade files

Question

I know that naming conventions in Laravel is covered in another question, but blade files are not covered there. I read several blogs and forums and they all offer different approach so I want to ask here:

My controller method is AdminController@listPropertyTypes - which lists and manages the property types..

One blog suggests:

/resources/views/admin/property/types.blade.php

Another blogs suggest underscore or no space:

/resources/views/admin/property_types.blade.php
/resources/views/admin/propertytypes.blade.php

I would personally named this way since it is a view:

/resources/views/admin/property-types.blade.php

Is there a best practice or PSR rule for this?

Best practice? I don't believe so, and PSR rule, these are general rules for PHP standards, Blade is a Laravel specific, so no. As long as you are consistent across your codebase and you/your team are all happy with the convention you decide to use then do whatever you like. — James, May 14 '20 at 22:31
If you are asking about best practices, then one suggestion would be to strictly use CRUD controllers; AdminController@listPropertyTypes is not CRUD. AdminPropertyTypesController@index is more "best practice". — James, May 14 '20 at 22:32
I use this convetions https://github.com/alexeymezenin/laravel-best-practices — Arash Younesi, Mar 24 '21 at 19:14

score 31 · Accepted Answer · edited Dec 28 '22 at 16:53

31

EDIT: Laravel community mostly use kebab-case or camelCase

ie views/admin/property-types.blade.php or views/admin/propertyTypes.blade.php

Laravel's creator seems to use kebab-case, but Spatie recommends camelCase.

As @MrEduar explained it, there is no strict convention.

NB: https://www.laravelbestpractices.com website is abandonned and not affiliated with Laravel.

OLD: Initial answer

I came across Laravel Best Practices.

Laravel : Best Practices aims to put together all the resources and best practices in using the Laravel Framework. Last Updated: 2020-05-07 12:26:48

Views

You SHOULD use snake_case as file name of your Blade templates

Good

show_filtered.blade.php

Bad

showFiltered.blade.php
show-filtered.blade.php

edited Dec 28 '22 at 16:53

4wk_

2,458
3
34
46

answered May 15 '20 at 03:41

Digvijay

7,836
3
32
53

1

Thanks. I'm not that comfortable with this naming convention but I'll go this way. – tolga May 15 '20 at 09:19
15

Hm Taylor himself uses kebab-case like in https://github.com/illuminate/pagination/tree/master/resources/views – shock_gone_wild Jun 15 '20 at 08:10
Basically, I usually go for kebab-case for naming my routes as well as the view. It works out pretty well. – Channaveer Hakari Apr 14 '21 at 16:24
3

https://github.com/alexeymezenin/laravel-best-practices suggests kebab case naming – Terry Lin Sep 10 '21 at 17:05
https://www.laravelbestpractices.com/#views is now an abandonned website. I agree with @shock_gone_wild and go with kebab-case – 4wk_ Dec 28 '22 at 16:41

score 4 · Answer 2 · edited Dec 28 '22 at 16:55

For blade file names, there is no convention as such. But as @James says in his commentary, and I quote

If you are asking about best practices, then one suggestion would be to strictly use CRUD controllers; AdminController@listPropertyTypes is not CRUD. AdminPropertyTypesController@index is more "best practice".

And in this case the best way would be /resources/views/admin/property/types.blade.php.

You can read more about this in Laracon 2017 or in Adam Watham's github repository where he explains it further.

If you are not happy with this result I suggest you also use CamelCase According to the Spatie Guidelines

resources/
  views/
    openSource.blade.php

So, in the controller

class OpenSourceController
{
    public function index() {
        return view('openSource');
    }
}

Instead of looking at unreliable blogs, be guided by the great minds of the Laravel community.

Fixed Spatie broken URL (again); and +1 for the "unreliable blogs" warning! — 4wk_, Dec 28 '22 at 16:54

Laravel naming convention for blade files

2 Answers2

EDIT: Laravel community mostly use kebab-case or camelCase

OLD: Initial answer