Nosial/ncc
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 11 Packages Wiki Activity Actions

Improved help menu

Browse source 
https://git.n64.cc/nosial/ncc/-/issues/23
This commit is contained in:
Netkas 2022-12-07 18:06:42 -05:00
parent b465bcefa5
commit f1e7aeccfa
1 changed files with 21 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
src/ncc/CLI/HelpMenu.php
View file

@ -2,8 +2,12 @@
namespace ncc\CLI; namespace ncc\CLI;
use ncc\Exceptions\AccessDeniedException;
use ncc\Exceptions\FileNotFoundException;
use ncc\Exceptions\IOException;
use ncc\Objects\CliHelpSection; use ncc\Objects\CliHelpSection;
use ncc\Utilities\Console; use ncc\Utilities\Console;
use ncc\Utilities\Functions;
class HelpMenu class HelpMenu
{ {
@ -12,8 +16,11 @@
* *
* @param $args * @param $args
* @return void * @return void
* @throws AccessDeniedException
* @throws FileNotFoundException
* @throws IOException
*/ */
public static function start($args) public static function start($args): void
{ {
$basic_ascii = false; $basic_ascii = false;
@ -23,7 +30,7 @@
} }
// TODO: Make copyright not hard-coded. // TODO: Make copyright not hard-coded.
print(\ncc\Utilities\Functions::getBanner(NCC_VERSION_BRANCH . ' ' . NCC_VERSION_NUMBER, 'Copyright (c) 2022-2022 Nosial', $basic_ascii) . PHP_EOL); print(Functions::getBanner(NCC_VERSION_BRANCH . ' ' . NCC_VERSION_NUMBER, 'Copyright (c) 2022-2022 Nosial', $basic_ascii) . PHP_EOL);
Console::out('Usage: ncc COMMAND [options]'); Console::out('Usage: ncc COMMAND [options]');
Console::out('Alternative Usage: ncc.php --ncc-cli=COMMAND [options]' . PHP_EOL); Console::out('Alternative Usage: ncc.php --ncc-cli=COMMAND [options]' . PHP_EOL);
@ -42,7 +49,8 @@
*/ */
private static function displayMainOptions(): void private static function displayMainOptions(): void
{ {
$options = [ Console::out('Options:');
Console::outHelpSections([
new CliHelpSection(['{command} --help'], 'Displays help information about a specific command'), new CliHelpSection(['{command} --help'], 'Displays help information about a specific command'),
new CliHelpSection(['-v', '--version'], 'Display NCC version information'), new CliHelpSection(['-v', '--version'], 'Display NCC version information'),
new CliHelpSection(['-D', '--debug'], 'Enables debug mode'), new CliHelpSection(['-D', '--debug'], 'Enables debug mode'),
@ -50,14 +58,7 @@
new CliHelpSection(['--basic-ascii'], 'Uses basic ascii characters'), new CliHelpSection(['--basic-ascii'], 'Uses basic ascii characters'),
new CliHelpSection(['--no-color'], 'Omits the use of colors'), new CliHelpSection(['--no-color'], 'Omits the use of colors'),
new CliHelpSection(['--no-banner'], 'Omits displaying the NCC ascii banner') new CliHelpSection(['--no-banner'], 'Omits displaying the NCC ascii banner')
]; ]);
$options_padding = \ncc\Utilities\Functions::detectParametersPadding($options) + 4;
Console::out('Options:');
foreach($options as $option)
{
Console::out(' ' . $option->toString($options_padding));
}
} }
/** /**
@ -67,20 +68,14 @@
*/ */
private static function displayManagementCommands(): void private static function displayManagementCommands(): void
{ {
$commands = [ Console::out('Management Commands:');
Console::outHelpSections([
new CliHelpSection(['project'], 'Manages the current project'), new CliHelpSection(['project'], 'Manages the current project'),
new CliHelpSection(['package'], 'Manages the package system'), new CliHelpSection(['package'], 'Manages the package system'),
new CliHelpSection(['cache'], 'Manages the system cache'), new CliHelpSection(['cache'], 'Manages the system cache'),
new CliHelpSection(['cred'], 'Manages credentials'), new CliHelpSection(['cred'], 'Manages credentials'),
new CliHelpSection(['config'], 'Changes NCC configuration values'), new CliHelpSection(['config'], 'Changes NCC configuration values'),
]; ]);
$commands_padding = \ncc\Utilities\Functions::detectParametersPadding($commands) + 2;
Console::out('Management Commands:');
foreach($commands as $command)
{
Console::out(' ' . $command->toString($commands_padding));
}
} }
/** /**
@ -90,17 +85,11 @@
*/ */
private static function displayMainCommands(): void private static function displayMainCommands(): void
{ {
$commands = [ Console::out('Commands:');
Console::outHelpSections([
new CliHelpSection(['build'], 'Builds the current project'), new CliHelpSection(['build'], 'Builds the current project'),
new CliHelpSection(['main'], 'Executes the main entrypoint of a package') new CliHelpSection(['main'], 'Executes the main entrypoint of a package')
]; ]);
$commands_padding = \ncc\Utilities\Functions::detectParametersPadding($commands) + 2;
Console::out('Commands:');
foreach($commands as $command)
{
Console::out(' ' . $command->toString($commands_padding));
}
} }
/** /**
@ -110,15 +99,9 @@
*/ */
private static function displayExtensions(): void private static function displayExtensions(): void
{ {
$extensions = [
new CliHelpSection(['exphp'], 'The PHP compiler extension')
];
$extensions_padding = \ncc\Utilities\Functions::detectParametersPadding($extensions) + 2;
Console::out('Extensions:'); Console::out('Extensions:');
foreach($extensions as $command) Console::outHelpSections([
{ new CliHelpSection(['exphp'], 'The PHP compiler extension')
Console::out(' ' . $command->toString($extensions_padding)); ]);
}
} }
} }