Krayin Package Generator

https://github.com/krayin/krayin-package-generator
Admin
Krayin Package Generator is a Composer package for Krayin CRM (PHP/Laravel) that adds artisan...
Tokens:42,087
Snippets:506
Trust Score:9.4
License:MIT
Update:3 days ago
Show doc for...
Tokens:
Raw
### Error message example

Source: https://github.com/krayin/krayin-package-generator

Example output when the listener file already exists and --force is not provided.

```bash
# Listener [<path>/TestListener.php] already exists.
```

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

### Usage example

Source: https://github.com/krayin/krayin-package-generator

Shows how to run the command and the expected output.

```bash
php artisan package:make-route ACME/TestPackage
# writes packages/ACME/TestPackage/src/Routes/web.php
# (route group prefix 'testpackage', get '' -> TestPackageController@index, name 'admin.testpackage.index')
```

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

### Usage examples for package:make-command

Source: https://github.com/krayin/krayin-package-generator

Shows how to run the command with and without the --force flag.

```bash
php artisan package:make-command TestCommand ACME/TestPackage
php artisan package:make-command TestCommand ACME/TestPackage --force  # overwrite
```

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

### Usage examples for package:make-controller

Source: https://github.com/krayin/krayin-package-generator

Shows two usage examples: creating a controller without overwriting and with `--force` to overwrite an existing file. The `--force` flag is required to overwrite; otherwise an error is emitted.

```bash
php artisan package:make-controller TestController ACME/TestPackage
php artisan package:make-controller TestController ACME/TestPackage --force  # overwrite
```

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

### php artisan list | grep package:

Source: https://github.com/krayin/krayin-package-generator

List all registered package generator commands after installation.

```bash
php artisan list | grep package:
```

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

### MakeCommand name prompt configuration

Source: https://github.com/krayin/krayin-package-generator

Defines the interactive prompt question and example default for the `name` argument in `MakeCommand.php`. The prompt text is derived from `$type`, and the default example is matched against the artifact type, with a fallback to an empty string for unknown types.

```php
// src/Console/Command/MakeCommand.php:98
'name' => [
    'What should the '.strtolower($this->type).' be named?',
    match ($this->type) {
        'Console command' => 'E.g. SendEmails',
        'Controller'      => 'E.g. UserController',
        'Datagrid'        => 'E.g. ProductDatagrid',
        'Event'           => 'E.g. PodcastProcessed',
        'Listener'        => 'E.g. SendPodcastNotification',
        'Mailable'        => 'E.g. OrderShipped',
        'Middleware'      => 'E.g. EnsureTokenIsValid',
        'Migration'       => 'E.g. create_flights_table',
        'Model'           => 'E.g. Flight',
        'Model Proxy'     => 'E.g. FlightProxy',
        'Contract'        => 'E.g. Flight',
        'Module Provider' => 'E.g. ModuleServiceProvider',
        'Provider'        => 'E.g. ElasticServiceProvider',
        'Notification'    => 'E.g. InvoicePaid',
        'Repository'      => 'E.g. UserRepository',
        'Request'         => 'E.g. StorePodcastRequest',
        'Route'           => 'E.g. web',
        'Seeder'          => 'E.g. UserSeeder',
        default           => '',
    },
],
```

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

### Install and generate Krayin package with composer and artisan commands

Source: https://github.com/krayin/krayin-package-generator

Install the package via Composer, list registered commands, generate a full package, and create a single controller artifact. Commands are auto-discovered via extra.laravel.providers and only registered when the host app runs in console.

```bash
# From the root of a Krayin v2.0.x project:
composer require krayin/krayin-package-generator

# Register the package commands (auto-discovered via extra.laravel.providers):
php artisan list | grep package:

# Generate a whole package:
php artisan package:make ACME/TestPackage

# Generate a single artifact inside an existing package:
php artisan package:make-controller TestController ACME/TestPackage
```

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

### Usage example

Source: https://github.com/krayin/krayin-package-generator

Runs the command to create a service provider. The comment shows the expected output path and that the scaffold/package-provider stub is rendered.

```bash
php artisan package:make-provider TestServiceProvider ACME/TestPackage
# writes packages/ACME/TestPackage/src/Providers/TestServiceProvider.php
# (renders scaffold/package-provider.stub — a ServiceProvider loading migrations/routes/views/etc.)
```

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

### Usage examples for package:make-seeder

Source: https://github.com/krayin/krayin-package-generator

Shows how to run the command with and without --force to overwrite an existing seeder.

```bash
php artisan package:make-seeder TestSeeder ACME/TestPackage
php artisan package:make-seeder TestSeeder ACME/TestPackage --force  # overwrite
```

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

### package:make-listener

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new listener class within a specified package.

```APIDOC
## [COMMAND] package:make-listener

### Description
Creates a new listener class.

### Command
package:make-listener

### Arguments
#### Required Arguments
- **listener-name** (string) - Required - The name of the listener to create.
- **package-name** (string) - Required - The name of the package where the listener will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### package:make-command

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new command class within a specified package.

```APIDOC
## [COMMAND] package:make-command

### Description
Creates a new command class.

### Command
package:make-command

### Arguments
#### Required Arguments
- **command-name** (string) - Required - The name of the command to create.
- **package-name** (string) - Required - The name of the package where the command will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### Usage example for package:make-module-provider

Source: https://github.com/krayin/krayin-package-generator

Shows the basic command to create a module provider. It writes the file to packages/ACME/TestPackage/src/Providers/ModuleServiceProvider.php and renders the scaffold/module-provider.stub.

```bash
php artisan package:make-module-provider ModuleServiceProvider ACME/TestPackage
# writes packages/ACME/TestPackage/src/Providers/ModuleServiceProvider.php
# (renders scaffold/module-provider.stub, extending BaseModuleServiceProvider)
```

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

### package:make-datagrid

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new datagrid class within a specified package.

```APIDOC
## [COMMAND] package:make-datagrid

### Description
Creates a new datagrid class.

### Command
package:make-datagrid

### Arguments
#### Required Arguments
- **datagrid-name** (string) - Required - The name of the datagrid to create.
- **package-name** (string) - Required - The name of the package where the datagrid will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### Example output from package:make

Source: https://github.com/krayin/krayin-package-generator

Shows the typical output when creating a package normally (non-plain). Lists created files and ends with a success message.

```text
Created file : <path>/src/Resources/views/components/layouts/style.blade.php
Created file : <path>/src/Resources/views/index.blade.php
...
Created file : <path>/package.json
...
Package ACME/TestPackage created successfully.
```

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

### Usage examples for package:make-notification

Source: https://github.com/krayin/krayin-package-generator

Shows how to run the command with and without the --force flag. The --force flag overwrites an existing notification file.

```bash
php artisan package:make-notification TestNotification ACME/TestPackage
php artisan package:make-notification TestNotification ACME/TestPackage --force  # overwrite
```

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

### Create a new controller with force option

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Overwrites an existing controller if it already exists.

```php
php artisan package:make-controller TestController ACME/TestPackage --force
```

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

### package:make-repository

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new repository class within a specified package.

```APIDOC
## [COMMAND] package:make-repository

### Description
Creates a new repository class.

### Command
package:make-repository

### Arguments
#### Required Arguments
- **repository-name** (string) - Required - The name of the repository to create.
- **package-name** (string) - Required - The name of the package where the repository will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### package:make

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new package. This command generates the directory structure and optional files for a new Krayin package.

```APIDOC
## [COMMAND] package:make

### Description
Creates a new package.

### Command
package:make

### Arguments
#### Required Arguments
- **package-name** (string) - Required - The name of the package to create.

### Options
- **--force** - Optional - To overwrite the files.
- **--plain** - Optional - When you need only directory structure template, files are not included when this argument is passed.
```

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

### Usage examples for package:make-model-proxy

Source: https://github.com/krayin/krayin-package-generator

Shows how to invoke the command with and without the --force flag. The --force flag overwrites an existing model proxy file.

```bash
php artisan package:make-model-proxy TestModelProxy ACME/TestPackage
php artisan package:make-model-proxy TestModelProxy ACME/TestPackage --force  # overwrite
```

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

### package:make-route

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new routes file within a specified package.

```APIDOC
## [COMMAND] package:make-route

### Description
Creates a new routes file.

### Command
package:make-route

### Arguments
#### Required Arguments
- **package-name** (string) - Required - The name of the package where the routes file will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### Force usage example

Source: https://github.com/krayin/krayin-package-generator

Runs the command with the --force flag to overwrite an existing route file.

```bash
php artisan package:make-route ACME/TestPackage --force
```

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

### Usage examples for package:make-datagrid

Source: https://github.com/krayin/krayin-package-generator

Shows two invocations: one without `--force` and one with `--force` to overwrite an existing datagrid file. The comment indicates the overwrite behavior.

```bash
php artisan package:make-datagrid TestDataGrid ACME/TestPackage
php artisan package:make-datagrid TestDataGrid ACME/TestPackage --force  # overwrite
```

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

### Error path example

Source: https://github.com/krayin/krayin-package-generator

Shows the error message when the route file already exists and --force is not used.

```bash
# Route [<path>/Routes/web.php] already exists.
```

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

### package:make-controller

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new controller class within a specified package.

```APIDOC
## [COMMAND] package:make-controller

### Description
Creates a new controller.

### Command
package:make-controller

### Arguments
#### Required Arguments
- **controller-name** (string) - Required - The name of the controller to create.
- **package-name** (string) - Required - The name of the package where the controller will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### package:make-event

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new event class within a specified package.

```APIDOC
## [COMMAND] package:make-event

### Description
Creates a new event class.

### Command
package:make-event

### Arguments
#### Required Arguments
- **event-name** (string) - Required - The name of the event to create.
- **package-name** (string) - Required - The name of the package where the event will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### package:make-migration

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new migration class within a specified package.

```APIDOC
## [COMMAND] package:make-migration

### Description
Creates a new migration class.

### Command
package:make-migration

### Arguments
#### Required Arguments
- **migration-name** (string) - Required - The name of the migration to create.
- **package-name** (string) - Required - The name of the package where the migration will be created.
```

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

### Usage examples for package:make-middleware

Source: https://github.com/krayin/krayin-package-generator

Shows two command invocations: one without `--force` and one with `--force` to overwrite an existing middleware file. The `package` argument is a vendor/package slug like `ACME/TestPackage`.

```bash
php artisan package:make-middleware TestMiddleware ACME/TestPackage
php artisan package:make-middleware TestMiddleware ACME/TestPackage --force  # overwrite
```

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

### package:make-middleware

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new middleware class within a specified package.

```APIDOC
## [COMMAND] package:make-middleware

### Description
Creates a new middleware class.

### Command
package:make-middleware

### Arguments
#### Required Arguments
- **middleware-name** (string) - Required - The name of the middleware to create.
- **package-name** (string) - Required - The name of the package where the middleware will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### package:make-mail

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new mail class within a specified package.

```APIDOC
## [COMMAND] package:make-mail

### Description
Creates a new mail class.

### Command
package:make-mail

### Arguments
#### Required Arguments
- **mail-name** (string) - Required - The name of the mail to create.
- **package-name** (string) - Required - The name of the package where the mail will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### package:make-notification

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new notification class within a specified package.

```APIDOC
## [COMMAND] package:make-notification

### Description
Creates a new notification class.

### Command
package:make-notification

### Arguments
#### Required Arguments
- **notification-name** (string) - Required - The name of the notification to create.
- **package-name** (string) - Required - The name of the package where the notification will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### Create a new middleware class with force option

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Overwrites an existing middleware class if it already exists.

```php
php artisan package:make-middleware TestMiddleware ACME/TestPackage --force
```

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

### composer require krayin/krayin-package-generator

Source: https://github.com/krayin/krayin-package-generator

Install the Krayin Package Generator package into a Krayin v2.0.x project via Composer.

```bash
composer require krayin/krayin-package-generator
```

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

### package:make-request

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new request class within a specified package.

```APIDOC
## [COMMAND] package:make-request

### Description
Creates a new request class.

### Command
package:make-request

### Arguments
#### Required Arguments
- **request-name** (string) - Required - The name of the request to create.
- **package-name** (string) - Required - The name of the package where the request will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### package:make-provider

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new service provider class within a specified package.

```APIDOC
## [COMMAND] package:make-provider

### Description
Creates a new service provider class.

### Command
package:make-provider

### Arguments
#### Required Arguments
- **provider-name** (string) - Required - The name of the provider to create.
- **package-name** (string) - Required - The name of the package where the provider will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### Create a new migration class with php artisan package:make-migration

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a migration class in the Database/Migrations directory.

```php
php artisan package:make-migration TestMigration ACME/TestPackage
```

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

### Create a new repository class

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Generates a new repository class in packages/ACME/TestPackage/src/Repositories. Use the --force flag to overwrite an existing class.

```php
php artisan package:make-repository TestRepository ACME/TestPackage
```

```php
php artisan package:make-repository TestRepository ACME/TestPackage --force
```

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

### package:make-model

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new model class within a specified package.

```APIDOC
## [COMMAND] package:make-model

### Description
Creates a new model class.

### Command
package:make-model

### Arguments
#### Required Arguments
- **model-name** (string) - Required - The name of the model to create.
- **package-name** (string) - Required - The name of the package where the model will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### Create a new model contract with php artisan package:make-model-contract

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a model contract in the Contracts directory.

```php
php artisan package:make-model-contract TestContract ACME/TestPackage
```

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

### package:make-seeder

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new seeder class within a specified package.

```APIDOC
## [COMMAND] package:make-seeder

### Description
Creates a new seeder class.

### Command
package:make-seeder

### Arguments
#### Required Arguments
- **seeder-name** (string) - Required - The name of the seeder to create.
- **package-name** (string) - Required - The name of the package where the seeder will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### package:make-model-contract

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new model contract within a specified package.

```APIDOC
## [COMMAND] package:make-model-contract

### Description
Creates a new model contract.

### Command
package:make-model-contract

### Arguments
#### Required Arguments
- **model-contract-name** (string) - Required - The name of the model contract to create.
- **package-name** (string) - Required - The name of the package where the model contract will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### package:make-model-proxy

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new model proxy class within a specified package.

```APIDOC
## [COMMAND] package:make-model-proxy

### Description
Creates a new model proxy class.

### Command
package:make-model-proxy

### Arguments
#### Required Arguments
- **model-proxy-name** (string) - Required - The name of the model proxy to create.
- **package-name** (string) - Required - The name of the package where the model proxy will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### Create a new seeder class with force option

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Overwrites an existing seeder class if it already exists.

```php
php artisan package:make-seeder TestSeeder ACME/TestPackage --force
```

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

### Create a new listener class

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Generates a new listener class in packages/ACME/TestPackage/src/Listeners. Use the --force flag to overwrite an existing class.

```php
php artisan package:make-listener TestListener ACME/TestPackage
```

```php
php artisan package:make-listener TestListener ACME/TestPackage --force
```

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

### Create a new model proxy class with force option

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Overwrites an existing model proxy class if it already exists.

```php
php artisan package:make-model-proxy TestModelProxy ACME/TestPackage --force
```

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

### package:make-module-provider

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a new module service provider class within a specified package.

```APIDOC
## [COMMAND] package:make-module-provider

### Description
Creates a new module service provider class.

### Command
package:make-module-provider

### Arguments
#### Required Arguments
- **provider-name** (string) - Required - The name of the provider to create.
- **package-name** (string) - Required - The name of the package where the provider will be created.

### Options
- **--force** - Optional - To overwrite the files.
```

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

### php artisan package:make ACME/TestPackage

Source: https://github.com/krayin/krayin-package-generator

Generate a complete Krayin package with folder structure and scaffolded files.

```bash
php artisan package:make ACME/TestPackage
```

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

### Create a new datagrid class

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Generates a new datagrid class in packages/ACME/TestPackage/src/Datagrids. Use the --force flag to overwrite an existing class.

```php
php artisan package:make-datagrid TestDataGrid ACME/TestPackage
```

```php
php artisan package:make-datagrid TestDataGrid ACME/TestPackage --force
```

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

### Create a new middleware class with php artisan package:make-middleware

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a middleware class in the Http/Middleware directory.

```php
php artisan package:make-middleware TestMiddleware ACME/TestPackage
```

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

### Create a new seeder class with php artisan package:make-seeder

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a seeder class in the Database/Seeders directory.

```php
php artisan package:make-seeder TestSeeder ACME/TestPackage
```

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

### Create a new model proxy class with php artisan package:make-model-proxy

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a model proxy class in the Models directory.

```php
php artisan package:make-model-proxy TestModelProxy ACME/TestPackage
```

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

### Create a new model contract with force option

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Overwrites an existing model contract if it already exists.

```php
php artisan package:make-model-contract TestDataGrid ACME/TestPackage --force
```

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

### Create a new command class

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Generates a new command class in packages/ACME/TestPackage/src/Console/Commands. Use the --force flag to overwrite an existing class.

```php
php artisan package:make-command TestCommand ACME/TestPackage
```

```php
php artisan package:make-command TestCommand ACME/TestPackage --force
```

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

### Create a new request class with force option

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Overwrites an existing request class if it already exists.

```php
php artisan package:make-request TestRequest ACME/TestPackage --force
```

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

### Create a new service provider class

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Generates a new service provider class in packages/ACME/TestPackage/src/Providers. Use the --force flag to overwrite an existing class.

```php
php artisan package:make-provider TestServiceProvider ACME/TestPackage
```

```php
php artisan package:make-provider TestServiceProvider ACME/TestPackage --force
```

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

### Create a new request class with php artisan package:make-request

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a request class in the Http/Requests directory.

```php
php artisan package:make-request TestRequest ACME/TestPackage
```

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

### Create a new module service provider class

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Generates a new module service provider class in packages/ACME/TestPackage/src/Providers. Use the --force flag to overwrite an existing class.

```php
php artisan package:make-module-provider TestServiceProvider ACME/TestPackage
```

```php
php artisan package:make-module-provider TestServiceProvider ACME/TestPackage --force
```

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

### Create a new routes file with php artisan package:make-route

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Creates a routes file; you must register it in the service provider (e.g., ACME\TestPackage\Providers\TestPackageServiceProvider).

```php
php artisan package:make-route ACME/TestPackage
```

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

### Create a new event class

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Generates a new event class in packages/ACME/TestPackage/src/Events. Use the --force flag to overwrite an existing class.

```php
php artisan package:make-event TestEvent ACME/TestPackage
```

```php
php artisan package:make-event TestEvent ACME/TestPackage --force
```

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

### php artisan package:make-controller TestController ACME/TestPackage

Source: https://github.com/krayin/krayin-package-generator

Generate a single controller artifact inside an existing package.

```bash
php artisan package:make-controller TestController ACME/TestPackage
```

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

### Create a new mail class

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Generates a new mail class in packages/ACME/TestPackage/src/Mail. Use the --force flag to overwrite an existing class.

```php
php artisan package:make-mail TestMail ACME/TestPackage
```

```php
php artisan package:make-mail TestMail ACME/TestPackage --force
```

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

### Create a new notification class

Source: https://github.com/krayin/krayin-package-generator/blob/master/README.md

Generates a new notification class in packages/ACME/TestPackage/src/Notifications. Use the --force flag to overwrite an existing class.

```php
php artisan package:make-notification TestNotification ACME/TestPackage
```

```php
php artisan package:make-notification TestNotification ACME/TestPackage --force
```

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

### Usage: php artisan package:make-migration create_flights_table ACME/TestPackage

Source: https://github.com/krayin/krayin-package-generator

Example command to create a migration named create_flights_table for the ACME/TestPackage package. It produces a file in packages/ACME/TestPackage/src/Database/Migrations/.

```bash
php artisan package:make-migration create_flights_table ACME/TestPackage
```

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

### Basic usage command

Source: https://github.com/krayin/krayin-package-generator

Runs the command to create a repository. Writes packages/ACME/TestPackage/src/Repositories/UserRepository.php and its model() returns 'ACME\TestPackage\Contracts\User'.

```bash
php artisan package:make-repository UserRepository ACME/TestPackage
# writes packages/ACME/TestPackage/src/Repositories/UserRepository.php
# its model() returns 'ACME\TestPackage\Contracts\User'
```

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

### Usage commands

Source: https://github.com/krayin/krayin-package-generator

Shows how to invoke the command to create a listener. The --force flag overwrites an existing listener file.

```bash
php artisan package:make-listener TestListener ACME/TestPackage
php artisan package:make-listener TestListener ACME/TestPackage --force  # overwrite
```

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

### MakeCommand promptForMissingArgumentsUsing() method signature

Source: https://github.com/krayin/krayin-package-generator

Protected method signature for promptForMissingArgumentsUsing(). Returns an array keyed by 'name' with question and example, driving the interactive prompt when the name argument is omitted.

```php
// src/Console/Command/MakeCommand.php:98
protected function promptForMissingArgumentsUsing(): array
```

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

### getStubContents() override for datagrid stub

Source: https://github.com/krayin/krayin-package-generator

Overrides `getStubContents()` to render the `datagrid` stub using the package generator. The stub includes methods `prepareQueryBuilder`, `prepareColumns`, `prepareActions`, and `prepareMassActions`.

```php
// src/Console/Command/DatagridMakeCommand.php:34
protected function getStubContents(): string
{
    return $this->packageGenerator->getStubContents('datagrid', $this->getStubVariables());
}
```

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

### handle() method with fluent chain

Source: https://github.com/krayin/krayin-package-generator

The `handle()` method chains fluent setters on `packageGenerator` and calls `generate()`. It passes the command itself, the output components, and the package/plain/force arguments.

```php
// src/Console/Command/PackageMakeCommand.php:34
public function handle()
{
    $this->packageGenerator
        ->setPackageGenerator($this)
        ->setConsole($this->components)
        ->setPackage($this->argument('package'))
        ->setPlain($this->option('plain'))
        ->setForce($this->option('force'))
        ->generate();
}
```

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

### Usage commands

Source: https://github.com/krayin/krayin-package-generator

Shows how to invoke the command with and without the --force flag to overwrite an existing file.

```bash
php artisan package:make-request TestRequest ACME/TestPackage
php artisan package:make-request TestRequest ACME/TestPackage --force  # overwrite
```

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

### Usage commands for package:make-event

Source: https://github.com/krayin/krayin-package-generator

Shows how to create an event with and without the --force flag. The --force flag overwrites an existing event file.

```bash
php artisan package:make-event TestEvent ACME/TestPackage
php artisan package:make-event TestEvent ACME/TestPackage --force  # overwrite
```

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

### new Package(Filesystem $filesystem)

Source: https://github.com/krayin/krayin-package-generator

Constructor for the Package class. Initializes the filesystem abstraction used for directory checks and deletion.

```APIDOC
## Constructor

### Description
Initializes a new Package instance with the given filesystem.

### Method
`__construct`

### Parameters
- **$filesystem** (Illuminate\Filesystem\Filesystem) - Required - The Laravel filesystem facade/service used for directory checks and deletion.

### Returns
No return value.
```

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

### Verify commands with php artisan list

Source: https://github.com/krayin/krayin-package-generator

Command to list all package: prefixed artisan commands to verify the provider registered them correctly. The expected output shows the available make commands.

```bash
php artisan list | grep package:
# package:make
# package:make-command
# package:make-controller
# ... etc
```

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

### getStubContents() method

Source: https://github.com/krayin/krayin-package-generator

Returns the rendered stub contents for the module provider. It calls the package generator's getStubContents with the 'scaffold/module-provider' stub and the stub variables.

```php
// src/Console/Command/ModuleProviderMakeCommand.php:34
protected function getStubContents(): string
{
    return $this->packageGenerator->getStubContents('scaffold/module-provider', $this->getStubVariables());
}
```

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

### Equivalent make:migration command with --path

Source: https://github.com/krayin/krayin-package-generator

Shows the underlying Laravel command that package:make-migration effectively runs. It passes the migration name and the --path option to create the file in the package's Database/Migrations directory.

```bash
php artisan make:migration create_flights_table --path=packages/ACME/TestPackage/src/Database/Migrations
```

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

### Error message when file exists

Source: https://github.com/krayin/krayin-package-generator

Shows the error message emitted when the module provider file already exists and --force is not provided.

```bash
# Module Provider [<path>/ModuleServiceProvider.php] already exists.
```

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

### Plain skeleton-only command

Source: https://github.com/krayin/krayin-package-generator

Generates only the directory skeleton without writing files or classes.

```bash
php artisan package:make ACME/TestPackage --plain
```

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

### handle() method spawning proxy and contract commands

Source: https://github.com/krayin/krayin-package-generator

Overrides handle() to call parent::handle() (which writes the model file), then invokes 'package:make-model-proxy' with name '{name}Proxy' and 'package:make-model-contract' with name '{name}', both forwarding the same package and --force option. This produces three files in one run.

```php
// src/Console/Command/ModelMakeCommand.php:34
public function handle()
{
    parent::handle();

    $this->call('package:make-model-proxy', [
        'name'    => $this->argument('name').'Proxy',
        'package' => $this->argument('package'),
        '--force' => $this->option('force'),
    ]);

    $this->call('package:make-model-contract', [
        'name'    => $this->argument('name'),
        'package' => $this->argument('package'),
        '--force' => $this->option('force'),
    ]);
}
```

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

### Signature for package:make-command

Source: https://github.com/krayin/krayin-package-generator

Shows the command signature with arguments and options.

```text
package:make-command {name} {package} {--force}
```

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

### getStubContents() method

Source: https://github.com/krayin/krayin-package-generator

Overrides the inherited hook to render the 'repository' stub using the package generator. The stub extends Webkul\Core\Eloquent\Repository and its model() helper returns the $CONTRACT_CLASS$.

```php
// src/Console/Command/RepositoryMakeCommand.php:32
protected function getStubContents(): string
{
    return $this->packageGenerator->getStubContents('repository', $this->getStubVariables());
}
```

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

### Prompt for missing name when omitted

Source: https://github.com/krayin/krayin-package-generator

When the name argument is omitted, the command prompts for it because it implements PromptsForMissingInput. The example shows the prompt and a sample input.

```bash
php artisan package:make-controller ACME/TestPackage
# What should the controller be named? (E.g. UserController)
> TestController
```

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

### getStubContents method

Source: https://github.com/krayin/krayin-package-generator

Overrides the stub selection logic. Since the signature only declares --force, hasOption('plain') is always false, so 'scaffold/package-provider' is always used.

```php
// src/Console/Command/ProviderMakeCommand.php:34
protected function getStubContents(): string
{
    $stub = $this->hasOption('plain') ? 'provider' : 'scaffold/package-provider';

    return $this->packageGenerator->getStubContents($stub, $this->getStubVariables());
}
```

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

### Standalone Package instantiation and existence check

Source: https://github.com/krayin/krayin-package-generator

Shows how to manually instantiate the Package class with a new Filesystem instance and check if a package exists.

```php
use Illuminate\Filesystem\Filesystem;
use Webkul\PackageGenerator\Package;

$package = new Package(new Filesystem);

if ($package->has('ACME/TestPackage')) {
    // package exists — decide whether to overwrite
}
```

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

### Command signature: package:make-datagrid

Source: https://github.com/krayin/krayin-package-generator

The command signature as displayed in the documentation. It takes a datagrid class name and a vendor/package slug, with an optional `--force` flag to overwrite an existing file.

```bash
package:make-datagrid {name} {package} {--force}
```

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

### createFiles(): void

Source: https://github.com/krayin/krayin-package-generator

Creates the stub files for the package. Iterates over stub files, renders each, and writes them.

```APIDOC
## createFiles(): void

### Description
Iterates `$this->stubFiles[$this->type]` (`stub-name` → relative destination), renders each via `getStubContents()`, ensures the parent directory exists, writes the file with `$this->filesystem->put(...)`, and emits `Created file : <path>` via `$this->console->info(...)`.

### Method
createFiles

### Parameters
None

### Returns
`void`
```

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

### getStubContents() method

Source: https://github.com/krayin/krayin-package-generator

Returns the rendered 'model' stub by delegating to packageGenerator->getStubContents() with the stub variables from getStubVariables().

```php
// src/Console/Command/ModelMakeCommand.php:54
protected function getStubContents(): string
{
    return $this->packageGenerator->getStubContents('model', $this->getStubVariables());
}
```

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

### Command signature

Source: https://github.com/krayin/krayin-package-generator

Shows the command signature for 'package:make-provider' with required arguments and the --force flag.

```bash
package:make-provider {name} {package} {--force}
```

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

### Error message when file exists

Source: https://github.com/krayin/krayin-package-generator

Shows the error output when the repository file already exists and --force is not provided.

```bash
# Repository [<path>/UserRepository.php] already exists.
```

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

### Command signature

Source: https://github.com/krayin/krayin-package-generator

Shows the command signature with arguments and options. `package` is required, `--plain` and `--force` are flags.

```text
package:make {package} {--plain} {--force}
```

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

### Error message when datagrid already exists

Source: https://github.com/krayin/krayin-package-generator

Output shown when the datagrid file already exists and `--force` is not provided. The message includes the full path to the existing file.

```bash
# Datagrid [<path>/TestDataGrid.php] already exists.
```

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

### MakeCommand constructor with injected dependencies

Source: https://github.com/krayin/krayin-package-generator

Constructor for MakeCommand (src/Console/Command/MakeCommand.php:24) receives only framework-injected dependencies: Filesystem and PackageGenerator. There is no user-configurable option array.

```php
// MakeCommand constructor (src/Console/Command/MakeCommand.php:24)
public function __construct(
    protected Filesystem $filesystem,
    protected PackageGenerator $packageGenerator
)
```

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

### Error path when file exists without --force

Source: https://github.com/krayin/krayin-package-generator

Shows the error message emitted when the provider file already exists and --force is not provided.

```bash
# Provider [<path>/TestServiceProvider.php] already exists.
```

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

### getStubVariables() method

Source: https://github.com/krayin/krayin-package-generator

Builds the stub variables: NAMESPACE (package\Repositories), CLASS, and CONTRACT_CLASS (package\Contracts\<ContractName>). The contract name is derived by stripping the 'Repository' suffix.

```php
// src/Console/Command/RepositoryMakeCommand.php:40
protected function getStubVariables(): array
{
    return [
        'NAMESPACE'      => $this->getClassNamespace($this->argument('package').'/Repositories'),
        'CLASS'          => $this->getClassName(),
        'CONTRACT_CLASS' => $this->getClassNamespace($this->argument('package').'/Contracts/'.$this->getContractName()),
    ];
}
```

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

### getStubContents() method

Source: https://github.com/krayin/krayin-package-generator

Overrides the parent method to render the 'listener' stub using the package generator. Returns the stub content as a string.

```php
// src/Console/Command/ListenerMakeCommand.php:34
protected function getStubContents(): string
{
    return $this->packageGenerator->getStubContents('listener', $this->getStubVariables());
}
```

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

### RepositoryMakeCommand class declaration with #[AsCommand]

Source: https://github.com/krayin/krayin-package-generator

Declares the command class for 'package:make-repository'. It extends MakeCommand and sets the signature, type, and description. The command writes a repository extending Webkul\Core\Eloquent\Repository.

```php
// src/Console/Command/RepositoryMakeCommand.php:7
#[AsCommand(name: 'package:make-repository')]
class RepositoryMakeCommand extends MakeCommand
{
    protected $signature = 'package:make-repository {name} {package} {--force}';
    protected $type = 'Repository';
    protected $description = 'Create a new repository.';
}
```

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

### MakeCommand default handle() pipeline

Source: https://github.com/krayin/krayin-package-generator

Default flow for all *MakeCommand subclasses: getSourceFilePath() -> mkdir parent dir (0777 recursive) -> getStubContents() -> write file. With --force it overwrites; otherwise errors with '%s [%s] already exists.' and returns.

```text
getSourceFilePath() -> mkdir parent dir (0777 recursive) -> getStubContents() -> write file
```

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

### Usage commands

Source: https://github.com/krayin/krayin-package-generator

Shows how to run the command with and without --force. The --force flag overwrites an existing mail file.

```bash
php artisan package:make-mail TestMail ACME/TestPackage
php artisan package:make-mail TestMail ACME/TestPackage --force  # overwrite
```

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

### Error message when seeder exists

Source: https://github.com/krayin/krayin-package-generator

Output shown when the seeder file already exists and --force is not provided.

```bash
# Seeder [<path>/TestSeeder.php] already exists.
```

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

### Command signature for package:make-controller

Source: https://github.com/krayin/krayin-package-generator

Shows the command signature with required `name` and `package` arguments and optional `--force` flag. The `name` is the controller class name (e.g., `TestController`), `package` is the vendor/package slug (e.g., `ACME/TestPackage`), and `--force` overwrites an existing file.

```bash
package:make-controller {name} {package} {--force}
```

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

### handle() method delegating to make:migration

Source: https://github.com/krayin/krayin-package-generator

The handle() method calls Laravel's built-in make:migration with the provided name and a --path pointing to packages/<package>/src/Database/Migrations. It returns nothing and relies on Laravel's native migration behavior.

```php
// src/Console/Command/MigrationMakeCommand.php:34
public function handle()
{
    $this->call('make:migration', [
        'name'   => $this->argument('name'),
        '--path' => 'packages/'.$this->argument('package').'/src/Database/Migrations',
    ]);
}
```

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

### MakeCommand handle() method signature

Source: https://github.com/krayin/krayin-package-generator

Public method signature for the handle() method. The method orchestrates file creation: computes source path, ensures directory exists, renders stub, writes or overwrites with --force, and outputs success or error messages.

```php
// src/Console/Command/MakeCommand.php:38
public function handle()
```

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

### Canonical invocation from PackageMakeCommand::handle()

Source: https://github.com/krayin/krayin-package-generator

Shows the standard way to configure and run the package generator from a console command. It sets the issuing command, output component, package name, and options before calling generate().

```php
use Webkul\PackageGenerator\Generators\PackageGenerator;

/** @var PackageGenerator $packageGenerator container-resolved */
$packageGenerator
    ->setPackageGenerator($this)      // the issuing console command
    ->setConsole($this->components)   // output component
    ->setPackage($this->argument('package'))
    ->setPlain($this->option('plain'))
    ->setForce($this->option('force'))
    ->generate();
```

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

### Command signature for package:make-middleware

Source: https://github.com/krayin/krayin-package-generator

Shows the exact command signature with arguments `name` and `package` (both required) and the `--force` flag (default false) to overwrite an existing middleware file.

```bash
package:make-middleware {name} {package} {--force}
```

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

### Error output when event exists

Source: https://github.com/krayin/krayin-package-generator

Output shown when the event file already exists and --force is not provided.

```bash
# Event [<path>/TestEvent.php] already exists.
```

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

### PackageGenerator fluent builder chain

Source: https://github.com/krayin/krayin-package-generator

Fluent builder for whole-package scaffold: setPackageGenerator()->setConsole()->setPackage()->setPlain()->setForce()->generate(). generate() aborts with 'Package %s already exist !' if destination exists and --force is not set; otherwise deletes and recreates.

```text
setPackageGenerator()->setConsole()->setPackage()->setPlain()->setForce()->generate()
```

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

### getStubVariables() method

Source: https://github.com/krayin/krayin-package-generator

Returns the stub variables for the module provider. It provides the namespace (package\Providers) and the class name.

```php
// src/Console/Command/ModuleProviderMakeCommand.php:42
protected function getStubVariables(): array
{
    return [
        'NAMESPACE' => $this->getClassNamespace($this->argument('package').'/Providers'),
        'CLASS'     => $this->getClassName(),
    ];
}
```

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

### getSourceFilePath() override for datagrid

Source: https://github.com/krayin/krayin-package-generator

Returns the destination file path under `packages/<package>/src/DataGrids/<Class>.php`. The path is built from `base_path('packages/...')` and the class name.

```php
// src/Console/Command/DatagridMakeCommand.php:53
protected function getSourceFilePath(): string
{
    $path = base_path('packages/'.$this->argument('package')).'/src/DataGrids';

    return "$path/{$this->getClassName()}.php";
}
```

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

### getSourceFilePath() method

Source: https://github.com/krayin/krayin-package-generator

Returns the file path where the module provider will be written. It constructs the path under packages/<package>/src/Providers with the class name.

```php
// src/Console/Command/ModuleProviderMakeCommand.php:53
protected function getSourceFilePath(): string
{
    $path = base_path('packages/'.$this->argument('package')).'/src/Providers';

    return "$path/{$this->getClassName()}.php";
}
```

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

### getStubContents() override

Source: https://github.com/krayin/krayin-package-generator

Overrides getStubContents() to render the 'mail' stub with stub variables. Inherits handle() from MakeCommand.

```php
// src/Console/Command/MailMakeCommand.php:34
protected function getStubContents(): string
{
    return $this->packageGenerator->getStubContents('mail', $this->getStubVariables());
}
```

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

### Error output when file exists

Source: https://github.com/krayin/krayin-package-generator

Displays the error message emitted when the request file already exists and --force is not provided.

```bash
# Request [<path>/TestRequest.php] already exists.
```

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

### getStubContents method

Source: https://github.com/krayin/krayin-package-generator

Returns the rendered routes stub using the package generator.

```php
// src/Console/Command/RouteMakeCommand.php:34
protected function getStubContents(): string
{
    return $this->packageGenerator->getStubContents('routes', $this->getStubVariables());
}
```

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

### Command signature: package:make-migration {name} {package}

Source: https://github.com/krayin/krayin-package-generator

Shows the command signature for package:make-migration. It requires a migration name and a vendor/package slug. There is no --force option for this command.

```text
package:make-migration {name} {package}
```

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

### getStubVariables method

Source: https://github.com/krayin/krayin-package-generator

Returns the stub variables: NAMESPACE, CLASS, and LOWER_NAME. These are used to render the provider stub.

```php
// src/Console/Command/ProviderMakeCommand.php:44
protected function getStubVariables(): array
{
    return [
        'NAMESPACE'  => $this->getClassNamespace($this->argument('package').'/Providers'),
        'CLASS'      => $this->getClassName(),
        'LOWER_NAME' => $this->getLowerName(),
    ];
}
```

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

### createFolders(): void

Source: https://github.com/krayin/krayin-package-generator

Creates the folder structure for the package. Iterates over paths and makes directories.

```APIDOC
## createFolders(): void

### Description
Iterates `$this->paths[$this->type]` and calls `$this->filesystem->makeDirectory(base_path('packages/'.$this->packageName.'/src').'/'.$folder, 0755, true)` for each.

### Method
createFolders

### Parameters
None

### Returns
`void`
```

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

### getStubContents method

Source: https://github.com/krayin/krayin-package-generator

Returns the stub contents for the command stub using the package generator.

```php
// src/Console/Command/CommandMakeCommand.php:34
protected function getStubContents(): string
{
    return $this->packageGenerator->getStubContents('command', $this->getStubVariables());
}
```

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

### Force overwrite usage

Source: https://github.com/krayin/krayin-package-generator

Uses the --force flag to overwrite an existing module provider file.

```bash
php artisan package:make-module-provider ModuleServiceProvider ACME/TestPackage --force
```
Tokens:
Raw