Composer synchronizer: automatická synchronizace souborů při instalaci & odinstalaci balíčku

Poměrně nedávno vydalo Symfony balíček symfony/flex. Ikdyž to „neumí nic extra“, tak to přeci jen rozmazlí tím, že programátor nemusí soubory kopírovat a vytvářet ručně. Jelikož pracuji v Nette a pro něj nic takového není (nebo o tom alespoň nevím), rozhodl jsem se něco obdobného vytvořit.

• Balíček: composer-synchronizer/composer-synchronizer
• Dokumentace: https://github.com/…/master/docs
• Příklady konfigurace balíčků: https://github.com/…zer/examples

Jak to funguje

• Řekněme, že si budeme chtít nainstalovat Doctrinu a využijeme k tomu balíčky nettrine/orm, nettrine/migrations a contributte/console.
• U každého balíčku bychom museli vytvářet konfigurační soubor, vytvořit základní nastavení, includovat ho do Nette, přidat binárku pro konzoli atd.
• Pokud by ale v projektu byl přidán composer-synchronizer/composer-synchronizer, tak se při instalaci zkontroluje, zda-li má balíček konfiguraci pro kopírování a vytváření souborů buď přímo u sebe nebo v repozitáři na Githubu. Pakliže konfigurace existuje, tak se popřípadě stáhne a soubory se automaticky nakopírují do příslušných adresářů.
• Programátor už pak jen případně konfiguraci upraví a přidá soubor composer-synchronizer.neon vytvořený synchronizerem ve složce app/config do souboru bootstrap.php.
• Všechno kopírování binárek a konfiguráků tímto odpadá.

Co musím udělat, aby se mi balíčky v projektu synchronizovaly?

• Mít nainstalovaný synchronizer
• Mít přidanou sekci v konfiguráku se zvoleným typem projektu (poslední verze nette2 má alias nette)
• Instalovat balíčky, který obsahují konfiguraci pro zvolený typ projektu a instalovanou verzi balíčku (vždy dvoumístná)

{
  "extra": {
    "composer-synchronizer": {
      "project-type": "nette"
    }
  }
}

Co musím udělat, aby se balíček synchronizoval?

• Přidat do composer.json souboru konfiguraci s informacemi, co a kam se má kopírovat nebo přidat, pro daný typ projektu.
• Konfiguraci pro balíčky, které nejsou vaše, je možné umístit do repozitáře na Githubu, odkud se bude stahovat (počet stažení konfigurace z Githubu je omezen na IP adresu podle Github Rate Limit).

{
    "name": "some/package",
    "extra": {
        "composer-synchronizer": {
            "nette2": {
                "resources": {
                    "extension.neon": "%configDir%/somePackage/",
					"webtemp/": "%wwwDir%/webtemp/"
                },
                "gitignore": [
                    "%wwwDir%/webtemp/"
                ],
                "includes": [
                    "somePackage/extension.neon"
                ]
            }
        }
    }
}

Co to zatím umí…

• Kopírovat soubory i celé adresáře.
• Přidávat a odebírat parametry z hlavního .gitignore v adresáři projektu.
• Přidávat a odebírat cesty ke konfiguračním souborům v soboru app/config/composer-synchronizer.neon.
• Pokud používáte Nette s upravenou adresářovou strukturou, je možné přepsat placeholdery pro cesty a soubory se následně nakopírují správně.

TODO

• Přemýšlím, jestli při odinstalaci balíčku odebírat nakopírované soubory? Zatím se jen čistí gitignore a odebírají odinstalované závislosti z composer-synchronizer.neon.
• Hodilo by se vám po instalaci balíčku spouštět příkazy jako chmod či exec?

Budu rád za jakoukoliv připomínku i nápad!