Laravel Packager

https://github.com/jeroen-g/laravel-packager
Admin
This package provides a simple tool to set up new Laravel packages, handling boilerplate code to...
Tokens:16,982
Snippets:261
Trust Score:9.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### GetPackage Usage Examples

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Examples of downloading packages from GitHub or Bitbucket with optional parameters.

```bash
php artisan packager:get https://github.com/author/repository

# Custom vendor/package names
php artisan packager:get https://github.com/author/repository my-vendor my-package

# Specific branch
php artisan packager:get https://github.com/author/repository --branch=develop

# Bitbucket repository
php artisan packager:get https://bitbucket.org/author/repository --host=bitbucket
```

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

### Install Package

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Installs the package by adding a path repository and requiring it.

```php
public function installPackage(): void
```

```php
$conveyor->vendor('acme');
$conveyor->package('widget');
$conveyor->installPackage();
```

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

### RemovePackage Usage Examples

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Examples of how to invoke the remove command using vendor and package names.

```bash
php artisan packager:remove my-vendor my-package
php artisan packager:remove my-vendor/my-package
```

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

### Enable Package Usage

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Example command to enable a specific package.

```bash
php artisan packager:enable my-vendor my-package
```

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

### Archive Format Usage Examples

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/errors.md

Examples of valid and invalid skeleton archive URLs for the packager command.

```bash
# Good - ZIP
php artisan packager:new my-vendor my-package --skeleton="https://github.com/user/skeleton/archive/master.zip"

# Good - TAR.GZ
php artisan packager:new my-vendor my-package --skeleton="https://github.com/user/skeleton/archive/refs/heads/main.tar.gz"

# Bad - RAR (not supported)
php artisan packager:new my-vendor my-package --skeleton="https://example.com/skeleton.rar"
```

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

### installPackage

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Installs the package by adding a path repository and requiring it.

```APIDOC
## public function installPackage(): void

### Description
Install the package by adding a path repository and requiring it. Calls addPathRepository() then requirePackage().
```

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

### Execute ListPackages Command

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Examples of listing packages with or without git status information.

```bash
# Basic list
php artisan packager:list

# With git information
php artisan packager:list --git
php artisan packager:list -g
```

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

### Execute GitPackage Command

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Examples of cloning packages using HTTPS, SSH, or custom vendor and package names.

```bash
# HTTPS URL
php artisan packager:git https://github.com/author/repository

# SSH URL
php artisan packager:git git@github.com:author/repository.git

# Custom vendor/package
php artisan packager:git https://github.com/author/repository my-vendor my-package
```

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

### Installing Missing Security Checker

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/errors.md

Install the required SensioLabs security dependency to resolve missing class errors.

```bash
composer require sensiolabs/security-checker
```

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

### Valid Vendor Name Examples

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/errors.md

Examples of valid vendor names that conform to PHP classname requirements.

```bash
php artisan packager:new my-vendor my-package        # Valid
php artisan packager:new MyVendor my-package         # Valid
php artisan packager:new _private my-package         # Valid
```

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

### NewPackage Usage Examples

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Various ways to invoke the packager:new command, including basic creation, interactive mode, and custom skeleton URLs.

```bash
# Basic creation with defaults
php artisan packager:new my-vendor my-package

# Using slash notation
php artisan packager:new my-vendor/my-package

# Interactive mode with prompts
php artisan packager:new --i
php artisan packager:new my-vendor my-package --i

# Custom skeleton
php artisan packager:new my-vendor my-package --skeleton="https://github.com/custom/skeleton/archive/main.zip"
```

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

### Check Package Security Usage

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Example for checking security vulnerabilities in a specific package.

```bash
php artisan packager:check my-vendor my-package
```

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

### packager:get

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Downloads a package from GitHub or Bitbucket as an archive.

```APIDOC
## Command: packager:get

### Description
Download a package from GitHub or Bitbucket (archive only, without git history).

### Signature
`php artisan packager:get {url} {vendor?} {name?} {--host=github} {--branch=master}`

### Arguments
- **url** (string) - Required - Repository URL
- **vendor** (string) - Optional - Vendor name (extracted from URL if omitted)
- **name** (string) - Optional - Package name (extracted from URL if omitted)

### Options
- **--host** (string) - Default: github - Source: 'github' or 'bitbucket'
- **--branch** (string) - Default: master - Branch to download

### Usage Examples
`php artisan packager:get https://github.com/author/repository`
`php artisan packager:get https://github.com/author/repository my-vendor my-package`
`php artisan packager:get https://github.com/author/repository --branch=develop`
`php artisan packager:get https://bitbucket.org/author/repository --host=bitbucket`
```

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

### packager:list

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Displays all locally installed packages with optional git status information.

```APIDOC
## packager:list

### Description
Display all locally installed packages.

### Signature
`packager:list {--g|git}`

### Options
- **--git** (flag) - Show git status (branch, commits behind/ahead)

### Usage Examples
```bash
# Basic list
php artisan packager:list

# With git information
php artisan packager:list --git
php artisan packager:list -g
```
```

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

### Move Package Tests Usage

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Examples for moving tests for all packages or a specific package.

```bash
# Move tests for all packages
php artisan packager:tests

# Move tests for specific package
php artisan packager:tests my-vendor my-package
```

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

### Invalid Vendor Name Examples

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/errors.md

Examples of vendor names that trigger validation errors due to invalid characters or formatting.

```bash
# Invalid vendor names
php artisan packager:new "123vendor" my-package      # Starts with digit
php artisan packager:new "@invalid" my-package       # Invalid character
php artisan packager:new "" my-package               # Empty name
```

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

### Define ListPackages Signature

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

The command signature for listing installed packages, including the optional git flag.

```php
'packager:list {--g|git}'
```

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

### Disable Package Usage

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Example command to disable a specific package.

```bash
php artisan packager:disable my-vendor my-package
```

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

### Install Laravel Packager via Composer

Source: https://github.com/jeroen-g/laravel-packager/blob/master/readme.md

Use this command to add the package as a development dependency to your Laravel project.

```bash
composer require jeroen-g/laravel-packager --dev
```

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

### Get an extractor via Manager

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/ArchiveExtractors.md

Retrieves an extractor instance based on the provided file extension.

```php
public function getExtractor(string $archiveExtension): Extractor
```

```php
$manager = new Manager();
$zip = $manager->getExtractor('zip');
$zip->extract('/tmp/archive.zip', '/target/dir');
```

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

### Resolving Missing Composer Lock File

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/errors.md

Run composer install within the package directory to generate the missing lock file.

```bash
cd packages/vendor/package
composer install
cd ../../../
php artisan packager:check vendor package
```

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

### Get archive extension

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/FileHandler.md

Determines the archive type from a file path, supporting double extensions like .tar.gz.

```php
protected function getArchiveExtension(string $archiveFilePath): string
```

```php
$conveyor->getArchiveExtension('/tmp/archive.tar.gz'); // returns 'tar.gz'
```

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

### List packages

Source: https://github.com/jeroen-g/laravel-packager/blob/master/readme.md

Displays an overview of all packages in the packages directory.

```bash
php artisan packager:list
```

```bash
php artisan packager:list --git
```

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

### Create New Packages

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/README.md

Generate new packages using interactive mode, default parameters, or custom skeleton URLs.

```bash
# Interactive mode
php artisan packager:new --i

# With defaults
php artisan packager:new acme widget

# With custom skeleton
php artisan packager:new acme widget --skeleton="https://github.com/custom/skeleton/archive/main.zip"
```

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

### Initialize Progress Bar

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Utilities.md

Sets up the progress bar with a specific number of steps. Must be called before advancing the bar.

```php
$this->startProgressBar(6);
```

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

### Create a new package

Source: https://github.com/jeroen-g/laravel-packager/blob/master/readme.md

Generates a new package structure with a skeleton, composer.json, and service provider.

```bash
php artisan packager:new my-vendor my-package
```

```bash
php artisan packager:new my-vendor my-package --i
php artisan packager:new --i
```

```bash
php artisan packager:new my-vendor/my-package
```

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

### Manage Package Name

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Set or retrieve the package name.

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

```php
$conveyor->package('mypackage');
echo $conveyor->package(); // outputs: mypackage
```

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

### ValidClassName Usage

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/types.md

Example of integrating the ValidClassName rule within a Laravel Validator instance.

```php
use Illuminate\Support\Facades\Validator;
use JeroenG\Packager\ValidationRules\ValidClassName;

$validator = Validator::make(compact('vendor', 'name'), [
    'vendor' => new ValidClassName,
    'name' => new ValidClassName,
]);

if ($validator->fails()) {
    foreach ($validator->errors()->all() as $error) {
        // Handle error: "The package vendor must conform to a valid PHP classname."
    }
}
```

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

### ProgressBar::startProgressBar

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Utilities.md

Initializes and displays a progress bar for console commands.

```APIDOC
## public function startProgressBar(int $steps): void

### Description
Initializes and displays a progress bar. Must be called before makeProgress().

### Parameters
- **$steps** (int) - Required - Number of steps the progress bar will track
```

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

### Troubleshooting Git Clone Failures

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/errors.md

Verify repository URLs and authentication configurations when cloning fails.

```bash
# Verify URL is correct
git clone https://github.com/user/repo

# For private repositories, use SSH with configured keys
php artisan packager:git git@github.com:user/repo.git

# Or ensure Git credentials are configured
git config --global user.name "Your Name"
git config --global user.email "email@example.com"
```

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

### Enable Package Signature

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

The command signature for enabling a package.

```php
'packager:enable {vendor} {name}'
```

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

### Complete Configuration File

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/configuration.md

The default configuration file structure for Laravel Packager, defining skeleton source, network timeouts, and author defaults.

```php
<?php

return [

    /*
     * The following skeleton will be downloaded for each new package.
     * Default: https://github.com/Jeroen-G/packager-skeleton/archive/master.zip
     */
    'skeleton' => 'https://github.com/Jeroen-G/packager-skeleton/archive/master.zip',

    /*
     * When you run into issues downloading the skeleton, this might be because of
     * a file regarding SSL certificates missing on the (Windows) OS.
     * This can be solved by setting the verification of the certificate to false.
     * Of course this means it will be less secure.
     */
    'curl_verify_cert' => env('CURL_VERIFY', true),

    /**
     * On slow connections, setting a larger timeout might help to finish downloading package files.
     * Default: 60.
     */
    'timeout' => '60',

    /*
     * You can set defaults for the following placeholders.
     */
    'author_name' => 'Author Name',
    'author_email' => 'author@email.com',
    'author_homepage' => 'http://author.com',
    'license' => 'MIT',
];
```

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

### Configuration

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/README.md

Configuration keys available in config/packager.php.

```APIDOC
## Configuration Keys

- `packager.skeleton`: Default skeleton URL
- `packager.curl_verify_cert`: SSL verification (env: CURL_VERIFY)
- `packager.timeout`: Download timeout in seconds
- `packager.author_name`: Default author name
- `packager.author_email`: Default author email
- `packager.author_homepage`: Default author website
- `packager.license`: Default license
```

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

### Initialize the Manager class

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/ArchiveExtractors.md

Constructor for the Manager factory, which comes pre-configured with ZIP, TAR, and TAR.GZ support.

```php
public function __construct()
```

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

### packager:new

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Creates a new Laravel package from a skeleton.

```APIDOC
## php artisan packager:new

### Description
Create a brand new Laravel package from a skeleton.

### Signature
`packager:new {vendor?} {name?} {--i} {--skeleton=}`

### Arguments
- **vendor** (string) - Optional - Vendor name (can use slash: vendor/name)
- **name** (string) - Optional - Package name

### Options
- **--i** (bool) - Interactive mode - prompt for all inputs
- **--skeleton** (string) - Custom skeleton URL (default: config)

### Usage Examples
```bash
# Basic creation with defaults
php artisan packager:new my-vendor my-package

# Using slash notation
php artisan packager:new my-vendor/my-package

# Interactive mode with prompts
php artisan packager:new --i
php artisan packager:new my-vendor my-package --i

# Custom skeleton
php artisan packager:new my-vendor my-package --skeleton="https://github.com/custom/skeleton/archive/main.zip"
```

### Return Codes
- **0** - Success
- **1** - Validation failed
```

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

### Convert Package Name to kebab-case

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Retrieves the package name formatted in kebab-case. Throws a RuntimeException if the package is not set.

```php
public function packageKebab(): string
```

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

### Verify Package Existence

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/FileHandler.md

Checks if the package directory already exists, throwing a RuntimeException if it does.

```php
try {
    $conveyor->checkIfPackageExists();
} catch (RuntimeException $e) {
    echo "Package already exists";
}
```

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

### CLI Commands

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/README.md

List of available Artisan commands for package management.

```APIDOC
## CLI Commands

- `packager:new`: Create new package from skeleton
- `packager:remove`: Delete package and uninstall
- `packager:get`: Download package archive from GitHub/Bitbucket
- `packager:git`: Clone package with git history
- `packager:list`: Display all local packages
- `packager:tests`: Copy package tests to main test directory
- `packager:check`: Security scan with SensioLabs checker
- `packager:publish`: Push package to GitHub
- `packager:enable`: Register package with Composer
- `packager:disable`: Unregister package without deletion
```

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

### Import a package

Source: https://github.com/jeroen-g/laravel-packager/blob/master/readme.md

Registers an existing package into the application's composer.json file.

```bash
php artisan packager:get https://github.com/author/repository
php artisan packager:git https://github.com/author/repository
```

```bash
php artisan packager:get https://github.com/author/repository --branch=develop
php artisan packager:get https://github.com/author/repository my-vendor my-package
php artisan packager:git https://github.com/author/repository my-vendor my-package
```

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

### Manage Vendor Namespace

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Set or retrieve the package vendor namespace.

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

```php
$conveyor = new Conveyor();
$conveyor->vendor('myvendor');
echo $conveyor->vendor(); // outputs: myvendor
```

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

### Retrieve Existing Packages

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/README.md

Import packages from remote repositories like GitHub or Bitbucket, optionally including git history.

```bash
# From GitHub
php artisan packager:get https://github.com/author/package

# From Bitbucket
php artisan packager:get https://bitbucket.org/author/package --host=bitbucket

# With git history
php artisan packager:git https://github.com/author/package.git
```

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

### Download Skeleton Package

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Downloads and extracts a skeleton package archive to the final package path.

```php
public function downloadSkeleton(?string $skeletonArchiveUrl = null): void
```

```php
$conveyor->vendor('acme');
$conveyor->package('widget');
$conveyor->downloadSkeleton('https://github.com/user/skeleton/archive/master.zip');
```

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

### Retrieve Packages Path

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/FileHandler.md

Returns the absolute path to the base packages directory.

```php
$path = $conveyor->packagesPath(); // /app/packages
```

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

### Configure Laravel Packager

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/README.md

Define package skeleton source, network settings, and default author metadata in the configuration file.

```php
// config/packager.php

return [
    // Skeleton package URL
    'skeleton' => 'https://github.com/Jeroen-G/packager-skeleton/archive/master.zip',
    
    // SSL certificate verification (env: CURL_VERIFY)
    'curl_verify_cert' => env('CURL_VERIFY', true),
    
    // Download timeout in seconds
    'timeout' => '60',
    
    // Default author metadata
    'author_name' => 'Author Name',
    'author_email' => 'author@email.com',
    'author_homepage' => 'http://author.com',
    'license' => 'MIT',
];
```

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

### Configure skeleton package URL

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/configuration.md

Sets the default archive URL for new packages. Can be overridden via the --skeleton command option.

```php
'skeleton' => 'https://github.com/Jeroen-G/packager-skeleton/archive/master.zip',
```

```bash
# Use default skeleton
php artisan packager:new my-vendor my-package

# Use custom skeleton
php artisan packager:new my-vendor my-package --skeleton="https://github.com/custom/skeleton/archive/main.zip"
```

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

### Convert Package Name to StudlyCase

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Retrieves the package name formatted in StudlyCase. Throws a RuntimeException if the package is not set.

```php
public function packageStudly(): string
```

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

### Publish Configuration

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Utilities.md

Publishes the package configuration file to the application's config directory.

```bash
php artisan vendor:publish --provider="JeroenG\Packager\PackagerServiceProvider"
```

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

### Enable or Disable Packages

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/README.md

Register or unregister packages without deleting the underlying files.

```bash
# Disable (unregister, keep files)
php artisan packager:disable acme widget

# Enable (register again)
php artisan packager:enable acme widget
```

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

### Retrieve Package Path

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/FileHandler.md

Returns the full directory path for a specific package. Throws a RuntimeException if vendor or package is not set.

```php
$conveyor->vendor('acme');
$conveyor->package('widget');
echo $conveyor->packagePath(); // /app/packages/acme/widget
```

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

### GetPackage Command Signature

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

The command signature for downloading a package.

```php
'packager:get {url} {vendor?} {name?} {--host=github} {--branch=master}'
```

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

### Handle existing package RuntimeException

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/errors.md

Triggered when a package directory already exists. Resolve by removing the existing package or choosing a new name.

```php
$conveyor = new Conveyor();
$conveyor->vendor('my-vendor');
$conveyor->package('my-package');

// Directory /app/packages/my-vendor/my-package exists
try {
    $conveyor->checkIfPackageExists(); // Throws RuntimeException
} catch (RuntimeException $e) {
    echo $e->getMessage(); // "Package already exists"
}
```

```bash
php artisan packager:remove my-vendor my-package
```

```bash
php artisan packager:new my-vendor my-new-package
```

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

### downloadSkeleton

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Downloads and extracts a skeleton package archive.

```APIDOC
## public function downloadSkeleton(?string $skeletonArchiveUrl = null): void

### Description
Downloads the skeleton archive, detects file extension, extracts to a temporary directory, and moves to the final package path. Cleans up temporary files.

### Parameters
- **$skeletonArchiveUrl** (string) - Optional - Full URL to skeleton archive (Default: config('packager.skeleton'))
```

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

### ProgressBar Methods

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/SYMBOLS.md

Methods for managing progress bar lifecycle during package operations.

```APIDOC
## ProgressBar Methods

### startProgressBar(int $steps)
- Returns: void
- Description: Initialize the progress bar with a specific number of steps.

### makeProgress()
- Returns: void
- Description: Increment the progress bar.

### finishProgress(string $message)
- Returns: void
- Description: Complete the progress bar with a final message.
```

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

### FileHandler Methods

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/SYMBOLS.md

Methods for managing package directories, file downloads, extraction, and cleanup operations.

```APIDOC
## FileHandler Methods

### packagesPath()
- Returns: string
- Description: Get packages directory path.

### vendorPath()
- Returns: string
- Description: Get vendor directory path.

### tempPath()
- Returns: string
- Description: Get temporary directory path.

### packagePath()
- Returns: string
- Description: Get full package path.

### makeFilename(string $extension = 'zip')
- Returns: string
- Description: Generate temp filename.

### checkIfPackageExists()
- Returns: void
- Description: Throws if package exists.

### makeDir(string $path)
- Returns: bool
- Description: Create directory.

### removeDir(string $path)
- Returns: bool
- Description: Remove directory recursively.

### download(string $filePath, string $sourceFileUrl)
- Returns: self
- Description: Download file (chainable).

### extract(string $archiveFilePath, string $directory)
- Returns: self
- Description: Extract archive (chainable).

### cleanUp(string $pathToArchive)
- Returns: self
- Description: Remove archive file (chainable).

### renameFiles(?array $manifest = null)
- Returns: void
- Description: Rename placeholder files.

### cleanUpRules()
- Returns: void
- Description: Remove rule files.
```

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

### Publish a package

Source: https://github.com/jeroen-g/laravel-packager/blob/master/readme.md

Publishes a local package to a remote GitHub repository.

```bash
php artisan packager:publish my-vendor my-package https://github.com/my-vendor/my-package
```

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

### Resolve Directory Permission Issues

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/errors.md

Commands to verify and correct directory ownership and permissions for the packages directory.

```bash
# Check permissions
ls -la packages/

# Fix ownership (if needed)
sudo chown -R $USER packages/

# Ensure directory is writable
chmod -R 755 packages/
```

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

### fill

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Wrapping.md

Applies all accumulated replacements to all files in a directory recursively.

```APIDOC
## fill($path)

### Description
Apply all accumulated replacements to all files in a directory recursively. Iterates through all files in the directory, calling fillInFile() for each.

### Parameters
- **$path** (string) - Required - Directory path to process
```

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

### Configure CURL_VERIFY Environment Variable

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/configuration.md

Environment variable settings to toggle SSL certificate verification for package downloads.

```bash
CURL_VERIFY=true   # Enable verification (default)
CURL_VERIFY=false  # Disable verification (less secure)
```

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

### NewPackage Command Signature

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

The command signature for creating a new package, including optional vendor and name arguments and skeleton configuration.

```php
'packager:new {vendor?} {name?} {--i} {--skeleton=}'
```

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

### Locate the Configuration File

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/README.md

The package configuration is stored in this file path within your Laravel project.

```bash
config/packager.php
```

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

### packager:enable

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Registers a package with Composer without removing it.

```APIDOC
## packager:enable

### Description
Registers a package with Composer without removing it. This command adds the path repository and requires the package via Composer.

### Command
`php artisan packager:enable {vendor} {name}`

### Arguments
- **vendor** (string) - Required - Vendor name
- **name** (string) - Required - Package name

### Usage Example
`php artisan packager:enable my-vendor my-package`
```

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

### Download Package from GitHub

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Downloads a package from a specific GitHub repository archive.

```php
public function downloadFromGithub(string $origin, string $piece, string $branch): void
```

```php
$conveyor->downloadFromGithub('https://github.com/author/repo/archive/master.zip', 'repo', 'master');
```

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

### Define and apply replacements

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Wrapping.md

Use replace to set search/replacement pairs and fill to apply them recursively to a directory.

```php
$wrapping = new Wrapping();
$wrapping->replace(':author', 'John Doe')
    ->replace([':license', ':description'], ['MIT', 'My Package'])
    ->fill('/path/to/package');
```

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

### Configure default author homepage

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/configuration.md

Sets the default author website for new packages, which can be overridden interactively.

```php
'author_homepage' => 'https://example.com',
```

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

### Format vendor and package names

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Wrapping.md

Converts vendor and package strings into StudlyCase format. Returns an array containing the transformed vendor and package names.

```php
protected function formatVars(string $vendor, string $package): array
```

```php
$result = $wrapping->formatVars('my-vendor', 'my-package');
// Returns: ['MyVendor', 'MyPackage']
```

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

### packager:publish

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Pushes a package to a GitHub repository.

```APIDOC
## Command: packager:publish

### Description
Initializes git, commits files, adds a GitHub remote, and pushes the package to the master branch.

### Signature
`packager:publish {vendor} {name} {url}`

### Arguments
- **vendor** (string) - Required - Vendor name
- **name** (string) - Required - Package name
- **url** (string) - Required - GitHub repository URL

### Usage Example
`php artisan packager:publish my-vendor my-package https://github.com/my-vendor/my-package`
```

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

### Manage package tests

Source: https://github.com/jeroen-g/laravel-packager/blob/master/readme.md

Publishes package tests to the main application and configures the test suite.

```bash
php artisan packager:tests
```

```xml
<testsuite name="Packages">
    <directory suffix="Test.php">./tests/packages</directory>
</testsuite>
```

```bash
php artisan packager:tests my-vendor my-package
```

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

### Project Directory Structure

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/INDEX.md

Visual representation of the project's file organization and documentation layout.

```text
output/
├── INDEX.md                          (this file)
├── README.md                         (overview & patterns)
├── SYMBOLS.md                        (symbol catalog)
├── configuration.md                  (all config options)
├── types.md                          (types & validation)
├── errors.md                         (error catalog)
└── api-reference/
    ├── Conveyor.md                  (orchestration class)
    ├── FileHandler.md               (file operations)
    ├── Wrapping.md                  (configuration)
    ├── ArchiveExtractors.md         (archive handling)
    ├── Commands.md                  (10 Artisan commands)
    └── Utilities.md                 (traits & provider)
```

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

### Manage Packages

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/README.md

Perform maintenance tasks including listing, testing, security checks, publishing, and removal.

```bash
# List all packages
php artisan packager:list --git

# Move tests
php artisan packager:tests

# Security check (requires sensiolabs/security-checker)
php artisan packager:check acme widget

# Publish to GitHub
php artisan packager:publish acme widget https://github.com/acme/widget

# Remove package
php artisan packager:remove acme widget
```

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

### Handle Unsupported Archive Extension Exception

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/errors.md

Demonstrates catching an InvalidArgumentException when attempting to use an unsupported archive format.

```php
use JeroenG\Packager\ArchiveExtractors\Manager;

$manager = new Manager();
try {
    $extractor = $manager->getExtractor('rar'); // Unsupported format
} catch (InvalidArgumentException $e) {
    echo $e->getMessage(); // "There are no extractors for extension 'rar'!"
}
```

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

### packager:check

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Scans package dependencies for security vulnerabilities.

```APIDOC
## Command: packager:check

### Description
Analyzes the package's composer.lock file for security vulnerabilities using SensioLabs Security Checker.

### Signature
`packager:check {vendor} {name}`

### Arguments
- **vendor** (string) - Required - Vendor name
- **name** (string) - Required - Package name

### Usage Example
`php artisan packager:check my-vendor my-package`
```

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

### Convert Vendor Name to kebab-case

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Retrieves the vendor name formatted in kebab-case. Throws a RuntimeException if the vendor is not set.

```php
public function vendorKebab(): string
```

```php
$conveyor->vendor('MyVendor');
echo $conveyor->vendorKebab(); // outputs: my-vendor
```

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

### Apply replacements to a single file

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Wrapping.md

Use fillInFile to process a specific file and optionally save it to a new destination.

```php
$wrapping->replace(':version', '1.0.0')
    ->fillInFile('composer.json', 'composer.json.new');
```

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

### Download and Extract Archive

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/FileHandler.md

Downloads an archive from a URL and extracts it to a target directory using method chaining.

```php
$conveyor->download('/tmp/package.zip', 'https://github.com/user/repo/archive/master.zip')
    ->extract('/tmp/package.zip', '/target/dir');
```

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

### Convert Vendor Name to StudlyCase

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Retrieves the vendor name formatted in StudlyCase. Throws a RuntimeException if the vendor is not set.

```php
public function vendorStudly(): string
```

```php
$conveyor->vendor('my-vendor');
echo $conveyor->vendorStudly(); // outputs: MyVendor
```

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

### Configure default license

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/configuration.md

Sets the default license type for new packages, which can be overridden interactively.

```php
'license' => 'MIT',
```

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

### Check Package Security Signature

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

The command signature for scanning package dependencies for vulnerabilities.

```php
'packager:check {vendor} {name}'
```

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

### vendor

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Sets or retrieves the package vendor namespace.

```APIDOC
## public function vendor(?string $vendor = null): string

### Description
Set or get the package vendor namespace.

### Parameters
- **$vendor** (string) - Optional - The vendor namespace to set

### Returns
- (string) The vendor namespace

### Throws
- RuntimeException: If no vendor is set and getter is called
```

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

### Check package security

Source: https://github.com/jeroen-g/laravel-packager/blob/master/readme.md

Scans a package for security vulnerabilities using the SensioLabs security checker.

```bash
php artisan packager:check my-vendor my-package
```

```bash
composer require sensiolabs/security-checker
```

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

### Add service provider to config/app.php

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Wrapping.md

Registers a package service provider class in the config/app.php providers array.

```php
$wrapping->addToProviders('acme', 'widget');
// Adds: Acme\Widget\WidgetServiceProvider::class,
```

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

### Publish Package Signature

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

The command signature for pushing a package to a GitHub repository.

```php
'packager:publish {vendor} {name} {url}'
```

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

### fillInFile

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Wrapping.md

Applies replacements to a single file.

```APIDOC
## fillInFile($template, $destination)

### Description
Reads a file, performs all placeholder replacements, and writes the result to the destination.

### Parameters
- **$template** (string) - Required - File path containing placeholders
- **$destination** (string) - Optional - Save location (defaults to $template)

### Return
- **self** - Returns $this for method chaining
```

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

### Define GitPackage Signature

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

The command signature for cloning a package from a Git repository.

```php
'packager:git {url} {vendor?} {name?}'
```

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

### Handle missing package name RuntimeException

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/errors.md

Triggered when accessing packageStudly without setting a package name. Ensure the package is configured before calling the getter.

```php
$conveyor = new Conveyor();
try {
    $name = $conveyor->packageStudly(); // Throws RuntimeException
} catch (RuntimeException $e) {
    echo $e->getMessage(); // "Please provide a package name"
}
```

```php
$conveyor->package('my-package');
$name = $conveyor->packageStudly(); // Works
```

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

### Configure download timeout

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/configuration.md

Sets the maximum time in seconds for download operations. Increase this value if experiencing failures on slow connections.

```php
'timeout' => '60',
```

```php
// In config/packager.php
'timeout' => '120', // 2 minutes
```

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

### Dump Composer Autoloads

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Executes the composer dump-autoload command.

```php
public function dumpAutoloads(): void
```

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

### Retrieve Vendor Path

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/FileHandler.md

Returns the path for a specific vendor. Throws a RuntimeException if the vendor is not set.

```php
$conveyor->vendor('acme');
echo $conveyor->vendorPath(); // /app/packages/acme
```

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

### downloadFromGithub

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Downloads a package from a GitHub repository archive.

```APIDOC
## public function downloadFromGithub(string $origin, string $piece, string $branch): void

### Description
Download a package from a GitHub repository archive.

### Parameters
- **$origin** (string) - Required - GitHub archive URL
- **$piece** (string) - Required - Repository name component
- **$branch** (string) - Required - Branch name to download
```

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

### Generate Temporary Filename

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/FileHandler.md

Creates a unique filename with an md5 hash for package archives.

```php
$filename = $conveyor->makeFilename('tar.gz'); // package8a7f3c2e.tar.gz
```

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

### addToProviders

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Wrapping.md

Adds a package service provider to the config/app.php providers array.

```APIDOC
## addToProviders($vendor, $package)

### Description
Inserts a provider class reference in config/app.php under the "Package Service Providers" section.

### Parameters
- **$vendor** (string) - Required - Vendor name (kebab-case)
- **$package** (string) - Required - Package name (kebab-case)

### Return
- **self** - Returns $this for method chaining
```

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

### Require package as dev dependency

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Executes composer require vendor/package:@dev to add a development dependency. Returns true if the process exits with code 0.

```php
public function requirePackage(): bool
```

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

### Configure default author name

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/configuration.md

Sets the default author name for new packages, which can be overridden interactively.

```php
'author_name' => 'John Doe',
```

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

### Rename package files

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/FileHandler.md

Renames placeholder strings in package files based on vendor and package naming conventions.

```php
public function renameFiles(?array $manifest = null): void
```

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

### Disable cURL SSL Verification

Source: https://github.com/jeroen-g/laravel-packager/blob/master/readme.md

Add this setting to your .env file to bypass SSL certificate verification if downloads fail due to missing OS certificates.

```text
CURL_VERIFY=false
```

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

### Composer Package Info Structure

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/types.md

The expected array structure for decoded composer.json data used by the ListPackages command.

```php
[
    'name' => 'jeroen-g/laravel-packager',
    'description' => 'A cli tool for creating Laravel packages.',
    'keywords' => ['Packager', 'Laravel', 'package', 'skeleton'],
    'homepage' => 'https://github.com/Jeroen-G/laravel-packager',
    'license' => 'EUPL-1.1',
    'authors' => [
        [
            'name' => 'JeroenG',
            'email' => 'jeroengjeroeng@gmail.com',
            'homepage' => 'https://github.com/Jeroen-G'
        ]
    ],
    'require' => [
        'php' => '^7.1|^8.0',
        'ext-zip' => '*',
        'ext-json' => '*',
        'illuminate/support' => '^5.0|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0|^12.0|^13.0',
        'guzzlehttp/guzzle' => '~7'
    ],
    'require-dev' => [
        'phpunit/phpunit' => '^8.0|^9.0|^10.5|^11.5.3',
        'orchestra/testbench' => '>=3.8'
    ],
    'autoload' => [
        'psr-4' => [
            'JeroenG\\Packager\\' => 'src'
        ]
    ],
    'autoload-dev' => [
        'psr-4' => [
            'JeroenG\\Packager\\Tests\\' => 'tests'
        ]
    ]
]
```

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

### Add package to composer.json

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Wrapping.md

Automatically adds a PSR-4 autoload entry to composer.json using StudlyCase for the namespace.

```php
$wrapping->addToComposer('my-vendor', 'my-package');
// Adds to composer.json: "MyVendor\\MyPackage\\": "packages/my-vendor/my-package/src"
```

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

### Wrapping Class Methods

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/SYMBOLS.md

Methods for applying string replacements and modifying composer.json or service providers.

```APIDOC
## Wrapping Class

### Properties
- **$placeholders** (array): Strings to search for.
- **$replacements** (array): Replacement values.

### Methods
- **replace($placeholder, $replacement)**: Adds a search/replace pair. Returns self (chainable).
- **fill(string $path)**: Applies replacements to a directory.
- **fillInFile(string $template, ?string $destination)**: Applies replacements to a single file. Returns self (chainable).
- **addToComposer(string $vendor, string $package)**: Adds PSR-4 autoload. Returns self (chainable).
- **removeFromComposer(string $vendor, string $package)**: Removes PSR-4 autoload. Returns self (chainable).
- **addToProviders(string $vendor, string $package)**: Adds a service provider. Returns self (chainable).
- **removeFromProviders(string $vendor, string $package)**: Removes a service provider. Returns self (chainable).
```

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

### Handle missing vendor RuntimeException

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/errors.md

Triggered when accessing vendorPath without setting a vendor. Ensure the vendor is configured before calling the getter.

```php
$conveyor = new Conveyor();
try {
    $path = $conveyor->vendorPath(); // Throws RuntimeException
} catch (RuntimeException $e) {
    echo $e->getMessage(); // "Please provide a vendor"
}
```

```php
$conveyor->vendor('my-vendor');
$path = $conveyor->vendorPath(); // Works
```

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

### Move Package Tests Signature

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

The command signature for moving package tests to the main Laravel directory.

```php
'packager:tests {vendor?} {name?}'
```

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

### Uninstall Package

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Uninstalls the package by removing it and its associated repository.

```php
public function uninstallPackage(): void
```

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

### Conditionally Register Service Provider in AppServiceProvider

Source: https://github.com/jeroen-g/laravel-packager/blob/master/readme.md

Use this logic in your AppServiceProvider to register the package only in local environments when auto-discovery is disabled.

```php
if ($this->app->environment('local')) {
    $this->app->register('JeroenG\Packager\PackagerServiceProvider');
}
```

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

### Conveyor Class Methods

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/SYMBOLS.md

Methods for managing package metadata, skeleton downloads, and composer operations.

```APIDOC
## Conveyor Class

### Methods
- **vendor(?string $vendor)**: Get or set the vendor name. Throws RuntimeException if not set.
- **vendorStudly()**: Returns the vendor name in StudlyCase.
- **vendorKebab()**: Returns the vendor name in kebab-case.
- **package(?string $package)**: Get or set the package name. Throws RuntimeException if not set.
- **packageStudly()**: Returns the package name in StudlyCase.
- **packageKebab()**: Returns the package name in kebab-case.
- **downloadSkeleton(?string $skeletonArchiveUrl)**: Downloads and extracts the package skeleton.
- **downloadFromGithub(string $origin, string $piece, string $branch)**: Downloads a package from a GitHub archive.
- **dumpAutoloads()**: Executes composer dump-autoload.
- **installPackage()**: Adds the path repository and requires the package.
- **uninstallPackage()**: Removes the package and its path repository.
- **addPathRepository()**: Adds a local path repository. Returns bool.
- **removePathRepository()**: Removes a local path repository. Returns bool.
- **requirePackage()**: Requires the package as @dev. Returns bool.
- **removePackage()**: Removes the package requirement. Returns bool.
```

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

### ProgressBar::makeProgress

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Utilities.md

Advances the progress bar by one step.

```APIDOC
## public function makeProgress(): void

### Description
Advances the progress bar by one step.
```

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

### packager:git

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Clones a package from a Git repository while preserving the git history.

```APIDOC
## packager:git

### Description
Clone a package from a Git repository (preserves git history).

### Signature
`packager:git {url} {vendor?} {name?}`

### Arguments
- **url** (string) - Required - Git repository URL (HTTPS or SSH)
- **vendor** (string) - Optional - Vendor name
- **name** (string) - Optional - Package name

### Usage Examples
```bash
# HTTPS URL
php artisan packager:git https://github.com/author/repository

# SSH URL
php artisan packager:git git@github.com:author/repository.git

# Custom vendor/package
php artisan packager:git https://github.com/author/repository my-vendor my-package
```
```

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

### packager:remove

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Deletes an existing package directory and uninstalls it from Composer.

```APIDOC
## Command: packager:remove

### Description
Delete an existing package directory and uninstall from Composer.

### Signature
`php artisan packager:remove {vendor} {name?}`

### Arguments
- **vendor** (string) - Required - Vendor name (can use slash: vendor/name)
- **name** (string) - Optional - Package name

### Usage Examples
`php artisan packager:remove my-vendor my-package`
`php artisan packager:remove my-vendor/my-package`
```

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

### Extract TAR.GZ archives

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/ArchiveExtractors.md

Implementation of the extract method for compressed TAR.GZ files.

```php
public function extract(string $pathToArchive, string $pathToDirectory): void
```

```php
$targz = new TarGz();
$targz->extract('skeleton.tar.gz', './packages/vendor');
```

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

### cleanUpRules

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/FileHandler.md

Removes temporary rule files used during the placeholder rewriting process.

```APIDOC
## cleanUpRules

### Description
Deletes `rules.php` and `rewriteRules.php` files if they exist in the package directory.

### Signature
`public function cleanUpRules(): void`
```

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

### Register Service Provider for Laravel versions below 5.5

Source: https://github.com/jeroen-g/laravel-packager/blob/master/readme.md

Add this class to the providers array in your config/app.php file if you are not using auto-discovery.

```php
JeroenG\Packager\PackagerServiceProvider::class,
```

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

### Configure SSL certificate verification

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/configuration.md

Controls SSL verification for Guzzle downloads. Disabling is less secure and recommended only for development environments.

```php
'curl_verify_cert' => env('CURL_VERIFY', true),
```

```bash
# In .env
CURL_VERIFY=false
```

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

### ProgressBar::finishProgress

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Utilities.md

Completes the progress bar and displays a final message.

```APIDOC
## public function finishProgress(string $message): void

### Description
Completes the progress bar, displays a message, adds two new lines, and clears the internal bar reference.

### Parameters
- **$message** (string) - Required - Message to display after completion
```

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

### RemovePackage Command Signature

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

The command signature for removing a package.

```php
'packager:remove {vendor} {name?}'
```

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

### requirePackage

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Adds the package as a development dependency to the project using composer require.

```APIDOC
## requirePackage

### Description
Require the package as a dev dependency via Composer.

### Signature
`public function requirePackage(): bool`

### Returns
- **bool** - True if the process exited with code 0.

### Behavior
Runs `composer require vendor/package:@dev`.
```

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

### addToComposer

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Wrapping.md

Adds a package autoload entry to composer.json.

```APIDOC
## addToComposer($vendor, $package)

### Description
Adds a PSR-4 autoload entry to composer.json. Automatically converts vendor/package names to StudlyCase for the namespace.

### Parameters
- **$vendor** (string) - Required - Vendor name (kebab-case)
- **$package** (string) - Required - Package name (kebab-case)

### Return
- **self** - Returns $this for method chaining
```

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

### packager:tests

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

Copies test files from packages to the main Laravel tests directory.

```APIDOC
## Command: packager:tests

### Description
Copies test files from packages to the main Laravel tests directory, respecting Laravel's testing conventions.

### Signature
`packager:tests {vendor?} {name?}`

### Arguments
- **vendor** (string) - Optional - Vendor name
- **name** (string) - Optional - Package name

### Usage Example
`php artisan packager:tests my-vendor my-package`
```

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

### Add Path Repository

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Conveyor.md

Adds a local path repository to composer.json with symlink support enabled.

```php
public function addPathRepository(): bool
```

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

### Register the Packager Service Provider

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/README.md

Add this class to your Laravel application's service provider configuration to enable the package functionality.

```php
JeroenG\Packager\PackagerServiceProvider::class
```

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

### renameFiles

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/FileHandler.md

Renames generic placeholder files within a package to match the specific vendor and package names.

```APIDOC
## renameFiles

### Description
Recursively iterates through package files and replaces placeholder strings (MyVendor, MyPackage, myvendor, mypackage) with the actual vendor and package names.

### Signature
`public function renameFiles(?array $manifest = null): void`

### Parameters
- **$manifest** (array) - Optional - Rewrite rules file path (unused).
```

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

### Register Packager in AppServiceProvider

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/configuration.md

Use this conditional registration to ensure the package is only loaded in the local environment, preventing it from running in production.

```php
// In AppServiceProvider or another provider

public function register()
{
    if ($this->app->environment('local')) {
        $this->app->register('JeroenG\Packager\PackagerServiceProvider');
    }
}
```

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

### Register a custom extractor

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/ArchiveExtractors.md

Adds a new extractor instance to the Manager for a specific file extension.

```php
public function addExtractor(string $archiveExtension, Extractor $instance): self
```

```php
$manager = new Manager();
$manager->addExtractor('rar', new CustomRarExtractor());
```

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

### Finish Progress Bar

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Utilities.md

Completes the progress bar and displays a final message to the console.

```php
$this->finishProgress('Package created successfully!');
```

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

### Extractor Abstract Class

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/types.md

The base class for all archive extraction implementations.

```php
abstract class JeroenG\Packager\ArchiveExtractors\Extractor
{
    abstract public function extract(string $pathToArchive, string $pathToDirectory): void;
}
```

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

### Disable Package Signature

Source: https://github.com/jeroen-g/laravel-packager/blob/master/_autodocs/api-reference/Commands.md

The command signature for disabling a package.

```php
'packager:disable {vendor} {name}'
```
Tokens:
Raw