├── tests
    ├── Support
    │   ├── Data
    │   │   └── .gitkeep
    │   ├── _generated
    │   │   └── .gitignore
    │   ├── CliTester.php
    │   └── UnitTester.php
    ├── Cli.suite.yml
    ├── Unit.suite.yml
    ├── Cli
    │   └── ConsoleCest.php
    └── Unit
    │   └── EchoCest.php
├── config
    ├── .gitignore
    ├── environments
    │   ├── dev
    │   │   └── params.php
    │   ├── prod
    │   │   └── params.php
    │   └── test
    │   │   └── params.php
    ├── commands.php
    ├── params.php
    └── di
    │   └── logger.php
├── runtime
    └── .gitignore
├── .env
├── .env.test
├── yii.bat
├── .editorconfig
├── .gitignore
├── yii
├── psalm.xml
├── codeception.yml
├── autoload.php
├── configuration.php
├── src
    └── Command
    │   └── EchoCommand.php
└── composer.json


/tests/Support/Data/.gitkeep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/config/.gitignore:
--------------------------------------------------------------------------------
1 | .merge-plan.php
2 | 


--------------------------------------------------------------------------------
/runtime/.gitignore:
--------------------------------------------------------------------------------
1 | *
2 | !.gitignore
3 | 


--------------------------------------------------------------------------------
/tests/Support/_generated/.gitignore:
--------------------------------------------------------------------------------
1 | *
2 | !.gitignore
3 | 


--------------------------------------------------------------------------------
/.env:
--------------------------------------------------------------------------------
1 | # Dev environment variables for Codeception.
2 | YII_ENV=dev
3 | YII_DEBUG=true
4 | 


--------------------------------------------------------------------------------
/.env.test:
--------------------------------------------------------------------------------
1 | # Test environment variables for Codeception.
2 | YII_ENV=test
3 | YII_DEBUG=true
4 | 


--------------------------------------------------------------------------------
/config/environments/dev/params.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | declare(strict_types=1);
4 | 
5 | return [
6 | ];
7 | 


--------------------------------------------------------------------------------
/config/environments/prod/params.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | declare(strict_types=1);
4 | 
5 | return [
6 | ];
7 | 


--------------------------------------------------------------------------------
/config/environments/test/params.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | declare(strict_types=1);
4 | 
5 | return [
6 | ];
7 | 


--------------------------------------------------------------------------------
/tests/Cli.suite.yml:
--------------------------------------------------------------------------------
1 | actor: CliTester
2 | modules:
3 |   enabled:
4 |     - Cli
5 |   step_decorators: ~
6 | 


--------------------------------------------------------------------------------
/tests/Unit.suite.yml:
--------------------------------------------------------------------------------
1 | actor: UnitTester
2 | modules:
3 |   enabled:
4 |     - Asserts
5 |   step_decorators: ~
6 | 


--------------------------------------------------------------------------------
/yii.bat:
--------------------------------------------------------------------------------
1 | @echo off
2 | @setlocal
3 | set YII_PATH=%~dp0
4 | if "%PHP_COMMAND%" == "" set PHP_COMMAND=php
5 | "%PHP_COMMAND%" "%YII_PATH%yii" %*
6 | @endlocal
7 | 


--------------------------------------------------------------------------------
/config/commands.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | use App\Command\EchoCommand;
 6 | 
 7 | return [
 8 |     'echo' => EchoCommand::class,
 9 | ];
10 | 


--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
 1 | # editorconfig.org
 2 | 
 3 | root = true
 4 | 
 5 | [*]
 6 | charset = utf-8
 7 | end_of_line = lf
 8 | insert_final_newline = true
 9 | indent_style = space
10 | indent_size = 4
11 | trim_trailing_whitespace = true
12 | 
13 | [*.md]
14 | trim_trailing_whitespace = false
15 | 
16 | [*.yml]
17 | indent_size = 2
18 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # phpstorm project files
 2 | .idea
 3 | 
 4 | # netbeans project files
 5 | nbproject
 6 | 
 7 | # zend studio for eclipse project files
 8 | .buildpath
 9 | .project
10 | .settings
11 | 
12 | # windows thumbnail cache
13 | Thumbs.db
14 | 
15 | # Mac DS_Store Files
16 | .DS_Store
17 | 
18 | # composer vendor dir
19 | /vendor
20 | 


--------------------------------------------------------------------------------
/config/params.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | return [
 6 |     'yiisoft/aliases' => [
 7 |         'aliases' => [
 8 |             '@root' => dirname(__DIR__),
 9 |             '@runtime' => '@root/runtime',
10 |         ],
11 |     ],
12 | 
13 |     'yiisoft/yii-console' => [
14 |         'commands' => require __DIR__ . '/commands.php',
15 |     ],
16 | ];
17 | 


--------------------------------------------------------------------------------
/config/di/logger.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | use Psr\Log\LoggerInterface;
 6 | use Yiisoft\Definitions\ReferencesArray;
 7 | use Yiisoft\Log\Logger;
 8 | use Yiisoft\Log\Target\File\FileTarget;
 9 | 
10 | return [
11 |     LoggerInterface::class => [
12 |         'class' => Logger::class,
13 |         '__construct()' => [
14 |             'targets' => ReferencesArray::from([FileTarget::class]),
15 |         ],
16 |     ],
17 | ];
18 | 


--------------------------------------------------------------------------------
/yii:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env php
 2 | <?php
 3 | 
 4 | declare(strict_types=1);
 5 | 
 6 | use Yiisoft\Yii\Runner\Console\ConsoleApplicationRunner;
 7 | 
 8 | require_once __DIR__ . '/autoload.php';
 9 | 
10 | // Run console application runner
11 | $runner = new ConsoleApplicationRunner(
12 |     rootPath: __DIR__,
13 |     debug: (bool)$_ENV['YII_DEBUG'],
14 |     checkEvents: (bool)$_ENV['YII_DEBUG'],
15 |     environment: $_ENV['YII_ENV']
16 | );
17 | $runner->run();
18 | 


--------------------------------------------------------------------------------
/psalm.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <psalm
 3 |     errorLevel="1"
 4 |     findUnusedBaselineEntry="true"
 5 |     findUnusedCode="false"
 6 |     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 7 |     xmlns="https://getpsalm.org/schema/config"
 8 |     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
 9 | >
10 |     <projectFiles>
11 |         <directory name="src"/>
12 |         <ignoreFiles>
13 |             <directory name="vendor"/>
14 |         </ignoreFiles>
15 |     </projectFiles>
16 | </psalm>
17 | 


--------------------------------------------------------------------------------
/codeception.yml:
--------------------------------------------------------------------------------
 1 | namespace: App\Tests
 2 | support_namespace: Support
 3 | paths:
 4 |   tests: tests
 5 |   output: runtime/tests/_output
 6 |   data: tests/Support/Data
 7 |   support: tests/Support
 8 |   envs: tests/_envs
 9 | actor_suffix: Tester
10 | extensions:
11 |   enabled:
12 |     - Codeception\Extension\RunFailed
13 | settings:
14 |   suite_class: \PHPUnit_Framework_TestSuite
15 |   memory_limit: 1024M
16 |   colors: true
17 | coverage:
18 |   enabled: true
19 |   whitelist:
20 |     include:
21 |       - src/*
22 | params:
23 |   - .env.test
24 | 


--------------------------------------------------------------------------------
/autoload.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | use Dotenv\Dotenv;
 6 | 
 7 | require_once __DIR__ . '/vendor/autoload.php';
 8 | 
 9 | $dotenv = Dotenv::createImmutable(__DIR__);
10 | $dotenv->load();
11 | 
12 | $_ENV['YII_ENV'] = empty($_ENV['YII_ENV']) ? null : (string)$_ENV['YII_ENV'];
13 | $_SERVER['YII_ENV'] = $_ENV['YII_ENV'];
14 | 
15 | $_ENV['YII_DEBUG'] = filter_var(
16 |     !empty($_ENV['YII_DEBUG']) ? $_ENV['YII_DEBUG'] : true,
17 |     FILTER_VALIDATE_BOOLEAN,
18 |     FILTER_NULL_ON_FAILURE
19 | ) ?? true;
20 | $_SERVER['YII_DEBUG'] = $_ENV['YII_DEBUG'];
21 | 


--------------------------------------------------------------------------------
/tests/Cli/ConsoleCest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace App\Tests\Cli;
 6 | 
 7 | use App\Tests\Support\CliTester;
 8 | 
 9 | final class ConsoleCest
10 | {
11 |     public function testCommandYii(CliTester $I): void
12 |     {
13 |         $command = dirname(__DIR__, 2) . '/yii';
14 |         $I->runShellCommand($command);
15 |         $I->seeInShellOutput('Yii Console');
16 |     }
17 | 
18 |     public function testCommandHello(CliTester $I): void
19 |     {
20 |         $command = dirname(__DIR__, 2) . '/yii';
21 |         $I->runShellCommand($command . ' echo');
22 |         $I->seeInShellOutput('Hello!');
23 |     }
24 | }
25 | 


--------------------------------------------------------------------------------
/tests/Support/CliTester.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace App\Tests\Support;
 6 | 
 7 | use Codeception\Actor;
 8 | 
 9 | /**
10 |  * Inherited Methods
11 |  *
12 |  * @method void wantToTest($text)
13 |  * @method void wantTo($text)
14 |  * @method void execute($callable)
15 |  * @method void expectTo($prediction)
16 |  * @method void expect($prediction)
17 |  * @method void amGoingTo($argumentation)
18 |  * @method void am($role)
19 |  * @method void lookForwardTo($achieveValue)
20 |  * @method void comment($description)
21 |  * @method void pause($vars = [])
22 |  *
23 |  * @SuppressWarnings(PHPMD)
24 | */
25 | class CliTester extends Actor
26 | {
27 |     use _generated\CliTesterActions;
28 | 
29 |     /**
30 |      * Define custom actions here
31 |      */
32 | }
33 | 


--------------------------------------------------------------------------------
/tests/Support/UnitTester.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace App\Tests\Support;
 6 | 
 7 | use Codeception\Actor;
 8 | 
 9 | /**
10 |  * Inherited Methods
11 |  *
12 |  * @method void wantToTest($text)
13 |  * @method void wantTo($text)
14 |  * @method void execute($callable)
15 |  * @method void expectTo($prediction)
16 |  * @method void expect($prediction)
17 |  * @method void amGoingTo($argumentation)
18 |  * @method void am($role)
19 |  * @method void lookForwardTo($achieveValue)
20 |  * @method void comment($description)
21 |  * @method void pause($vars = [])
22 |  *
23 |  * @SuppressWarnings(PHPMD)
24 | */
25 | class UnitTester extends Actor
26 | {
27 |     use _generated\UnitTesterActions;
28 | 
29 |     /**
30 |      * Define custom actions here
31 |      */
32 | }
33 | 


--------------------------------------------------------------------------------
/configuration.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | return [
 6 |     'config-plugin' => [
 7 |         'params' => 'params.php',
 8 |         'params-console' => '$params',
 9 |         'di' => 'di/*.php',
10 |         'di-console' => '$di',
11 |         'di-delegates' => [],
12 |         'di-delegates-console' => '$di-delegates',
13 |         'di-providers' => [],
14 |         'di-providers-console' => '$di-providers',
15 |         'events' => [],
16 |         'events-console' => '$events',
17 |         'bootstrap' => [],
18 |         'bootstrap-console' => '$bootstrap',
19 |     ],
20 |     'config-plugin-environments' => [
21 |         'dev' => [
22 |             'params' => [
23 |                 'environments/dev/params.php',
24 |             ],
25 |         ],
26 |         'prod' => [
27 |             'params' => [
28 |                 'environments/prod/params.php',
29 |             ],
30 |         ],
31 |         'test' => [
32 |             'params' => [
33 |                 'environments/test/params.php',
34 |             ],
35 |         ],
36 |     ],
37 |     'config-plugin-options' => [
38 |         'source-directory' => 'config',
39 |     ],
40 | ];
41 | 


--------------------------------------------------------------------------------
/src/Command/EchoCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace App\Command;
 6 | 
 7 | use Symfony\Component\Console\Attribute\AsCommand;
 8 | use Symfony\Component\Console\Command\Command;
 9 | use Symfony\Component\Console\Input\InputArgument;
10 | use Symfony\Component\Console\Input\InputDefinition;
11 | use Symfony\Component\Console\Input\InputInterface;
12 | use Symfony\Component\Console\Output\OutputInterface;
13 | use Yiisoft\Yii\Console\ExitCode;
14 | 
15 | #[AsCommand(
16 |     name: 'echo',
17 |     description: 'An example command that echoes exactly what it is told to.'
18 | )]
19 | final class EchoCommand extends Command
20 | {
21 |     private string $sentence = 'sentence';
22 | 
23 |     protected function configure(): void
24 |     {
25 |         $this->setDefinition(
26 |             new InputDefinition([
27 |                 new InputArgument($this->sentence, InputArgument::OPTIONAL, 'Sentence to say.', 'Hello!'),
28 |             ])
29 |         );
30 |     }
31 | 
32 |     protected function execute(InputInterface $input, OutputInterface $output): int
33 |     {
34 |         $output->writeln("You said: {$input->getArgument('sentence')}");
35 | 
36 |         return ExitCode::OK;
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "yiisoft/app-console",
 3 |     "type": "project",
 4 |     "description": "Template for console application",
 5 |     "keywords": [
 6 |         "yii",
 7 |         "console",
 8 |         "application",
 9 |         "template"
10 |     ],
11 |     "homepage": "https://www.yiiframework.com/",
12 |     "license": "BSD-3-Clause",
13 |     "support": {
14 |         "issues": "https://github.com/yiisoft/app-console/issues?state=open",
15 |         "source": "https://github.com/yiisoft/app-console",
16 |         "forum": "https://www.yiiframework.com/forum/",
17 |         "wiki": "https://www.yiiframework.com/wiki/",
18 |         "irc": "ircs://irc.libera.chat:6697/yii",
19 |         "chat": "https://t.me/yii3en"
20 |     },
21 |     "funding": [
22 |         {
23 |             "type": "opencollective",
24 |             "url": "https://opencollective.com/yiisoft"
25 |         },
26 |         {
27 |             "type": "github",
28 |             "url": "https://github.com/sponsors/yiisoft"
29 |         }
30 |     ],
31 |     "require": {
32 |         "php": "^8.1",
33 |         "vlucas/phpdotenv": "^5.3",
34 |         "yiisoft/aliases": "^3.0",
35 |         "yiisoft/log": "^2.0",
36 |         "yiisoft/log-target-file": "^3.0",
37 |         "yiisoft/yii-console": "^2.0",
38 |         "yiisoft/yii-runner-console": "^2.0"
39 |     },
40 |     "require-dev": {
41 |         "codeception/codeception": "^5.0",
42 |         "codeception/module-asserts": "^3.0",
43 |         "codeception/module-cli": "^2.0",
44 |         "codeception/module-phpbrowser": "^3.0",
45 |         "vimeo/psalm": "^5.24"
46 |     },
47 |     "autoload": {
48 |         "psr-4": {
49 |             "App\\": "src"
50 |         }
51 |     },
52 |     "autoload-dev": {
53 |         "psr-4": {
54 |             "App\\Tests\\": "tests"
55 |         }
56 |     },
57 |     "extra": {
58 |         "config-plugin-file": "configuration.php"
59 |     },
60 |     "config": {
61 |         "sort-packages": true,
62 |         "allow-plugins": {
63 |             "infection/extension-installer": true,
64 |             "composer/package-versions-deprecated": true,
65 |             "yiisoft/config": true
66 |         }
67 |     },
68 |     "scripts": {
69 |         "test": "codecept run"
70 |     }
71 | }
72 | 


--------------------------------------------------------------------------------
/tests/Unit/EchoCest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace App\Tests\Unit;
 6 | 
 7 | use App\Tests\Support\UnitTester;
 8 | use Psr\Container\ContainerInterface;
 9 | use Symfony\Component\Console\Application;
10 | use Symfony\Component\Console\CommandLoader\ContainerCommandLoader;
11 | use Symfony\Component\Console\Tester\CommandTester;
12 | use Yiisoft\Config\Config;
13 | use Yiisoft\Yii\Console\ExitCode;
14 | use Yiisoft\Yii\Runner\Console\ConsoleApplicationRunner;
15 | 
16 | final class EchoCest
17 | {
18 |     private Config $config;
19 |     private ContainerInterface $container;
20 | 
21 |     public function _before(UnitTester $I): void
22 |     {
23 |         $runner = new ConsoleApplicationRunner(
24 |             rootPath: dirname(__DIR__, 2),
25 |             environment: $_ENV['YII_ENV']
26 |         );
27 |         $this->config = $runner->getConfig();
28 |         $this->container = $runner->getContainer();
29 |     }
30 | 
31 |     public function testExecute(UnitTester $I): void
32 |     {
33 |         $app = new Application();
34 | 
35 |         $params = $this->config->get('params');
36 | 
37 |         $loader = new ContainerCommandLoader(
38 |             $this->container,
39 |             $params['yiisoft/yii-console']['commands']
40 |         );
41 | 
42 |         $app->setCommandLoader($loader);
43 | 
44 |         $command = $app->find('echo');
45 | 
46 |         $commandCreate = new CommandTester($command);
47 | 
48 |         $I->assertSame(ExitCode::OK, $commandCreate->execute([]));
49 | 
50 |         $output = $commandCreate->getDisplay(true);
51 | 
52 |         $I->assertStringContainsString('Hello!', $output);
53 |     }
54 | 
55 |     public function testExecuteWithArgument(UnitTester $I): void
56 |     {
57 |         $app = new Application();
58 | 
59 |         $params = $this->config->get('params');
60 | 
61 |         $loader = new ContainerCommandLoader(
62 |             $this->container,
63 |             $params['yiisoft/yii-console']['commands']
64 |         );
65 | 
66 |         $app->setCommandLoader($loader);
67 | 
68 |         $command = $app->find('echo');
69 | 
70 |         $commandCreate = new CommandTester($command);
71 | 
72 |         $I->assertSame(ExitCode::OK, $commandCreate->execute(['sentence' => 'Foo!']));
73 | 
74 |         $output = $commandCreate->getDisplay(true);
75 | 
76 |         $I->assertStringContainsString('Foo!', $output);
77 |     }
78 | }
79 | 


--------------------------------------------------------------------------------