View on Github Git Repository

Scripts - 스크립트

스크립트(script)란?

컴포저에서 이야기 하는 스크립트(script)는 PHP의 콜백(정적 메서드로도 정의할 수 있는) 혹은 커맨드 라인 환경에서 실행가능한 명령어를 이야기 합니다. 스크립트는 사용자가 만든 패키지의 맞춤형 코드 혹은 컴포저 실행 과정 중간에 발생하는 특정 명령어를 실행하는데 굉장히 유용합니다.

참고: 스크립트는 루트 패키지의 composer.json에서만 실행가능합니다. 만약 루트 패키지의 의존성 패키지에 스크립트가 정의되어 있다면, 컴포저는 해당 스크립트를 실행하지 않습니다.

사용가능한 이벤트들

컴포저는 실행과정 중에 다음 정의된 이벤트들을 실행합니다:

  • pre-install-cmd: install 커맨드가 실행되기 전에 발생합니다.
  • post-install-cmd: install 커맨드가 실행된 후에 발생합니다.
  • pre-update-cmd: update 커맨드가 실행되기 전에 발생합니다.
  • post-update-cmd: update 커맨드가 실행 된 후에 발생합니다.
  • pre-status-cmd: status 커맨드가 실행되기 전에 발생합니다.
  • post-status-cmd: status 커맨드 실행 된 후에 발생합니다.
  • pre-dependencies-solving: 의존성이 해결되기 전에 발생합니다.
  • post-dependencies-solving: 의존성이 해결 된 후에 발생합니다.
  • pre-package-install: 패키지가 인스톨 되기 전에 발생합니다.
  • post-package-install: 패키지가 인스톨 된 후에 발생합니다.
  • pre-package-update: 패키지가 업데이트 되기 전에 발생합니다.
  • post-package-update: 패키지가 업데이트 된 후에 발생합니다.
  • pre-package-uninstall: 패키지가 삭제(uninstall) 되기 전에 발생합니다.
  • post-package-uninstall: 패키지가 삭제(uninstall) 된 후에 발생합니다.
  • pre-autoload-dump: 오토로더가 덤프되기 전에 발생합니다. 이는 install/update 즉 dump-autoload를 사용하는 커맨드를 의미합니다.
  • post-autoload-dump: 오토로더가 덤프된 후에 발생합니다. 이는 install/update 즉 dump-autoload를 사용하는 커맨드를 의미합니다.
  • post-root-package-install: create-project 커맨드가 되는 동안, 루트 패키지가 인스톨 되고 난 후에 발생합니다.
  • post-create-project-cmd: create-project 커맨드가 실행 된 후에 발생합니다.
  • pre-archive-cmd: archive 커맨드가 실행되기 전에 발생합니다.
  • post-archive-cmd: archive 커맨드가 실행된 후에 발생합니다.

주의: 컴포저는 의존하고 있는 패키지들이 install, update 전에 하는 상태에 대해서 어떠한 가정도 할 수 없습니다. 그래서 pre-update-cmd 혹은, pre-install-cmd 이벤트 훅(hook) 안에 어떤 의존성 패키지들을 필요로 하는 지에 대해 스크립트를 작성하지 않아도 됩니다. 만약 당신이 intall, update이전에 스크립트를 실행해야 한다면 당신의 루트 패키지 안에 있는 그들 각 패키지 내부에 있는지 확인하십시오.

스크립트 정의하기

composer.json에 "scripts"라는 속성을 가질 수 있습니다. 이는 이벤트와 그 이벤트에 대응하는 스크립트의 쌍(pair)을 포함하고 있습니다. 이벤트의 스크립트는 문자열(하나의 스크립트를 위한) 또는 배열(하나 혹은 여러개의 스크립트를 위한)의 두가지 형태로 정의가능합니다.

주어진 이벤트에 대해서:

  • 스크립트 이벤트가 발생할 때 정의된 순서대로 실행됩니다.
  • 스크립트를 배열로 사용할 때, PHP 콜백과 CLI환경에서 실행가능한 커맨드 둘다 동시에 포함할 수 있습니다.
  • 콜백을 포함한 PHP클래스는 반드시 컴포저에서 오토로드 할 수 있어야합니다.

스크립트 정의 예제:

{
    "scripts": {
        "post-update-cmd": "MyVendor\\MyClass::postUpdate",
        "post-package-install": [
            "MyVendor\\MyClass::postPackageInstall"
        ],
        "post-install-cmd": [
            "MyVendor\\MyClass::warmCache",
            "phpunit -c app/"
        ],
        "post-create-project-cmd" : [
            "php -r \"copy('config/local-example.php', 'config/local.php');\""
        ]
    }
}

위의 예제에서 사용한 MyVendor\MyClass라는 클래스는 다음의 PHP를 실행할 것입니다:

<?php

namespace MyVendor;

use Composer\Script\Event;

class MyClass
{
    public static function postUpdate(Event $event)
    {
        $composer = $event->getComposer();
        // do stuff
    }

    public static function postPackageInstall(Event $event)
    {
        $installedPackage = $event->getOperation()->getPackage();
        // do stuff
    }

    public static function warmCache(Event $event)
    {
        // make cache toasty
    }
}

이벤트가 발생 했을 때, 컴포저의 내부 이벤트 핸들러는 Composer\Script\Event 객체를 받습니다. 그리고 이 객체는 PHP 콜백의 첫번째 매개변수로 사용가능합니다. 이 Event 다음 접근자를 통해 다른 객체에 접근할 수 있습니다:

  • getComposer(): 현재 Composer\Composer 객체를 반환합니다.
  • getName(): 발생한 이벤트의 이름을 문자열로 반환합니다.
  • getIO(): returns the current input/output stream which implements 콘솔에 쓸 수 있는 Composer\IO\IOInterface 인터페이스를 구현한 현재의 인, 아웃풋 스트림을 반환합니다.

스크립트 직접 실행

스크립트를 직접 실행하고 싶다면 다음의 명령어를 이용하면 됩니다:

composer run-script [--dev] [--no-dev] script

예를들어 composer run-script post-install-cmd은 post-install-cmd에 정의된 스크립트들을 실행할 것입니다.

또 --를 추가하여 매개변수들을 추가할 수 있습니다. 예를 들어, composer run-script post-install-cmd -- --check는 --check를 스크립트 핸들러로 보냅니다. 이러한 매개변수는 CLI 매개변수로서 사용할 수 있고, PHP 핸들러에서 $event->getArguments()를 통해 배열로서 불러올 수 있습니다.

사용자 정의 커맨드

위에 명시된 사용할 수 있는 이벤트 중에 원하는 것이 없다면 사용자 정의 스크립트를 추가할 수 있습니다. 그리고 이는 run-script를 통해서 사용가능하고, 컴포저의 자연스러운 커맨드 처럼 사용할 수 있습니다. 예를 들어 아래와 같이 단순한 내용을 정의하였다면 composer test라는 명령어를 통해 사용가능합니다:

{
    "scripts": {
        "test": "phpunit"
    }
}

참고: 컴포저의 bin-dir은 PATH의 최상위를 입력할 수 있는데, 이는 의존하고 있는 패키지들의 실행파일들을 쉽게 CLI 커맨드로서 입력할 수 있게 합니다. 예를들어 PHPUnit을 의존하고 있고, bin-dir을 scripts라는 값으로 설정을 해놓았다면 스크립트에서 scripts/phpunit라는 값을 통해 접근이 가능합니다.