[8.x] New flag --requests -R to make:controller and make:model Commands #39120

PovilasKorop · 2021-10-06T16:31:59Z

This PR adds a new flag to php artisan make:controller command, which creates FormRequest class and uses it immediately in the generated controller.

Problem

How I personally use Resourceful Controllers with Form Requests:

php artisan make:controller UserController --resource
php artisan make:request StoreUserRequest
php artisan make:request UpdateUserRequest
Go to the UserController and manually replace Illuminate\Http\Request with those new FormRequest classes

Why couldn't we generate it all at once?

This problem resonated with my Twitter audience, with 180+ likes on this Tweet.

My Proposed Solution (updated October 7)

Now, when you run php artisan make:controller UserController --resource --model=User --requests, it will generate two FormRequest classes: StoreUserRequest and UpdateUserRequest, and will replace them in the Controller.

A short version of --requests flag is -R, not to mix with -r for resources.

It is done by reusing the make:request command and calling it with appropriate class name.

This functionality works only together with --model flag, otherwise it would be impossible/hard to guess the name for the FormRequest classes.

Also, it works one "layer" above in the Model: php artisan make:model Project -mcrR would generate StoreProjectRequest and UpdateProjectRequest

Breaking changes

It shouldn't break any existing functionality, it's just a new flag. If that flag isn't used, it all falls back to the old default values.

Any other suggestions for improvement are welcome.

tontonsb · 2021-10-06T17:02:47Z

For me the "make everything" method is make:model. I usually do php artisan make:model -mrc User and that's where a request flag would be useful as well. It would also solve your "--model is a must" problem.

I am not suggesting to remove anything, but that proxying the new flags from make:model to make:controller would make this more useful. At least in my workflow.

PovilasKorop · 2021-10-06T17:06:37Z

Thanks @tontonsb

For me the "make everything" method is make:model. I usually do php artisan make:model -mrc User and that's where a request flag would be useful as well. It would also solve your "--model is a must" problem.

I thought about it, but to me, it feels like opening a deeper "rabbit hole / inception".
Not sure, maybe someone will comment, should I add --request(s) to the model as well, then? But there's no "short" for -mrc then cause letter r is already taken for resource controllers

So now sure how elegant it would be php artisan make:model Project -mcr --requests

Opinions?

taylorotwell · 2021-10-06T18:44:06Z

I think @tontonsb has a pretty good point but I also do not have a good solution for the shortcut... only thing I can think of is h for "HTTP Requests"... 🤷‍♂️ but that isn't great.

caugner · 2021-10-06T18:44:07Z

So now sure how elegant it would be php artisan make:model Project -mcr --requests

Maybe -x for --requests would be a viable alternative (as in curl -X)? Or even -R.

PS: If we introduced uppercase letters, -A could become a shorthand for --api (or -C for -c --api).

taylorotwell · 2021-10-06T18:44:54Z

I think @caugner's suggestion of capital R is not bad.

PovilasKorop · 2021-10-06T18:47:40Z

@caugner great suggestion about -R, I agree, will implement tomorrow.

caugner · 2021-10-06T18:56:13Z

Just to add two more ideas:

An interactive mode (-i), especially for beginners and devs that don't know yet what they want.
A wizard mode (-w) that determines the choices based on which items already exist and which namespaces the project already uses.

taylorotwell · 2021-10-06T18:57:42Z

That might be a bit out of scope on this PR 😅

PovilasKorop · 2021-10-06T18:58:58Z

@caugner I agree with @taylorotwell - I guess I will create a full wizard with bells and whistles in the future :)

tontonsb · 2021-10-06T19:25:38Z

PS: If we introduced uppercase letters, -A could become a shorthand for --api (or -C for -c --api).

It's not an "if". We already have -V for version and -v for verbosity.

However, --request and --requests sounds like something that would correspond to lowercase and uppercase of the same letter. Or are you only shorthanding one of them? Which one then?

taylorotwell · 2021-10-06T19:58:14Z

@PovilasKorop I personally only think you should include the requests version and not the single request. I typically would never create a single request to handle both create and update.

TomHAnderson · 2021-10-06T21:06:12Z

src/Illuminate/Routing/Console/ControllerMakeCommand.php

+
+        $namespacedRequests = $namespace.'\\'.$storeRequestClass.';';
+        if ($storeRequestClass != $updateRequestClass) {
+            $namespacedRequests .= "\r\nuse ".$namespace.'\\'.$updateRequestClass.';';


The use of \r here is not a UNIX standard linebreak.

@TomHAnderson good notice, fixed in these:

93b5600

397de40

TomHAnderson · 2021-10-07T00:33:28Z

I think this PR should include a reference to a complimentary PR in the docs.

PovilasKorop · 2021-10-07T06:20:14Z

@PovilasKorop I personally only think you should include the requests version and not the single request. I typically would never create a single request to handle both create and update.

Yup, agreed, me too. Removed the singular --request.

Also, pushed the changes for make:model --requests flag like @tontonsb suggested, and for accepting -R as a short version.

@TomHAnderson will submit a PR to the docs then this PR is fully merged, then I will know which flag to put where in the docs.

SjorsO · 2021-10-07T14:03:38Z

Just to add two more ideas:

An interactive mode (-i), especially for beginners and devs that don't know yet what they want.

A wizard mode (-w) that determines the choices based on which items already exist and which namespaces the project already uses.

Slightly related, I tweeted about a proof of concept for artisan make:migration --interactive a while back:

gif.mp4

I think a similar interactive mode for make:model would definitely improve the developer experience.

PovilasKorop · 2021-10-27T04:05:06Z

@taylorotwell sorry for pushing but is there any reason why this PR wasn't merged/released in 20 days? Anything I still need to improve here?

taylorotwell · 2021-11-04T14:26:04Z

I have mainly been hesitating because this is somewhat related to and close to functionality I was considering building in a laravel/concepts package that was a generator building out an entire "concept"'s files in your application. Typically, related to a model.

So, php artisan make:concept Invoice generates controllers, requests, tests, events, and so on for that concept, and it also generated store and update requests like this PR does.

I've been debating if I want to pursue that package or not so that has caused the hesitation here.

PovilasKorop · 2021-11-04T14:40:15Z

@taylorotwell ok feel free to take over, this would be similar to "full wizard with bells and whistles in the future" I was referring to, earlier.

To be honest, there are a lot of CRUD generator packages/services on the market already, so that functionality is largely covered by those packages. But I think the community would appreciate something like that inside the framework itself.

Just keep in mind the potential overhead of all the potential combinations of those files that may have their content depending on each other, at least in my experience the scope can grow quite quickly. But if you're up for the challenge, go for it, and let me know if I can contribute.

DarkGhostHunter · 2021-11-04T14:46:45Z

I have mainly been hesitating because this is somewhat related to and close to functionality I was considering building in a laravel/concepts package that was a generator building out an entire "concept"'s files in your application. Typically, related to a model.

So, php artisan make:concept Invoice generates controllers, requests, tests, events, and so on for that concept, and it also generated store and update requests like this PR does.

I've been debating if I want to pursue that package or not so that has caused the hesitation here.

I vote for this solution so I can stop maintaining Larawiz.

dragonfly4 · 2021-11-18T16:37:55Z

@PovilasKorop Thanks for this PR!

Would you consider a follow-up release to create the Request files in the correct subfolder? Saves time to move 2 files and edit 3 of them. Or is that blocked by default Laravel behaviour?

Simple example

php artisan make:model "Accounting\CustomerAddress" -crmfR

This will create a new model under App\Models\Accounting
The Controller is created under App\Http\Controllers
The Requests are created under App\Http\Requests

PovilasKorop · 2021-11-18T20:41:04Z

@dragonfly4 I thought about it but had a doubt if everyone would want to create subfolders for the requests exactly as for models.

Also, it would require quite a lot of work to make it properly, for now I moved on to other work and don't have that much time, sorry

PovilasKorop added 5 commits October 6, 2021 19:16

Add --request --requests flags to make:controller --model=X

6685a9b

Merge branch 'laravel:8.x' into 8.x

f1b4bc1

Styling fixes after Style CI report

bbf4d6e

Merge branch '8.x' of https://github.com/PovilasKorop/framework into 8.x

b9ee3e1

One more Style CI fix

2bd4606

GrahamCampbell changed the title ~~New flags --request --requests to make:controller Command~~ [8.x] New flags --request --requests to make:controller Command Oct 6, 2021

Style CI again

4f58e18

TomHAnderson reviewed Oct 6, 2021

View reviewed changes

lloricode approved these changes Oct 7, 2021

View reviewed changes

PovilasKorop added 5 commits October 7, 2021 09:09

Added --requests -R flag to the related make:model command

592e81b

Replace \r\n with a proper PHP_EOL

93b5600

Remote --request single flag, leaving only plural --requests

f58278f

Accept -R as a short flag for --requests

09e973b

Style CI - no need for double quotes anymore

397de40

PovilasKorop changed the title ~~[8.x] New flags --request --requests to make:controller Command~~ [8.x] New flag --requests -R to make:controller and make:model Commands Oct 7, 2021

taylorotwell merged commit 397de40 into laravel:8.x Nov 5, 2021

PovilasKorop mentioned this pull request Nov 11, 2021

[8.x] Make:model --all flag would auto-fire make:controller with --requests #39578

Merged

abbasudo mentioned this pull request Nov 27, 2021

[8.x] name convention changed for -R flag #39791

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[8.x] New flag --requests -R to make:controller and make:model Commands #39120

[8.x] New flag --requests -R to make:controller and make:model Commands #39120

PovilasKorop commented Oct 6, 2021 •

edited

Loading

tontonsb commented Oct 6, 2021

PovilasKorop commented Oct 6, 2021

taylorotwell commented Oct 6, 2021 •

edited

Loading

caugner commented Oct 6, 2021 •

edited

Loading

taylorotwell commented Oct 6, 2021

PovilasKorop commented Oct 6, 2021

caugner commented Oct 6, 2021

taylorotwell commented Oct 6, 2021

PovilasKorop commented Oct 6, 2021

tontonsb commented Oct 6, 2021

taylorotwell commented Oct 6, 2021

TomHAnderson Oct 6, 2021

PovilasKorop Oct 7, 2021

TomHAnderson commented Oct 7, 2021

PovilasKorop commented Oct 7, 2021

SjorsO commented Oct 7, 2021

PovilasKorop commented Oct 27, 2021

taylorotwell commented Nov 4, 2021

PovilasKorop commented Nov 4, 2021

DarkGhostHunter commented Nov 4, 2021

dragonfly4 commented Nov 18, 2021 •

edited

Loading

PovilasKorop commented Nov 18, 2021

[8.x] New flag --requests -R to make:controller and make:model Commands #39120

[8.x] New flag --requests -R to make:controller and make:model Commands #39120

Conversation

PovilasKorop commented Oct 6, 2021 • edited Loading

Problem

My Proposed Solution (updated October 7)

Breaking changes

tontonsb commented Oct 6, 2021

PovilasKorop commented Oct 6, 2021

taylorotwell commented Oct 6, 2021 • edited Loading

caugner commented Oct 6, 2021 • edited Loading

taylorotwell commented Oct 6, 2021

PovilasKorop commented Oct 6, 2021

caugner commented Oct 6, 2021

taylorotwell commented Oct 6, 2021

PovilasKorop commented Oct 6, 2021

tontonsb commented Oct 6, 2021

taylorotwell commented Oct 6, 2021

TomHAnderson Oct 6, 2021

Choose a reason for hiding this comment

PovilasKorop Oct 7, 2021

Choose a reason for hiding this comment

TomHAnderson commented Oct 7, 2021

PovilasKorop commented Oct 7, 2021

SjorsO commented Oct 7, 2021

PovilasKorop commented Oct 27, 2021

taylorotwell commented Nov 4, 2021

PovilasKorop commented Nov 4, 2021

DarkGhostHunter commented Nov 4, 2021

dragonfly4 commented Nov 18, 2021 • edited Loading

PovilasKorop commented Nov 18, 2021

PovilasKorop commented Oct 6, 2021 •

edited

Loading

taylorotwell commented Oct 6, 2021 •

edited

Loading

caugner commented Oct 6, 2021 •

edited

Loading

dragonfly4 commented Nov 18, 2021 •

edited

Loading