Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/voronkovich/symfony.plugin.zsh

Zsh plugin for Symfony
https://github.com/voronkovich/symfony.plugin.zsh

symfony zsh-plugin

Last synced: about 1 month ago
JSON representation

Zsh plugin for Symfony

Lists

README 

        
# symfony.plugin.zsh



[![Tests](https://github.com/voronkovich/symfony.plugin.zsh/actions/workflows/tests.yaml/badge.svg)](https://github.com/voronkovich/symfony.plugin.zsh/actions/workflows/tests.yaml)



A zsh plugin for the [Symfony](https://symfony.com/) PHP framework.



## Features



* Usefull commands and shortcuts;

* Symfony's [commands](https://symfony.com/doc/current/console.html) and options autocompletion;

* Autocompletion for [Symfony CLI](https://symfony.com/download);

* [Docker](https://docker.com/) and [DDEV](https://ddev.com/) support;

* Works with [Laravel](#laravel) or any other similar PHP framework.



## Installation



If you need an autocompletion, please, install [symfony-complete.plugin.zsh](https://github.com/voronkovich/symfony-complete.plugin.zsh) first.



### [Antigen](https://github.com/zsh-users/antigen)



```sh

antigen bundle voronkovich/symfony.plugin.zsh

```

### [Zplug](https://github.com/zplug/zplug)



```sh

zplug "voronkovich/symfony.plugin.zsh"

```



### [Oh My Zsh](https://github.com/ohmyzsh/ohmyzsh)



```sh

git clone https://github.com/voronkovich/symfony.plugin.zsh ~/.oh-my-zsh/custom/plugins/symfony

```



Edit `.zshrc` to enable the plugin:



```sh

plugins=(... symfony)

```



### Manual



Clone this repo and add this into your `.zshrc`:



```sh

source path/to/cloned/repo/symfony.plugin.zsh

```



## Usage



This plugin provides some usefull commands and shortcuts:



* `sf` is used for running Symfony's [console commands](https://symfony.com/doc/current/console.html) e.g. `sf debug:router`, `sf c:c` and etc. But it also has some special subcommands:

  - `serve` runs a development web server. Depending on configuration it will use `docker compose up`,  `symfony serve`, `ddev start` or `php -S`

  - `status` shows status (web server, containers and etc.);

  - `stop` stops a development web server;

  - `run` runs a program with environment depending on the current context (current machine, `symfony run`, `ddev`, `docker` and etc.);

  - `php` runs a PHP (version depends on project's configuration);

  - `composer` runs a [Composer](https://getcomposer.org/);

  - `phpunit` runs a [PHPUnit](https://phpunit.de/);

  - `phive` runs a [PHIVE](https://phar.io/);

  - `psql` runs a [psql](https://www.postgresql.org/docs/current/app-psql.html) PostgreSQL client;

  - `open` opens a local project in a browser;

  - `mails` opens a local project mail catcher web interface in a browser;

* `sfnew` creates new Symfony project. It's just a shortcut for `symfony new`;

* `sfservice` shows a service definition. It has an autocompletion for services ids;

* `sfroute` shows a route definition. It has autocompletion for routes names;

* `sfconfig` shows a container extensions configuration. It has autocompletion for extensions names;



## Containers support (Docker/DDEV and etc.)



If you run your app inside a [Docker](https://www.docker.com/) container, you'll probably need to configure a "runner": a command that executes another commands. You can do it by setting a special `SF_RUNNER` environment variable. Just place it in your `.zshrc` or in a local `.env` or `.env.local` files inside of your project's root:



```sh

# "symfony" is a service name in a `docker-compose.yml`

SF_RUNNER="docker-compose exec symfony --"

```



But, if you use a [DDEV](https://ddev.com/) or a [dunglas/symfony-docker](https://github.com/dunglas/symfony-docker) you don't need to configure anything. All works out of the box.



## Configuration



The `sf` command can be configured via following environment variables:



- `SF_CONSOLE`: sets the console binary



   **Allowed values**: any valid path to binary file



   **Default:** "bin/console"



   ```sh

   # Yes, you can use this plugin with the Laravel too

   export SF_CONSOLE="artisan"

   ```



- `SF_RUNNER`: sets command runner



   **Allowed values**: any valid command



   **Default:** configured automatically



   ```sh

   export SF_RUNNER="docker-compose exec -- laravel.test"

   ```



- `SF_DDEV`: enables/disables DDEV autodetection.



   **Allowed values:** "on", "off"



   **Default:** "on"



   When enabled `sf` will check project's folder for existence of `.ddev` directory and configure runner to use `ddev exec`



   ```sh

   # Disable DDEV detection

   export SF_DDEV=off

   ```



- `SF_DOCKER` enbales/disables Docker autodetection



   **Allowed values:** "on", "off"



   **Default:** "on"



   When enabled `sf` will try to detect a proper runner from a `docker-compose.yml` or `docker-compose.yaml` files. If the file exists, `sf` will try to find common service names: `php` and `app` and automatically configure runner e.g. `docker compose exec php --`



   ```sh

   # Disable Docker detection

   export SF_DOCKER=off

   ```



- `SF_SYMFONY_CLI` enbales/disables [Symfony CLI](https://symfony.com/download) usage 



   **Allowed values:** "on", "off"



   **Default:** "on"



   When enabled `sf` will try to detect if [Symfony CLI](https://symfony.com/download) installed and use it as the runner instead of local `php`



   ```sh

   # Disable Symfony CLI

   export SF_SYMFONY_CLI=off

   ```



- `SF_LOCAL` enbales/disables local runner



   **Allowed values:** "on", "off"



   **Default:** "on"



   When enabled `sf` will use a default system php installation as a fallback



   ```sh

   # Disable local

   export SF_LOCAL=off

   ```



You can put the configuration in your global `.zshrc` file or in a local `.env` or `.env.local` files inside of your project's root.



## Laravel



BTW, you can use this plugin with the [Laravel](https://laravel.com/) :). To do this, just create a wrapper function in your `.zshrc` with configuration like this (in this example I use [Sail](https://laravel.com/docs/9.x/sail)):



```zsh

artisan() {

    SF_CONSOLE='artisan' SF_RUNNER='docker-compose exec -- laravel.test' sf "$@"

}



compdef _sf artisan

```



## ASCII movie



[![asciicast](https://asciinema.org/a/03shcf05p1wz0ppg2dambztig.png)](https://asciinema.org/a/03shcf05p1wz0ppg2dambztig)



## License



Copyright (c) Voronkovich Oleg. Distributed under the MIT.