Laravel Package Tools

https://github.com/spatie/laravel-package-tools
Admin
A package that provides a PackageServiceProvider to easily register config files, migrations, and...
Tokens:34,935
Snippets:317
Trust Score:10
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### ConfigurePackage with InstallCommand lifecycle

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/install-command.md

Example of configuring the full installation lifecycle, including custom start and end closures, within the configurePackage method.

```php
public function configurePackage(Package $package): void
{
    $package
        ->name('your-package-name')
        ->hasConfigFile()
        ->hasMigration('create_package_tables')
        ->publishesServiceProvider('MyServiceProviderName')
        ->hasInstallCommand(function(InstallCommand $command) {
            $command
                ->startWith(function(InstallCommand $command) {
                    $command->info('Hello, and welcome to my great new package!');
                })
                ->publishConfigFile()
                ->publishAssets()
                ->publishMigrations()
                ->askToRunMigrations()
                ->copyAndRegisterServiceProviderInApp()
                ->askToStarRepoOnGitHub('your-vendor/your-repo-name')
                ->endWith(function(InstallCommand $command) {
                    $command->info('Have a great day!');
                });
        });
}
```

--------------------------------

### Add startWith and endWith to InstallCommand

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Extends the install command with `startWith` and `endWith` closures that run at the beginning and end of the install command, allowing extra output or work. The example shows displaying welcome and farewell messages.

```php
use Spatie\LaravelPackageTools\Commands\Concerns;

public function configurePackage(Package $package): void
{
    $package
        // ... configure package
        ->hasInstallCommand(function(InstallCommand $command) {
            $command
                ->startWith(function(InstallCommand $command) {
                    $command->info('Hello, and welcome to my great new package!');
                })
                ->publishConfigFile()
                ->publishAssets()
                ->publishMigrations()
               ->askToRunMigrations()
                ->copyAndRegisterServiceProviderInApp()
                ->askToStarRepoOnGitHub('your-vendor/your-repo-name')
                ->endWith(function(InstallCommand $command) {
                    $command->info('Have a great day!');
                })
        });
}
```

--------------------------------

### Using basePath()

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Example showing basePath() without arguments returning the base path, and with a relative directory that gets appended.

```php
$package->basePath();                      // '/vendor/my-package/src'
$package->basePath('/../resources/dist');  // '/vendor/my-package/src/../resources/dist'
```

--------------------------------

### AskToStarRepoOnGitHub Usage Example

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/command-concerns.md

Example of calling the askToStarRepoOnGitHub method.

```php
$command->askToStarRepoOnGitHub('your-vendor/your-repo-name');
// prompts: "Would you like to star our repo on GitHub?" (default: no)
```

--------------------------------

### SupportsStartWithEndWith Usage Example

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/command-concerns.md

Example showing how to chain startWith and endWith methods on a command instance.

```php
$command
    ->startWith(function(InstallCommand $command) {
        $command->info('Starting install...');
    })
    ->endWith(function(InstallCommand $command) {
        $command->info('Install finished!');
    });
```

--------------------------------

### hasConfigFile() usage example with multiple files

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Example call to hasConfigFile() with an array of config file names.

```php
$package->hasConfigFile(['my-config-file', 'another-config-file']);
```

--------------------------------

### bootingPackage()

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

No-op lifecycle hook invoked at the start of boot().

```APIDOC
## bootingPackage()

### Description
No-op lifecycle hook invoked at the **start** of `boot()`.

### Method
bootingPackage

### Signature
```php
public function bootingPackage()
{
}
```

### Parameters
None.

### Returns
`null`.
```

--------------------------------

### Usage example for copyAndRegisterServiceProviderInApp

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/command-concerns.md

Demonstrates invoking the method to publish the stub and register the provider.

```php
$command->copyAndRegisterServiceProviderInApp();
// handle(): publishes stub → copies app/Providers/{name}.php → registers in app provider list
```

--------------------------------

### Configure hasInstallCommand with publish and prompt actions

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Configures a package service provider to include an install command that publishes config, assets, and migrations, copies and registers a service provider, and prompts for migrations and starring the repo. The user can then run `php artisan your-package-name:install` to execute these steps.

```php
use Spatie\LaravelPackageTools\PackageServiceProvider;
use Spatie\LaravelPackageTools\Package;
use Spatie\LaravelPackageTools\Commands\Concerns;

class YourPackageServiceProvider extends PackageServiceProvider
{
    public function configurePackage(Package $package): void
    {
        $package
            ->name('your-package-name')
            ->hasConfigFile()
            ->hasMigration('create_package_tables')
            ->publishesServiceProvider('MyServiceProviderName')
            ->hasInstallCommand(function(InstallCommand $command) {
                $command
                    ->publishConfigFile()
                    ->publishAssets()
                    ->publishMigrations()
                    ->askToRunMigrations()
                    ->copyAndRegisterServiceProviderInApp()
                    ->askToStarRepoOnGitHub('your-vendor/your-repo-name')
            });
    }
}
```

```bash
php artisan your-package-name:install
```

--------------------------------

### configurePackage usage example

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Example of using the Package fluent API inside configurePackage() to set the package name and enable config file, views, and translations. All trait methods return the instance for chaining.

```php
public function configurePackage(Package $package): void
{
    $package
        ->name('your-package-name')
        ->hasConfigFile()
        ->hasViews()
        ->hasTranslations();
}
```

--------------------------------

### Registering an install command

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/install-command.md

The intended way to register an install command using the hasInstallCommand method on the package instance.

```php
$package->hasInstallCommand(function(InstallCommand $command) {
    $command
        ->publishConfigFile()
        ->publishAssets()
        ->publishMigrations()
        ->askToRunMigrations()
        ->copyAndRegisterServiceProviderInApp()
        ->askToStarRepoOnGitHub('your-vendor/your-repo-name');
});
```

--------------------------------

### bootingPackage() hook

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

No-op lifecycle hook invoked at the start of boot().

```php
public function bootingPackage()
{
}
```

--------------------------------

### InstallCommand::__construct(Package $package)

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/install-command.md

Constructor for the InstallCommand class. It sets the command signature to {shortName}:install, description to 'Install {name}', marks the command as hidden, and stores the package instance.

```APIDOC
## InstallCommand::__construct(Package $package)

### Description
Constructor for the InstallCommand class. It sets the command signature to {shortName}:install, description to 'Install {name}', marks the command as hidden, and stores the package instance.

### Method
Constructor

### Signature
public function __construct(Package $package)

### Parameters
- **package** (Package) - Required - The already-configured package instance.

### Behavior
$this->signature = $package->shortName() . ':install';
$this->description = 'Install ' . $package->name;
$this->package = $package;
$this->hidden = true;
parent::__construct();

### Usage
Normally you never construct this directly — Package::hasInstallCommand($callable) does it for you.

Basic usage (the intended path):

$package->hasInstallCommand(function(InstallCommand $command) {
    $command
        ->publishConfigFile()
        ->publishAssets()
        ->publishMigrations()
        ->askToRunMigrations()
        ->copyAndRegisterServiceProviderInApp()
        ->askToStarRepoOnGitHub('your-vendor/your-repo-name');
});
```

--------------------------------

### Example JSON translation file

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Example JSON translation file saved at `<package root>/resources/lang/it.json`. Used for translation strings as keys.

```json
{
    "Hello!": "Ciao!"
}
```

--------------------------------

### hasViewComponents() usage example

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Example call to hasViewComponents() with a prefix and two component class names.

```php
$package->hasViewComponents('spatie', Alert::class, Badge::class);
```

--------------------------------

### InstallCommand handle method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/install-command.md

The handle method is invoked by the framework when the user executes the package's install command.

```php
public function handle()
```

--------------------------------

### hasCommands() usage example

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Example call to hasCommands() with an array of command class names.

```php
$package->hasCommands([
    YourCoolPackageCommand::class,
    YourOtherCoolPackageCommand::class,
]);
```

--------------------------------

### startWith Method Definition

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/command-concerns.md

Registers a callable to be executed at the start of the command handle process.

```php
public function startWith(callable $callable): self
```

--------------------------------

### InstallCommand class definition

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/install-command.md

The base class definition for InstallCommand, showing the traits used for installation concerns.

```php
class InstallCommand extends Command
{
    use AskToRunMigrations;
    use AskToStarRepoOnGitHub;
    use PublishesResources;
    use SupportsServiceProviderInApp;
    use SupportsStartWithEndWith;

    protected Package $package;
```

--------------------------------

### basePath() usage example

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

Shows how basePath() resolves relative to the package base directory, with the provider at <package root>/src/YourPackageServiceProvider.php.

```php
$package->basePath();                    // '<package root>/src'
$package->basePath('/../resources/dist'); // '<package root>/resources/dist'
```

--------------------------------

### hasInstallCommand($callable)

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Registers a custom install command for the package. The callable receives an InstallCommand instance to configure the command.

```APIDOC
## hasInstallCommand($callable)

### Description
Creates a new InstallCommand instance, invokes the provided callable to configure it, and appends it to the package's console commands.

### Method
hasInstallCommand

### Signature
public function hasInstallCommand($callable): static

### Parameters
- `callable` (callable) - Required - Receives a new `InstallCommand($this)` instance.

### Example
```php
$package->hasInstallCommand(function(InstallCommand $command) {
    $command
        ->publishConfigFile()
        ->publishAssets()
        ->publishMigrations()
        ->askToRunMigrations()
        ->copyAndRegisterServiceProviderInApp()
        ->askToStarRepoOnGitHub('your-vendor/your-repo-name');
});
```

### Resulting Command
The resulting console command is `<shortName>:install`.
```

--------------------------------

### Example PHP translation file

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Example translation file saved at `<package root>/resources/lang/en/translations.php`. Used with `hasTranslations` to provide translations.

```php
return [
    'translatable' => 'translation',
];
```

--------------------------------

### Configure a Laravel package with PackageServiceProvider

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Example of using the PackageServiceProvider to configure a Laravel package. It registers config files, views, view components, view composers, shared data, translations, assets, a service provider, routes, migrations, commands, and an install command.

```php
use Spatie\LaravelPackageTools\PackageServiceProvider;
use Spatie\LaravelPackageTools\Package;
use MyPackage\ViewComponents\Alert;
use Spatie\LaravelPackageTools\Commands\Concerns;
use Spatie\LaravelPackageTools\Commands\InstallCommand;

class YourPackageServiceProvider extends PackageServiceProvider
{
    public function configurePackage(Package $package): void
    {
        $package
            ->name('your-package-name')
            ->hasConfigFile()
            ->hasViews()
            ->hasViewComponent('spatie', Alert::class)
            ->hasViewComposer('*', MyViewComposer::class)
            ->sharesDataWithAllViews('downloads', 3)
            ->hasTranslations()
            ->hasAssets()
            ->publishesServiceProvider('MyProviderName')
            ->hasRoute('web')
            ->hasMigration('create_package_tables')
            ->hasCommand(YourCoolPackageCommand::class)
            ->hasInstallCommand(function(InstallCommand $command) {
                $command
                    ->publishConfigFile()
                    ->publishAssets()
                    ->publishMigrations()
                    ->copyAndRegisterServiceProviderInApp()
                    ->askToStarRepoOnGitHub();
            });
    }
}
```

--------------------------------

### registeringPackage()

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

No-op lifecycle hook invoked at the start of register(). Override to run pre-registration custom logic.

```APIDOC
## registeringPackage()

### Description
No-op lifecycle hook invoked at the **start** of `register()`. Override to run pre-registration custom logic.

### Method
registeringPackage

### Signature
```php
public function registeringPackage()
{
}
```

### Parameters
None.

### Returns
`null`.
```

--------------------------------

### InstallCommand processing chain

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/install-command.md

The internal execution chain of the InstallCommand, which performs six distinct processing steps followed by a final installation message.

```php
$this
    ->processStartWith()
    ->processPublishes()
    ->processAskToRunMigrations()
    ->processCopyServiceProviderInApp()
    ->processStarRepo()
    ->processEndWith();

$this->info("{$this->package->shortName()} has been installed!");
```

--------------------------------

### Retrieve a translation with trans()

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Retrieves a translation using the package name as the namespace. If the package name starts with `laravel-`, leave that prefix off in the example.

```php
trans('your-package-name::translations.translatable'); // returns 'translation'
```

--------------------------------

### Using name() to set package name

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Example call to name() with the package name 'laravel-cool-package'.

```php
$package->name('laravel-cool-package');
```

--------------------------------

### Publish a service provider with publishesServiceProvider

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Publishes an example service provider to the `app\Providers` directory of the Laravel app. The file to copy must be stored in `/resources/stubs/{$nameOfYourServiceProvider}.php.stub`.

```php
$package
    ->name('your-package-name')
    ->publishesServiceProvider($nameOfYourServiceProvider);
```

--------------------------------

### registeringPackage() hook

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

No-op lifecycle hook invoked at the start of register(). Returns null; override to run pre-registration custom logic.

```php
public function registeringPackage()
{
}
```

--------------------------------

### SupportsStartWithEndWith State Properties

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/command-concerns.md

The trait defines two nullable Closure properties to store the start and end hooks.

```php
public ?Closure $startWith = null;
public ?Closure $endWith = null;
```

--------------------------------

### Using shortName() with name()

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Example that sets the package name and then retrieves the short name. For 'laravel-cool-package', shortName() returns 'cool-package'.

```php
$package->name('laravel-cool-package');
$package->shortName(); // 'cool-package'
```

--------------------------------

### register() with error handling

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

Example of calling parent::register() inside a try-catch block to handle InvalidPackage exceptions. This is normally unnecessary because the framework calls register() at boot and Pest logs exceptions.

```php
// Inside a concrete provider — the framework calls register(), but a direct
// invocation shows the contract:
public function registerVerbose()
{
    try {
        parent::register();
    } catch (InvalidPackage $e) {
        ddd($e->getMessage());
    }
}
```

--------------------------------

### Use view with custom namespace

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Example of using a view that was registered with a custom view namespace. Replace 'custom-view-namespace' with the namespace passed to hasViews.

```php
view('custom-view-namespace::myView');
```

--------------------------------

### hasCommand(string $commandClassName)

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Registers a single Artisan command class with the package. The command will be available when the package is installed.

```APIDOC
## hasCommand(string $commandClassName)

### Description
Registers a single Artisan command class with the package. The command will be available when the package is installed.

### Method
`hasCommand(string $commandClassName)`

### Parameters
- `commandClassName` (string) - Required - The fully qualified class name of the command.

### Returns
`static` - The Package instance for chaining.

### Example
```php
$package->hasCommand(YourCoolPackageCommand::class);
```
```

--------------------------------

### Catching InvalidPackage with try-catch

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/invalid-package.md

Example of catching InvalidPackage in consumer code. The exception is thrown during Laravel boot via register(), not at the name() call site. The catch block uses ddd() to dump the message.

```php
use Spatie\LaravelPackageTools\Exceptions\InvalidPackage;

try {
    $provider->register();
} catch (InvalidPackage $e) {
    ddd($e->getMessage());
    // "This package does not have a name. You can set one with `$package->name("yourName")`"
}
```

--------------------------------

### Run tests by group with composer test -- --group=blade

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Runs only the tests in the specified group. Supported groups include base, assets, blade, commands, config, inertia, migrations, provider, routes, shareddata, translations, viewcomposer, views, and installer. Use 'legacy' to test only backwards compatibility.

```bash
composer test -- --group=blade
```

--------------------------------

### boot()

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

Called by the framework when the app boots. It runs a series of boot steps in a fixed order.

```APIDOC
## boot()

### Description
Called by the framework when the app boots. It runs a series of boot steps in a fixed order.

### Method
boot

### Signature
```php
public function boot()
```

### Parameters
None.

### Returns
`$this`.

### Behavior
1. `$this->bootingPackage()`
2. Chains, in fixed order:
   `bootPackageAssets()` → `bootPackageBladeComponents()` → `bootPackageCommands()` → `bootPackageConsoleCommands()` → `bootPackageConfigs()` → `bootPackageInertia()` → `bootPackageMigrations()` → `bootPackageRoutes()` → `bootPackageServiceProviders()` → `bootPackageTranslations()` → `bootPackageViews()` → `bootPackageViewComposers()` → `bootPackageViewSharedData()`
3. `$this->packageBooted()`

Each step is documented with exact signatures in [process-concerns.md](process-concerns.md).
```

--------------------------------

### InstallCommand constructor behavior

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/install-command.md

The internal logic of the constructor, setting the command signature, description, and visibility.

```php
$this->signature = $package->shortName() . ':install';
$this->description = 'Install ' . $package->name;
$this->package = $package;
$this->hidden = true;
parent::__construct();
```

--------------------------------

### askToStarRepoOnGitHub() Method

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/command-concerns.md

Configures the repository slug and default answer for the star prompt.

```php
public function askToStarRepoOnGitHub($vendorSlashRepoName, bool $defaultAnswer = false): self
```

--------------------------------

### processStartWith Method Definition

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/command-concerns.md

Internal method to trigger the startWith closure if it has been defined.

```php
protected function processStartWith(): self
```

--------------------------------

### Minimal implementation of configurePackage

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

Shows the minimal required implementation: calling $package->name('...') with the package name.

```php
class YourPackageServiceProvider extends PackageServiceProvider
{
    public function configurePackage(Package $package): void
    {
        $package->name('your-package-name');
    }
}
```

--------------------------------

### boot() method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

Signature of the boot() method. Called by the framework when the app boots. Returns $this.

```php
public function boot()
```

--------------------------------

### register()

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

Called by the framework when the provider registers. It initializes the package, configures it, and throws an exception if the package name is missing.

```APIDOC
## register()

### Description
Called by the framework when the provider registers. It initializes the package, configures it, and throws an exception if the package name is missing.

### Method
register

### Signature
```php
/** @throws InvalidPackage */
public function register()
```

### Parameters
None.

### Returns
`$this` (the provider instance).

### Throws
`InvalidPackage` — see [errors.md](../errors.md).

### Behavior
1. `$this->registeringPackage()`
2. `$this->package = $this->newPackage()`
3. `$this->package->setBasePath($this->getPackageBaseDir())`
4. `$this->configurePackage($this->package)`
5. If `empty($this->package->name)` → `throw InvalidPackage::nameIsRequired()`
6. `$this->registerPackageConfigs()`
7. `$this->packageRegistered()`

### Example
```php
// Inside a concrete provider — the framework calls register(), but a direct
// invocation shows the contract:
public function registerVerbose()
{
    try {
        parent::register();
    } catch (InvalidPackage $e) {
        ddd($e->getMessage());
    }
}
```
```

--------------------------------

### Method copyAndRegisterServiceProviderInApp

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/command-concerns.md

Sets the copyServiceProviderInApp property to true and returns the command instance.

```php
public function copyAndRegisterServiceProviderInApp(): self
```

--------------------------------

### bootPackageViews() method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/process-concerns.md

Protected method that loads package views. Triggered when the package has views. Uses the package's view namespace and base path to load views from the vendor directory, with a fallback for non-existent source directories. Publishes views under a tag based on the namespace or short name.

```php
protected function bootPackageViews(): self
```

--------------------------------

### InstallCommand constructor signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/install-command.md

The constructor signature for the InstallCommand class.

```php
public function __construct(Package $package)
```

--------------------------------

### newPackage() method

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

Returns a new Package instance. Override to return a subclass of Package. Called by register().

```php
public function newPackage(): Package
```

--------------------------------

### Abstract configurePackage method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

Declares the abstract method that every concrete provider must implement. It takes a Package instance and returns void.

```php
abstract public function configurePackage(Package $package): void;
```

--------------------------------

### packageBooted()

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

No-op lifecycle hook invoked at the end of boot().

```APIDOC
## packageBooted()

### Description
No-op lifecycle hook invoked at the **end** of `boot()`.

### Method
packageBooted

### Signature
```php
public function packageBooted()
{
}
```

### Parameters
None.

### Returns
`null`.
```

--------------------------------

### discoverPackageMigrations() method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/process-concerns.md

Returns void. Discovers migration files from the package's migrations path and publishes them with timestamped names.

```php
protected function discoverPackageMigrations(): void
```

--------------------------------

### bootPackageInertia() method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/process-concerns.md

Returns self. Called when the package has Inertia components. No further code shown.

```php
protected function bootPackageInertia(): self
```

--------------------------------

### processStarRepo() Method

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/command-concerns.md

Internal method to prompt the user to star the repository and open the URL in the browser.

```php
protected function processStarRepo(): self
```

```php
$repoUrl = "https://github.com/{$this->starRepo}";

if (PHP_OS_FAMILY == 'Darwin') {
    exec("open {$repoUrl}");
}
if (PHP_OS_FAMILY == 'Windows') {
    exec("start {$repoUrl}");
}
if (PHP_OS_FAMILY == 'Linux') {
    exec("xdg-open {$repoUrl}");
}
```

--------------------------------

### existingAppMigrationsIn() method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/process-concerns.md

Returns an array of existing app migration filenames for the given migrations path. Memoized using the class-level cache.

```php
private function existingAppMigrationsIn(string $migrationsPath): array
```

--------------------------------

### Discover all migrations with discoversMigrations

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Publishes all migrations in the `./database/migrations` directory of your project by default. Also makes the migrations publishable.

```php
$package
    ->name('your-package-name')
    ->discoversMigrations();
```

--------------------------------

### Publish assets command

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Publishes assets to public/vendor/<your-package-name> in the app.

```bash
php artisan vendor:publish --tag=your-package-name-assets
```

--------------------------------

### Publish config file with vendor:publish

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Publishes the config file registered with hasConfigFile. Users run this command to publish the config file.

```bash
php artisan vendor:publish --tag=your-package-name-config
```

--------------------------------

### bootPackageMigrations() method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/process-concerns.md

Returns self. Resets the existingAppMigrations cache and either discovers migrations or processes the configured migration file names.

```php
protected function bootPackageMigrations(): self
```

--------------------------------

### Publish service provider with vendor:publish

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Copies `/resources/stubs/{$nameOfYourServiceProvider}.php.stub` from the package to `app/Providers/{$nameOfYourServiceProvider}.php` in the user's app.

```bash
php artisan vendor:publish --tag=your-package-name-provider
```

--------------------------------

### packageBooted() hook

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

No-op lifecycle hook invoked at the end of boot().

```php
public function packageBooted()
{
}
```

--------------------------------

### askToRunMigrations() Method

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/command-concerns.md

Sets the askToRunMigrations property to true and returns the command instance.

```php
public function askToRunMigrations(): self
```

--------------------------------

### bootPackageConfigs method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/process-concerns.md

Protected method that publishes package config files to the application's config directory. It is console-gated and skips config files that do not exist.

```php
protected function bootPackageConfigs(): self
```

--------------------------------

### Discover Migrations with discoversMigrations

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Enables scan-based migration discovery. The path parameter specifies the directory to scan, resolved against the package root.

```php
$package->discoversMigrations(path: '/path/to/your/migrations/folder');
```

--------------------------------

### newPackage()

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

Returns a new Package instance. Override to return a subclass of Package. Called by register().

```APIDOC
## newPackage()

### Description
Returns a new Package instance. Override to return a subclass of Package. Called by `register()`.

### Method
newPackage

### Signature
```php
public function newPackage(): Package
```

### Parameters
None.

### Returns
`Package` — always `new Package()` in the base class.
```

--------------------------------

### Publish assets with hasAssets()

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Make assets in resources/dist publishable using hasAssets(). Users publish with the tag your-package-name-assets.

```php
$package
    ->name('your-package-name')
    ->hasAssets();
```

--------------------------------

### Method copyServiceProviderInApp

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/command-concerns.md

Contains the core logic for publishing the provider stub, determining the target configuration file based on Laravel version, and registering the provider class.

```php
protected function copyServiceProviderInApp(): self
```

--------------------------------

### bootPackageAssets() method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/process-concerns.md

Declares the protected method that registers asset publishing when the package has assets and the app runs in console.

```php
protected function bootPackageAssets(): static
```

--------------------------------

### hasViews(?string $namespace = null)

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Enables view loading for the package. Views are served under the given namespace or the package's short name.

```APIDOC
## hasViews(?string $namespace = null)

### Description
Sets `hasViews = true`. Views are served under the namespace (default `shortName()`), so `resources/views/myView.blade.php` is reachable as `view('your-package-name::myView')`. Publishing tag: `{namespace}-views` (custom) vs `{shortName}-views` (default).

### Method
hasViews

### Signature
public function hasViews(?string $namespace = null): static

### Parameters
- `namespace` (?string) - Optional - Default: `null` - Custom view namespace; stored in `viewNamespace`.
```

--------------------------------

### Register multiple config files with hasConfigFile

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Registers multiple config files by passing an array of file names to hasConfigFile.

```php
$package
    ->name('your-package-name')
    ->hasConfigFile(['my-config-file', 'another-config-file']);
```

--------------------------------

### bootPackageViewSharedData() method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/process-concerns.md

Protected method that shares data with views. Triggered when the package has shared view data. For each name and value, it calls View::share.

```php
protected function bootPackageViewSharedData(): self
```

--------------------------------

### Publish views with default tag

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Publishes the package views when using the default view namespace. Users run this command to publish the views to their application.

```bash
php artisan vendor:publish --tag=your-package-name-views
```

--------------------------------

### hasConfigFile($configFileName = null)

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Registers one or more config files for the package. The call replaces any previously set config file names. Config files are expected in the package's config directory.

```APIDOC
## hasConfigFile($configFileName = null)

### Description
Registers one or more config files for the package. The call replaces any previously set config file names. Config files are expected in the package's config directory.

### Method
`hasConfigFile($configFileName = null)`

### Parameters
- `configFileName` (string|array|null) - Optional - Config file name(s) without `.php` extension. `null` defaults to `$this->shortName()`. A single string is wrapped into an array.

### Returns
`static` - The Package instance for chaining.

### Example
```php
$package->hasConfigFile(['my-config-file', 'another-config-file']);
```
```

--------------------------------

### bootPackageCommands method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/process-concerns.md

Protected method that registers package commands when the package's commands property is non-empty. It calls the framework's commands() method.

```php
protected function bootPackageCommands(): self
```

--------------------------------

### Publish view components with vendor:publish

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Publishes the view components registered with hasViewComponents. Users run this command to publish the components.

```bash
php artisan vendor:publish --tag=your-package-name-components
```

--------------------------------

### Run tests with composer test

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Runs the package's test suite using Composer. This is the standard command for executing all tests.

```bash
composer test
```

--------------------------------

### name() method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Signature for the name() method. It takes a string package name and returns the Package instance for chaining. An empty value is allowed here but rejected later by register() throwing InvalidPackage::nameIsRequired().

```php
public function name(string $name): static
```

--------------------------------

### hasMigration(string $migrationFileName)

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Registers a single migration file to be loaded from the package. The file name should not include the .php extension.

```APIDOC
## hasMigration(string $migrationFileName)

### Description
Appends a migration file name to the package's migration list. The file is expected to be located in the package's migrations directory.

### Method
hasMigration

### Signature
public function hasMigration(string $migrationFileName): static

### Parameters
- `migrationFileName` (string) - Required - Migration name without `.php` (and optionally without `.stub`) extension; subdirectories allowed.
```

--------------------------------

### discoversMigrations(bool $discoversMigrations = true, string $path = '/database/migrations')

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Enables automatic discovery of migrations from a specified directory. When enabled, migrations are scanned and loaded automatically.

```APIDOC
## discoversMigrations(bool $discoversMigrations = true, string $path = '/database/migrations')

### Description
Enables scan-based discovery of migrations instead of explicit registration via `hasMigration`. The path is resolved against the package root.

### Method
discoversMigrations

### Signature
public function discoversMigrations(bool $discoversMigrations = true, string $path = '/database/migrations'): static

### Parameters
- `discoversMigrations` (bool) - Optional - Default: `true` - Enables scan-based discovery.
- `path` (string) - Optional - Default: `'/database/migrations'` - Directory to scan, resolved against the package root.

### Example
```php
$package->discoversMigrations(path: '/path/to/your/migrations/folder');
```
```

--------------------------------

### name(string $name)

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Sets the package name. The name is required and will be validated during registration.

```APIDOC
## name(string $name)

### Description
Sets the package name. The name is required and will be validated during registration.

### Method
name

### Signature
public function name(string $name): static

### Parameters
- `name` (string) - Required - The package name, e.g. `your-package-name` or `laravel-cool-package`.

### Returns
- `Package` instance for chaining.

### Example
```php
$package->name('laravel-cool-package');
```
```

--------------------------------

### bootPackageConsoleCommands method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/process-concerns.md

Protected method that registers console commands when the package's consoleCommands property is non-empty and the app runs in console. It calls the framework's commands() method.

```php
protected function bootPackageConsoleCommands(): self
```

--------------------------------

### packageView() method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

Returns the package's short name when namespace is null, otherwise the view namespace. Used by ProcessViews and ProcessInertia.

```php
public function packageView(?string $namespace): ?string
```

--------------------------------

### Publish views with custom tag

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Publishes the package views when using a custom view namespace. The tag must match the custom namespace followed by '-views'.

```bash
php artisan vendor:publish --tag=custom-view-namespace-views
```

--------------------------------

### basePath() method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Signature for the basePath() method. It accepts an optional directory and returns a string: the raw base path or the base path with the directory appended.

```php
public function basePath(?string $directory = null): string
```

--------------------------------

### hasRoute(string $routeFileName)

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Registers a route file to be loaded from the package's routes directory.

```APIDOC
## hasRoute(string $routeFileName)

### Description
Appends a route file name to the package's route list. The file is loaded from `<package root>/routes/{name}.php`.

### Method
hasRoute

### Signature
public function hasRoute(string $routeFileName): static

### Parameters
- `routeFileName` (string) - Required - The name of the route file (without `.php` extension).
```

--------------------------------

### AskToStarRepoOnGitHub State

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/command-concerns.md

The initial state for the AskToStarRepoOnGitHub concern.

```php
protected ?string $starRepo = null;

protected bool $defaultStarAnswer = true;
```

--------------------------------

### Discover migrations from a custom path

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Discovers migrations from a custom directory by passing a value to the `$path` variable. Use this when your migrations are not in the default `./database/migrations` folder.

```php
$package
    ->name('your-package-name')
    ->discoversMigrations(path: '/path/to/your/migrations/folder');
```

--------------------------------

### Publish Inertia components with vendor:publish

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Publishes the Inertia components registered with hasInertiaComponents. Users run this command to publish the components.

```bash
php artisan vendor:publish --tag=your-package-name-inertia-components
```

--------------------------------

### bootPackageViewComposers() method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/process-concerns.md

Protected method that registers view composers. Triggered when the package has view composers. For each view name and composer, it calls View::composer with the given arguments.

```php
protected function bootPackageViewComposers(): self
```

--------------------------------

### Register multiple migrations with hasMigrations

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Registers multiple migration files at once by passing an array of migration names without extensions. Equivalent to calling `hasMigration` multiple times. Also makes the migrations publishable.

```php
$package
    ->name('your-package-name')
    ->hasMigrations(['my_package_tables', 'some_other_migration']);
```

--------------------------------

### register() method docblock with @throws

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/invalid-package.md

The docblock for the register() method declaring that it throws InvalidPackage.

```php
/** @throws InvalidPackage */
public function register()
```

--------------------------------

### processAskToRunMigrations() Method

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/command-concerns.md

Internal method to prompt the user to run migrations and execute the migrate command if confirmed.

```php
protected function processAskToRunMigrations(): self
```

```php
if ($this->confirm('Would you like to run the migrations now?')) {
    $this->comment('Running migrations...');
    $this->call('migrate');
}
```

--------------------------------

### Register and run migrations automatically

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Registers migrations and enables them to be run automatically without requiring users to publish them first. Combines `hasMigrations` with `runsMigrations`.

```php
$package
    ->name('your-package-name')
    ->hasMigrations(['my_package_tables', 'some_other_migration'])
    ->runsMigrations();
```

--------------------------------

### Reflection-based base directory discovery

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

Discovers the package base directory by reflecting on the provider class. If the directory ends with 'Providers', it moves up one level to support Laravel's directory convention.

```php
$reflector = new ReflectionClass(get_class($this));
$packageBaseDir = dirname($reflector->getFileName());
// If the directory name ends with DIRECTORY_SEPARATOR . 'Providers',
// move up one level:
if (str_ends_with($packageBaseDir, DIRECTORY_SEPARATOR.'Providers')) {
    $packageBaseDir = dirname($packageBaseDir);
}
```

--------------------------------

### Inertia component path transformation logic

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/process-concerns.md

Computes the vendor and app component paths. Uses the package's view namespace to derive a studly, hyphen-free directory name for the app's Pages directory. This logic runs during the console-gated publish of Inertia components.

```php
$namespace = $this->package->viewNamespace;
$directoryName = Str::of($this->packageView($namespace))->studly()->remove('-')->value();
$vendorComponents = $this->package->basePath('/../resources/js/Pages');
$appComponents = base_path("resources/js/Pages/{$directoryName}");
```

--------------------------------

### hasInertiaComponents(?string $namespace = null)

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Enables Inertia component publishing for the package. Optionally sets a view namespace for the components.

```APIDOC
## hasInertiaComponents(?string $namespace = null)

### Description
Enables Inertia component publishing for the package. Optionally sets a view namespace for the components.

### Method
`hasInertiaComponents(?string $namespace = null)`

### Parameters
- `namespace` (?string) - Optional - Optional view namespace; written to `viewNamespace`.

### Returns
`static` - The Package instance for chaining.

### Example
```php
$package->hasInertiaComponents('spatie');
```
```

--------------------------------

### Method processCopyServiceProviderInApp

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/command-concerns.md

Triggers the service provider copy process if the copyServiceProviderInApp flag is enabled.

```php
protected function processCopyServiceProviderInApp(): self
```

--------------------------------

### Register config file with hasConfigFile

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Registers the package's config file. The config file should be named after the package (without the 'laravel-' prefix if present) and placed in the config directory. This also makes the config file publishable.

```php
$package
    ->name('your-package-name')
    ->hasConfigFile();
```

--------------------------------

### Run Pest directly with auto_prepend_file

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Runs Pest directly instead of via composer test. This is required to handle InvalidPackage exceptions thrown during Laravel application bootup, which Pest normally cannot test for. The auto_prepend_file loads a modified Pest test() function that catches and rethrows these exceptions.

```bash
php -d auto_prepend_file=tests/Prepend.php vendor/bin/pest
```

--------------------------------

### hasMigrations(...$migrationFileNames)

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Registers multiple migration files at once. Accepts a variadic list of file names or arrays of file names.

```APIDOC
## hasMigrations(...$migrationFileNames)

### Description
Plural variant of `hasMigration`; flattens arrays via `collect(...)->flatten()->toArray()`.

### Method
hasMigrations

### Signature
public function hasMigrations(...$migrationFileNames): static

### Parameters
- `migrationFileNames` (string|array) - Required - One or more migration file names (without `.php` extension).
```

--------------------------------

### normalizeConfigPath method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/process-concerns.md

Protected method that converts path separators in a config file name to the directory separator for the current operating system.

```php
protected function normalizeConfigPath(string $configFileName): string
```

--------------------------------

### runsMigrations(bool $runsMigrations = true)

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Enables or disables automatic loading of migrations from the package. When enabled, migrations are loaded directly without requiring users to publish them.

```APIDOC
## runsMigrations(bool $runsMigrations = true)

### Description
When enabled, registered (or discovered) migrations are also loaded directly from the package (`loadMigrationsFrom($vendorMigration)`), so users do not have to publish them first.

### Method
runsMigrations

### Signature
public function runsMigrations(bool $runsMigrations = true): static

### Parameters
- `runsMigrations` (bool) - Optional - Default: `true` - Whether to run migrations automatically.
```

--------------------------------

### hasRoutes(...$routeFileNames)

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Registers multiple route files at once.

```APIDOC
## hasRoutes(...$routeFileNames)

### Description
Plural variant of `hasRoute`.

### Method
hasRoutes

### Signature
public function hasRoutes(...$routeFileNames): static

### Parameters
- `routeFileNames` (string) - Required - One or more route file names (without `.php` extension).
```

--------------------------------

### registerPackageConfigs method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/process-concerns.md

Public method called from register() that merges package config files into the application. It skips config files that do not exist in the package's config directory.

```php
public function registerPackageConfigs(): self
```

--------------------------------

### Register multiple routes with hasRoutes

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Registers multiple route files at once by passing an array of route names without extensions. Equivalent to calling `hasRoute` multiple times.

```php
$package
    ->name('your-package-name')
    ->hasRoutes(['web', 'admin']);
```

--------------------------------

### Register a single migration with hasMigration

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Registers a single migration file by its name without the extension. The migration file must be placed in the `<package root>/database/migrations` directory. Calling this method also makes the migration publishable.

```php
$package
    ->name('your-package-name')
    ->hasMigration('create_my_package_tables');
```

--------------------------------

### Register a single route with hasRoute

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Registers a single route file by its name without the extension. Route files must be placed in the `<package root>/routes` directory.

```php
$package
    ->name('your-package-name')
    ->hasRoute('web');
```

--------------------------------

### Extend PackageServiceProvider and set package name

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Extend PackageServiceProvider and call name() with your package name. The name() call is mandatory.

```php
use Spatie\LaravelPackageTools\PackageServiceProvider;
use Spatie\LaravelPackageTools\Package;

class YourPackageServiceProvider extends PackageServiceProvider
{
    public function configurePackage(Package $package) : void
    {
        $package->name('your-package-name');
    }
}
```

--------------------------------

### PackageServiceProvider class declaration with traits

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package-service-provider.md

Shows the abstract class declaration and the use of the 12 Process* traits. This is the base class that package authors extend.

```php
abstract class PackageServiceProvider extends ServiceProvider
{
    use ProcessAssets;
    use ProcessBladeComponents;
    use ProcessCommands;
    use ProcessConfigs;
    use ProcessInertia;
    use ProcessMigrations;
    use ProcessRoutes;
    use ProcessServiceProviders;
    use ProcessTranslations;
    use ProcessViewComposers;
    use ProcessViews;
    use ProcessViewSharedData;

    protected Package $package;
```

--------------------------------

### normalizeConfigKey method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/process-concerns.md

Protected method that converts path separators in a config file name to dots for use as a config key.

```php
protected function normalizeConfigKey(string $configFileName): string
```

--------------------------------

### shortName()

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Returns the package short name by removing the 'laravel-' prefix from the package name.

```APIDOC
## shortName()

### Description
Returns the package short name by removing the 'laravel-' prefix from the package name.

### Method
shortName

### Signature
public function shortName(): string

### Returns
- `string` - The name with everything up to and including the first occurrence of `laravel-` removed.

### Example
```php
$package->name('laravel-cool-package');
$package->shortName(); // 'cool-package'
```
```

--------------------------------

### hasViewComponents() method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Declares the variadic plural variant of hasViewComponent() that stores multiple components with a shared prefix.

```php
public function hasViewComponents(string $prefix,  ...$viewComponentNames): static
```

--------------------------------

### setBasePath() method signature

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/package.md

Signature for the setBasePath() method. It takes an absolute path and returns the Package instance. It is called automatically by register() and not intended for user code.

```php
public function setBasePath(string $path): static
```

--------------------------------

### Publish translations with vendor:publish

Source: https://github.com/spatie/laravel-package-tools/blob/main/README.md

Publishes the package's translations to the consuming Laravel app.

```bash
php artisan vendor:publish --tag=your-package-name-translations
```

--------------------------------

### Asset publishing mapping

Source: https://github.com/spatie/laravel-package-tools/blob/main/_autodocs/api-reference/process-concerns.md

Maps the package's resources/dist directory to public/vendor/{shortName} under the tag {shortName}-assets.

```php
$vendorAssets = $this->package->basePath('/../resources/dist');
$appAssets = public_path("vendor/{$this->package->shortName()}");
$this->publishes([$vendorAssets => $appAssets], "{$this->package->shortName()}-assets");
```
Tokens:
Raw