feat: allow to override the path to the Symfony Console

tucksaun · tucksaun · commit a2d78505e178 · 2025-03-17T20:10:57.000+01:00
When running `symfony console` we are currently looking for a `bin/console` or a `app/console` file to run.
What if the user renamed the file? or if they have a non "stantard" project structure?

This PR intends to introduce a way one can override the path to the console by defining `SYMFONY_CONSOLE_PATH` environment variable.
diff --git a/commands/completion_posix.go b/commands/completion_posix.go
@@ -50,7 +50,7 @@ func autocompleteSymfonyConsoleWrapper(context *console.Context, words complete.
 	// Composer does not support those options yet, so we only use them for Symfony Console
 	args = append(args, "-a1", fmt.Sprintf("-s%s", console.GuessShell()))
 
-	if executor, err := php.SymfonyConsoleExecutor(args); err == nil {
+	if executor, err := php.SymfonyConsoleExecutor(terminal.Logger, args); err == nil {
 		os.Exit(executor.Execute(false))
 	}
 
diff --git a/local/php/symfony.go b/local/php/symfony.go
@@ -24,22 +24,31 @@ import (
 	"path/filepath"
 
 	"github.com/pkg/errors"
+	"github.com/rs/zerolog"
+	"github.com/symfony-cli/symfony-cli/envs"
 )
 
 // SymfonyConsoleExecutor returns an Executor prepared to run Symfony Console.
 // It returns an error if no console binary is found.
-func SymfonyConsoleExecutor(args []string) (*Executor, error) {
+func SymfonyConsoleExecutor(logger zerolog.Logger, args []string) (*Executor, error) {
 	dir, err := os.Getwd()
 	if err != nil {
 		return nil, errors.WithStack(err)
 	}
 
 	for {
-		for _, consolePath := range []string{"bin/console", "app/console"} {
+		consolePaths := []string{"bin/console", "app/console"}
+		if consolePath, isConsolePathSpecified := envs.LookupEnv(dir, "SYMFONY_CONSOLE_PATH"); isConsolePathSpecified {
+			consolePaths = []string{consolePath}
+		}
+
+		for _, consolePath := range consolePaths {
+			logger.Debug().Str("consolePath", consolePath).Str("directory", dir).Msgf("Looking for Symfony console")
 			consolePath = filepath.Join(dir, consolePath)
 			if _, err := os.Stat(consolePath); err == nil {
 				return &Executor{
 					BinName: "php",
+					Logger:  logger,
 					Args:    append([]string{"php", consolePath}, args...),
 				}, nil
 			}
diff --git a/main.go b/main.go
@@ -74,8 +74,7 @@ func main() {
 	}
 	// called via "symfony console"?
 	if len(args) >= 2 && args[1] == "console" {
-		if executor, err := php.SymfonyConsoleExecutor(args[2:]); err == nil {
-			executor.Logger = terminal.Logger
+		if executor, err := php.SymfonyConsoleExecutor(terminal.Logger, args[2:]); err == nil {
 			executor.ExtraEnv = getCliExtraEnv()
 			os.Exit(executor.Execute(false))
 		}

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ func autocompleteSymfonyConsoleWrapper(context *console.Context, words complete.`
`50`	`50`	`// Composer does not support those options yet, so we only use them for Symfony Console`
`51`	`51`	`args = append(args, "-a1", fmt.Sprintf("-s%s", console.GuessShell()))`
`52`	`52`
`53`		`- if executor, err := php.SymfonyConsoleExecutor(args); err == nil {`
	`53`	`+ if executor, err := php.SymfonyConsoleExecutor(terminal.Logger, args); err == nil {`
`54`	`54`	`os.Exit(executor.Execute(false))`
`55`	`55`	`}`
`56`	`56`
Original file line number	Diff line number	Diff line change
`@@ -74,8 +74,7 @@ func main() {`
`74`	`74`	`}`
`75`	`75`	`// called via "symfony console"?`
`76`	`76`	`if len(args) >= 2 && args[1] == "console" {`
`77`		`- if executor, err := php.SymfonyConsoleExecutor(args[2:]); err == nil {`
`78`		`- executor.Logger = terminal.Logger`
	`77`	`+ if executor, err := php.SymfonyConsoleExecutor(terminal.Logger, args[2:]); err == nil {`
`79`	`78`	`executor.ExtraEnv = getCliExtraEnv()`
`80`	`79`	`os.Exit(executor.Execute(false))`
`81`	`80`	`}`