composer.json中的腳本部分是什麼？

composer.json中的"scripts"部分用於定義可使用Composer觸發的自定義命令，以簡化PHP項目中重複性任務的自動化。常見用例包括運行PHPUnit測試（"test": "phpunit"）、用PHPStan分析代碼（"analyze": "phpstan analyze"）、在Laravel中清除緩存（"clear-cache": "php artisan config:clear && php artisan cache:clear"）以及啟動開發服務器（"start": "php -S localhost:8000"）。要定義腳本，需在"scripts"下添加鍵值對，並通過composer run-script或簡寫形式composer run執行，同時支持傳遞參數。 Composer還支持內置事件如"pre-install-cmd"、"post-install-cmd"等，可在特定生命週期自動觸發操作。編寫良好腳本的建議包括保持簡短有意義、使用跨平台命令、組合多個命令、命名清晰並考慮添加註釋說明復雜邏輯。

The "scripts" section in a composer.json file is where you define custom commands that can be triggered using Composer. These commands are often used to automate tasks related to your PHP project — like running tests, clearing caches, or starting development servers — without having to remember long command lines.

Common Use Cases for the Scripts Section

Developers use the scripts section to simplify repetitive tasks and integrate with other tools. Here are some typical examples:

• Running PHPUnit tests: "test": "phpunit"
• Linting code with PHPStan: "analyze": "phpstan analyze"
• Clearing cache in a framework like Laravel: "clear-cache": "php artisan config:clear && php artisan cache:clear"
• Starting a local development server: "start": "php -S localhost:8000"

By defining these in composer.json , anyone working on the project can run them consistently, regardless of their environment.

How to Define and Run Scripts

Defining a script is straightforward. You add a key-value pair under the "scripts" section. The key is the name of the command, and the value is what gets executed.

For example:

 "scripts": {
    "test": "phpunit",
    "start": "php -S localhost:8000"
}

To run a script, you use the Composer CLI like this:

 composer run-script test

Or use the shorthand:

 composer run test

You can also pass arguments to your scripts if needed:

 "scripts": {
    "serve": "php -S localhost:$PORT"
}

Then run it with:

 composer run serve -- --PORT=8080

Built-in Script Events

Composer also supports built-in events that automatically trigger during certain lifecycle moments, such as:

• "pre-install-cmd" / "post-install-cmd"
• "pre-update-cmd" / "post-update-cmd"
• "post-autoload-dump"

These are useful for doing things like regenerating autoload files, notifying after an install/update, or setting up environment files before dependencies are installed.

For example:

 "scripts": {
    "post-install-cmd": [
        "echo 'Project installed successfully!'"
    ],
    "post-update-cmd": [
        "php think migrate" 
    ]
}

These commands will run automatically after composer install or composer update .

Tips for Writing Good Scripts

Here are a few practical tips when working with scripts:

• Keep them short and meaningful.
• Use cross-platform commands if possible (especially if your team uses different OSes).
• Chain multiple commands together when needed:

   "clear-all": "php artisan config:clear && php artisan route:clear"

• Use descriptive names so others know what they do without guessing.
• Consider adding documentation in comments inside composer.json if a script is complex.

基本上就這些。

以上是composer.json中的腳本部分是什麼？的詳細內容。更多資訊請關注PHP中文網其他相關文章！