Symfony 4 Composer scripts

Question

I've just installed Symfony 4 project and found this section in composer.json:

"scripts": {
    "auto-scripts": {
        "cache:clear": "symfony-cmd",
        "assets:install %PUBLIC_DIR%": "symfony-cmd"
    },
    "post-install-cmd": [
        "@auto-scripts"
    ],
    "post-update-cmd": [
        "@auto-scripts"
    ],
...

I've found that section auto-scripts is handled somehow differently by the Composer: key is a command to bin/console and value is a command "type" (In this case it's Symfony's). As it is not documented on Composer website, I assume it's not legal definition, but it works, and my question is how the Composer knows how to execute such commands? How Composer knows what is symfony-cmd?

It is part of the Symfony Flex composer plugin so it is legal. I have never tracked down exactly where it is defined but probably somewhere in here. It is the same code that lets you do thing like "composer require server" and other magic. — Cerad
– Cerad, Commented Jun 5, 2018 at 15:15

Jaroslav Týc · Accepted Answer · 2020-12-16 10:28:07Z

15

It's as Cerad says. auto-script is parsed by Symfony/Flex and the "right side" of a command:executable pair is processed by this switch-case.

switch ($type) {
    case 'symfony-cmd':
        return $this->expandSymfonyCmd($cmd);
    case 'php-script':
        return $this->expandPhpScript($cmd);
    case 'script':
        return $cmd;

Therefore Composer documentation can not say a word about that as it is Symfony-specific.

Personally don't like the mixing of standard Composer sections with custom ones on the composer.json root level. It simply confuses me and draws me into silent Composer documentation. Also the naming itself, auto-script, should be better. Something less magic and more self-explanatory, like flex-script.

answered Dec 16, 2020 at 10:28

Jaroslav Týc

1611 silver badge4 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Omar Alves · Accepted Answer · 2018-06-05 15:14:46Z

0

I guess it uses extra configuration located in composer.json

"extra": {
    "symfony-app-dir": "app",
    "symfony-web-dir": "web",
    "symfony-var-dir": "var",
    "symfony-bin-dir": "bin",
    "symfony-tests-dir": "tests",

    ...
},

Few days ago when I was migrating an application from 2.8 to 3.4, I had some trouble with these definitions.

I also had to clear composer's cache.

answered Jun 5, 2018 at 15:14

Omar Alves

7635 silver badges13 bronze badges

1 Comment

Cerad Over a year ago

Good guess but nope.

Collectives™ on Stack Overflow

Symfony 4 Composer scripts

2 Answers 2

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related