Introducing the make:package Command for Laravel

[Rayiumir]

The goal of this proposal is to introduce a new Artisan command make:package to Laravel. This command will automatically generate the necessary structure and files for a Laravel package, And this makes it easier for developers.

The make:package command will allow developers to generate the a new package with a single command, avoiding the need to manually create directories and files for common elements of a Laravel package.

Features:

Directory Structure: The command will generate a set of standard directories, including.

• src/: Contains the PHP source code for the package.

• config/: For configuration files.

• resources/: For views, translations, etc.

• routes/: For defining package routes.

Files Generated:

• composer.json: Automatically generates a Composer file, including PSR-4 autoloading for the package.

• README.md: Provides a basic readme file with the package name and description.

Command Syntax:

php artisan make:package {PackageName}

Example:

php artisan make:package MyNewPackage

This command will create the following structure in the packages/{vendor}/ directory:

packages/
└── {vendor}/
    └── MyNewPackage/
        ├── src/
        ├── config/
        ├── resources/
        ├── routes/
        ├── composer.json
        └── README.md

Why This Feature:

Creating reusable packages in Laravel is a common task for many developers, especially when working on large applications or multi-project systems. However, setting up the basic structure for a package can be tedious and error-prone, especially when you need to create multiple packages. By adding this command, Laravel would streamline the process and help developers focus more on their package logic rather than setup.

How it Works:

• The command accepts the package name as an argument and creates a new folder with the specified name.

• It generates a default composer.json file with PSR-4 autoloading configured for the src/ directory.

• It creates a basic README.md file with the package name and a description.

• Additional directories like config/, resources/, and routes/ are created to follow Laravel’s typical package structure.

Example Use Case:

Imagine a scenario where a developer needs to create multiple packages for different features in their Laravel project. Instead of manually setting up each package’s file structure, they can simply run:

php artisan make:package UserManagement

Each command will create the necessary files and folders for the respective package, saving time and ensuring consistency across all packages.

Conclusion:

The make:package Artisan command will improve the developer experience by simplifying the process of creating reusable Laravel packages. It would promote best practices for package structure and help maintain consistency in package development. This feature will be especially beneficial for large projects that require multiple packages, reducing setup time and potential errors.

I’d love to hear your thoughts on this and would be happy to open a Pull Request if this sounds like a feature worth including in the core.

Thanks and best regards!

[henzeb]

What are the benefits over https://spatie.be/courses/laravel-package-training-v2/starting-a-laravel-package-using-the-skeleton
?

[Rayiumir]

What are the benefits over https://spatie.be/courses/laravel-package-training-v2/starting-a-laravel-package-using-the-skeleton ?

The advantage is that you create a package once with the make:package command and you don't need to create everything manually and you do the rest.

[henzeb]

But doesn't spatie's solution not do that for you as well?

[Rayiumir]

But doesn't spatie's solution not do that for you as well?

It does.
But this idea I mentioned is going to be packaged and I don't think this Laravel feature will be approved.
My preference is for packages to be simple, uncomplicated, and complete.

[henzeb]

It is not a laravel feature, nor will it ever be, even if Taylor wants something like it. It will always be an external package. It is a template for a package that handles laravel stuff, having it inside laravel makes no sense, as you need to setup laravel just to start a package. I find it way easier to use the spatie template, then to install or abuse an existing laravel installation for this.

Again, what are the benefits to use this over the template provided by Spatie?

[Rayiumir]

It is not a laravel feature, nor will it ever be, even if Taylor wants something like it. It will always be an external package. It is a template for a package that handles laravel stuff, having it inside laravel makes no sense, as you need to setup laravel just to start a package. I find it way easier to use the spatie template, then to install or abuse an existing laravel installation for this.

Again, what are the benefits to use this over the template provided by Spatie?

No external dependencies: You don't need to install additional packages or tools and it works right within your Laravel application.

Customization flexibility: Since you own the code, you can easily modify the generator to match your specific needs, coding standards.

Interactive mode: The --interactive flag provides a guided, step-by-step approach to package creation that can be more user-friendly than working from a static template.

Multiple package types: Built-in support for different package types (admin panels, API services, themes) with appropriate directory structures for each.

Integrated workflow: Packages are created directly in your packages directory, making local development and testing more straightforward.

No learning curve: If you're already familiar with Laravel's Artisan commands, there's nothing new to learn - the syntax and options follow Laravel conventions.

Maintenance control: You're not dependent on third-party updates or changes to the skeleton structure.

[Rayiumir]

I created the package, take a look.

https://github.com/LaraPire/laravel-package

[henzeb]

I still don't see why I have to install it into an existing laravel application to use it.

[Rayiumir]

I still don't see why I have to install it into an existing laravel application to use it.

Suppose you have to manually create folders and files to create a package, rename them, move them, and create a basic structure, and that can be time-consuming.

You create a package with a basic structure with one command, and you develop the rest.

I wrote it for convenience.

[henzeb]

https://github.com/spatie/package-skeleton-laravel

alll I have to do is click on "use this template" and run configure.php

it doesn't involve abusing an existing laravel installation or creating one just for this purpose.

[Rayiumir]

https://github.com/spatie/package-skeleton-laravel

alll I have to do is click on "use this template" and run configure.php

it doesn't involve abusing an existing laravel installation or creating one just for this purpose.

Well, I developed the package using a different approach, so I didn't use the 'Use this template' option from the package-skeleton-laravel.

[henzeb]

Sure,if that is what you want, I just don't see the benefits over something that has been battle tested ...

[shaedrich]

I would assume this to make more sense as a new command of the Laravel installer

[shaedrich]

Not sure if the Laravel team would be willing and have the time to support this themselves but if that was the case, it'd be nice, especially for beginners, to have an easy first-party starting point when developing packages.

[henzeb]

maybe, but it is community driven, right? I don't know how to approach this, but it must be feasible to add support for this. Or creating an laravel-package installer could also be an option.

[shaedrich]

maybe, but it is community driven, right?

Exactly 👍🏻

[mohammadrasoulasghari]

I agree with @shaedrich.

In most Laravel projects, there's usually no need to create a separate package, since many business projects are private and not meant for reuse.

However, adding this feature to the Laravel installer could help developers create packages more easily when needed.

[shaedrich]

The next possible step then could be to add installing packages right to the existing new command and even a new command for discovering packages with slightly more fine-tuned Laravel-specific output than Composer 🤔

[masihgh]

its a good idea, this helps developers to create better and same struct for packages, im so exited about this issue

[amizayi]

Can this new command also automatically brew a cup of coffee? Because with all this automation, we should be able to enjoy the finer things in life too!:)

[shaedrich]

brew install laravel/installer && laravel new-package my-awesome-package you mean? 🧐

[Parsa-Biazar]

Can this new command also automatically brew a cup of coffee? Because with all this automation, we should be able to enjoy the finer things in life too!:)

فاک یو 😁

[Rayiumir]

This idea seems to be well received.
I add a new laravel package to the laravel installer, it's fine and the package creation features are exactly the same as the laravel package I added.

Example of the following command:

laravel new package

[shaedrich]

I wouldn't do that. This means, you are modifying the new command and package is an option. I'd suggest creating a second command there as this does something quite different from the new command.

[Rayiumir]

I wouldn't do that. This means, you are modifying the new command and package is an option. I'd suggest creating a second command there as this does something quite different from the new command.

Well, I'm not going to change the Laravel command.

I'm going to create a new command with PackageCommand.php.