Update command names for consistency (#175)

Updated the command names used in command line execution from `validate:csv`, `create:schema`, and `validate:schema` to `validate-csv`, `create-schema`, and `validate-schema` respectively. These changes have been made across all code files, ensuring a more consistent command naming convention throughout the application. A legacy name is retained for backwards compatibility.
JBZoo · Apr 18, 2024 · d192792 · d192792
1 parent 9735b89
commit d192792
Show file tree

Hide file tree

Showing 16 changed files with 57 additions and 55 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -29,7 +29,7 @@ env:
   BLUEPRINT: time ./csv-blueprint
   BLUEPRINT_PHAR: time ./build/csv-blueprint.phar
   BLUEPRINT_DOCKER: time docker run --rm --workdir=/parent-host -v .:/parent-host jbzoo/csv-blueprint:local
-  CMD_VALIDATE: validate:csv --ansi -vvv
+  CMD_VALIDATE: validate-csv --ansi -vvv
   VALID_TEST: --csv=./tests/fixtures/batch/*.csv --schema=./tests/schemas/demo_valid.yml
   INVALID_TEST: --csv=./tests/fixtures/batch/*.csv --schema=./tests/schemas/demo_*.yml --schema=./tests/schemas/invalid_schema.yml
 

diff --git a/Dockerfile b/Dockerfile
@@ -40,7 +40,7 @@ COPY ./docker/php.ini /usr/local/etc/php/conf.d/docker-z99-php.ini
 # Warmup caches
 RUN php ./docker/random-csv.php \
     && JBZOO_BUILD_PRELOADER=1 \
-      ./csv-blueprint validate:csv \
+      ./csv-blueprint validate-csv \
       --schema=/app/schema-examples/full.yml \
       --csv=/app/docker/random_data.csv \
       --apply-all=yes \

diff --git a/Makefile b/Makefile
@@ -17,7 +17,7 @@ ifneq (, $(wildcard ./vendor/jbzoo/codestyle/src/init.Makefile))
 endif
 
 DOCKER_IMAGE     ?= jbzoo/csv-blueprint:local
-CMD_VALIDATE     := validate:csv --ansi
+CMD_VALIDATE     := validate-csv --ansi
 BLUEPRINT        := COLUMNS=300 time $(PHP_BIN) ./csv-blueprint $(CMD_VALIDATE)
 BLUEPRINT_PHAR   := COLUMNS=300 time $(PHP_BIN) ./build/csv-blueprint.phar $(CMD_VALIDATE)
 BLUEPRINT_DOCKER := time docker run --rm  --workdir=/parent-host -v .:/parent-host $(DOCKER_IMAGE) $(CMD_VALIDATE)

diff --git a/README.md b/README.md
@@ -119,7 +119,7 @@ docker run --rm                                  \
     --workdir=/parent-host                       \
     -v $(pwd):/parent-host                       \
     jbzoo/csv-blueprint:latest                   \
-    validate:csv                                 \ # See available commands and options below. 
+    validate-csv                                 \ # See available commands and options below. 
     --csv=./tests/fixtures/demo.csv              \ # Your CSV(s).
     --schema=./tests/schemas/demo_invalid.yml    \ # Your schema(s).
     --ansi
@@ -194,22 +194,22 @@ Ensure you have PHP installed on your machine.
 # Just download the latest version
 wget https://github.com/jbzoo/csv-blueprint/releases/latest/download/csv-blueprint.phar
 chmod +x ./csv-blueprint.phar
-./csv-blueprint.phar validate:csv               \
+./csv-blueprint.phar validate-csv               \
    --csv=./tests/fixtures/demo.csv              \
    --schema=./tests/schemas/demo_invalid.yml
 
 # OR create project via Composer (--no-dev is optional)
 composer create-project --no-dev jbzoo/csv-blueprint
 cd ./csv-blueprint
-./csv-blueprint validate:csv                    \
+./csv-blueprint validate-csv                    \
     --csv=./tests/fixtures/demo.csv             \
     --schema=./tests/schemas/demo_invalid.yml
 
 # OR build from source
 git clone git@github.com:jbzoo/csv-blueprint.git csv-blueprint
 cd csv-blueprint 
 make build
-./csv-blueprint validate:csv                    \
+./csv-blueprint validate-csv                    \
     --csv=./tests/fixtures/demo.csv             \
     --schema=./tests/schemas/demo_invalid.yml
 ```
@@ -1408,18 +1408,19 @@ For detailed information on each command and option, refer to
 the [JBZoo/Cli documentation](https://github.com/JBZoo/Cli). This resource provides insights into the functionality and
 application of the CLI commands, helping users make the most out of the tool's capabilities.
 
-`./csv-blueprint validate:csv --help`
+`./csv-blueprint validate-csv --help`
 
 <details>
-  <summary>CLICK to see validate:csv help messege</summary>
+  <summary>CLICK to see validate-csv help messege</summary>
 
 <!-- auto-update:validate-csv-help -->
 ```
 Description:
   Validate CSV file(s) by schema(s).
 
 Usage:
-  validate:csv [options]
+  validate-csv [options]
+  validate:csv
 
 Options:
   -c, --csv=CSV                    Specify the path(s) to the CSV files you want to validate.
@@ -1482,18 +1483,18 @@ Options:
 </details>
 
 
-`./csv-blueprint validate:schema --help`
+`./csv-blueprint validate-schema --help`
 
 <details>
-  <summary>CLICK to see validate:schema help messege</summary>
+  <summary>CLICK to see validate-schema help messege</summary>
 
 <!-- auto-update:validate-schema-help -->
 ```
 Description:
   Validate syntax in schema file(s).
 
 Usage:
-  validate:schema [options]
+  validate-schema [options]
 
 Options:
   -s, --schema=SCHEMA            Specify the path(s) to the schema file(s), supporting YAML, JSON, or PHP formats.
@@ -1585,19 +1586,19 @@ Options:
 </details>
 
 
-`./csv-blueprint create:schema --help`
+`./csv-blueprint create-schema --help`
 It's beta. Work in progress.
 
 <details>
-  <summary>CLICK to see create:schema help messege</summary>
+  <summary>CLICK to see create-schema help messege</summary>
 
 <!-- auto-update:create-schema-help -->
 ```
 Description:
   Analyze CSV files and suggest a schema based on the data found.
 
 Usage:
-  create:schema [options]
+  create-schema [options]
 
 Options:
   -c, --csv=CSV                  Specify the path(s) to the CSV files you want to analyze.

diff --git a/src/Commands/CreateSchema.php b/src/Commands/CreateSchema.php
@@ -30,7 +30,7 @@ final class CreateSchema extends AbstractValidate
     protected function configure(): void
     {
         $this
-            ->setName('create:schema')
+            ->setName('create-schema')
             ->setDescription('Analyze CSV files and suggest a schema based on the data found.')
             ->addOption(
                 'csv',

diff --git a/src/Commands/ValidateCsv.php b/src/Commands/ValidateCsv.php
@@ -34,7 +34,8 @@ final class ValidateCsv extends AbstractValidate
     protected function configure(): void
     {
         $this
-            ->setName('validate:csv')
+            ->setName('validate-csv')
+            ->setAliases(['validate:csv']) // Legacy name for backward compatibility only
             ->setDescription('Validate CSV file(s) by schema(s).')
             ->addOption(
                 'csv',

diff --git a/src/Commands/ValidateSchema.php b/src/Commands/ValidateSchema.php
@@ -30,7 +30,7 @@ final class ValidateSchema extends AbstractValidate
     protected function configure(): void
     {
         $this
-            ->setName('validate:schema')
+            ->setName('validate-schema')
             ->setDescription('Validate syntax in schema file(s).')
             ->addOption(
                 'schema',

diff --git a/tests/Commands/CreateSchemaTest.php b/tests/Commands/CreateSchemaTest.php
@@ -25,7 +25,7 @@ final class CreateSchemaTest extends TestCase
 {
     public function testWithoutHeader(): void
     {
-        [$actual, $exitCode] = Tools::virtualExecution('create:schema', [
+        [$actual, $exitCode] = Tools::virtualExecution('create-schema', [
             'csv' => './tests/fixtures/demo.csv',
         ]);
 
@@ -100,7 +100,7 @@ public function testWithoutHeader(): void
 
         \file_put_contents(PROJECT_ROOT . '/build/demo.schema.yml', $actual);
 
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', [
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', [
             'csv'    => './tests/fixtures/demo.csv',
             'schema' => PROJECT_ROOT . '/build/demo.schema.yml',
         ]);
@@ -109,7 +109,7 @@ public function testWithoutHeader(): void
 
     public function testWithHeader(): void
     {
-        [$actual, $exitCode] = Tools::virtualExecution('create:schema', [
+        [$actual, $exitCode] = Tools::virtualExecution('create-schema', [
             'csv'    => './tests/fixtures/demo.csv',
             'header' => 'true',
         ]);
@@ -184,7 +184,7 @@ public function testWithHeader(): void
 
         \file_put_contents(PROJECT_ROOT . '/build/demo.schema.yml', $actual);
 
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', [
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', [
             'csv'    => './tests/fixtures/demo.csv',
             'schema' => PROJECT_ROOT . '/build/demo.schema.yml',
         ]);

diff --git a/tests/Commands/ValidateCsvApplyAllTest.php b/tests/Commands/ValidateCsvApplyAllTest.php
@@ -33,7 +33,7 @@ public function testNoPatternApplyAllAutoNegativeMany(): void
             ],
         ]);
 
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', $optionsAsString);
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', $optionsAsString);
 
         $expected = <<<'TXT'
             CSV Blueprint: Unknown version (PhpUnit)
@@ -71,7 +71,7 @@ public function testNoPatternApplyAllAutoNegativeGlob(): void
             'schema' => './tests/schemas/demo_invalid_*.yml',
         ]);
 
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', $optionsAsString);
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', $optionsAsString);
 
         $expected = <<<'TXT'
             CSV Blueprint: Unknown version (PhpUnit)
@@ -107,7 +107,7 @@ public function testNoPatternApplyAllAutoPositive(): void
             'schema' => './tests/schemas/demo_invalid_no_pattern.yml',
         ]);
 
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', $optionsAsString);
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', $optionsAsString);
 
         $expected = <<<'TXT'
             CSV Blueprint: Unknown version (PhpUnit)
@@ -150,7 +150,7 @@ public function testNoPatternApplyAllYes(): void
             'apply-all' => 'yes',
         ]);
 
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', $optionsAsString);
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', $optionsAsString);
 
         $expected = <<<'TXT'
             CSV Blueprint: Unknown version (PhpUnit)
@@ -197,7 +197,7 @@ public function testNoPatternApplyAllYesGlob(): void
             'apply-all' => 'yes',
         ]);
 
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', $optionsAsString);
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', $optionsAsString);
 
         $expected = <<<'TXT'
             CSV Blueprint: Unknown version (PhpUnit)
@@ -240,7 +240,7 @@ public function testNoPatternApplyAllNo(): void
             'apply-all' => 'no',
         ]);
 
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', $optionsAsString);
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', $optionsAsString);
 
         $expected = <<<'TXT'
             CSV Blueprint: Unknown version (PhpUnit)

diff --git a/tests/Commands/ValidateCsvBasicTest.php b/tests/Commands/ValidateCsvBasicTest.php
@@ -27,7 +27,7 @@ final class ValidateCsvBasicTest extends TestCase
 {
     public function testValidateOneCsvPositive(): void
     {
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', [
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', [
             'csv'    => Tools::DEMO_CSV,
             'schema' => Tools::DEMO_YML_VALID,
         ]);
@@ -60,7 +60,7 @@ public function testValidateOneCsvPositive(): void
 
     public function testValidateOneCsvNegative(): void
     {
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', [
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', [
             'csv'    => Tools::DEMO_INVALID_CSV,
             'schema' => Tools::DEMO_YML_VALID,
         ]);
@@ -98,7 +98,7 @@ public function testValidateOneCsvNegative(): void
 
     public function testValidateOneCsvWithInvalidSchemaNegative(): void
     {
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', [
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', [
             'csv'    => Tools::DEMO_CSV,
             'schema' => Tools::DEMO_YML_INVALID,
         ]);
@@ -158,7 +158,7 @@ public function testInvalidSchemaNotMatched(): void
             'schema' => Tools::SCHEMA_INVALID,
         ];
         $optionsAsString = new StringInput(Cli::build('', $options));
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', $options);
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', $options);
 
         $expected = <<<'TXT'
             CSV Blueprint: Unknown version (PhpUnit)
@@ -206,7 +206,7 @@ public function testInvalidSchemaAndNotFoundCSV(): void
             'schema' => Tools::SCHEMA_INVALID,
         ];
         $optionsAsString = new StringInput(Cli::build('', $options));
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', $options);
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', $options);
 
         $expected = <<<'TXT'
             CSV Blueprint: Unknown version (PhpUnit)
@@ -247,7 +247,7 @@ public function testInvalidSchemaAndNotFoundCSV(): void
 
     public function testValidateOneCsvNoHeaderNegative(): void
     {
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', [
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', [
             'csv'       => Tools::DEMO_CSV,
             'schema'    => './tests/schemas/simple_no_header.yml',
             'apply-all' => 'yes',
@@ -288,7 +288,7 @@ public function testValidateOneCsvNoHeaderNegative(): void
 
     public function testNothingFound(): void
     {
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', [
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', [
             'csv'    => './tests/fixtures/no-found-file.csv',
             'schema' => 'invalid_schema_path.yml',
         ]);
@@ -325,7 +325,7 @@ public function testNoSchemaWasAppliedToCsv(): void
                 './tests/schemas/demo_valid.yml',
             ],
         ]);
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', $optionsAsString);
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', $optionsAsString);
 
         $expected = <<<'TXT'
             CSV Blueprint: Unknown version (PhpUnit)

diff --git a/tests/Commands/ValidateCsvBatchCsvTest.php b/tests/Commands/ValidateCsvBatchCsvTest.php
@@ -36,7 +36,7 @@ public function testValidateManyCsvPositive(): void
             'schema' => Tools::DEMO_YML_VALID,
         ]);
 
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', $optionsAsString);
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', $optionsAsString);
 
         $expected = <<<'TXT'
             CSV Blueprint: Unknown version (PhpUnit)
@@ -75,7 +75,7 @@ public function testValidateManyCsvNegative(): void
             'report' => 'text',
         ];
         $optionsAsString = new StringInput(Cli::build('', $options));
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', $options);
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', $options);
 
         $expected = <<<'TXT'
             CSV Blueprint: Unknown version (PhpUnit)
@@ -125,13 +125,13 @@ public function testValidateManyCsvNegative(): void
 
     public function testMultipleCsvOptions(): void
     {
-        [$expected, $expectedCode] = Tools::virtualExecution('validate:csv', [
+        [$expected, $expectedCode] = Tools::virtualExecution('validate-csv', [
             'csv'    => './tests/fixtures/batch/*.csv',
             'schema' => Tools::DEMO_YML_INVALID,
         ]);
 
         $actual = Tools::realExecution(
-            'validate:csv ' . \implode(' ', [
+            'validate-csv ' . \implode(' ', [
                 '--csv="./tests/fixtures/batch/sub/demo-3.csv"',
                 '--csv="./tests/fixtures/batch/demo-1.csv"',
                 '--csv="./tests/fixtures/batch/demo-2.csv"',

diff --git a/tests/Commands/ValidateCsvBatchSchemaTest.php b/tests/Commands/ValidateCsvBatchSchemaTest.php
@@ -34,7 +34,7 @@ public function testMultiSchemaDiscovery(): void
             ],
         ]);
 
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', $optionsAsString);
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', $optionsAsString);
 
         $expected = <<<'TXT'
             CSV Blueprint: Unknown version (PhpUnit)

diff --git a/tests/Commands/ValidateCsvQuickTest.php b/tests/Commands/ValidateCsvQuickTest.php
@@ -140,7 +140,7 @@ private function getQuickOutput(?array $quickOption = null): string
             $options = \array_merge($options, $quickOption);
         }
 
-        [$actual, $exitCode] = Tools::virtualExecution('validate:csv', $options);
+        [$actual, $exitCode] = Tools::virtualExecution('validate-csv', $options);
 
         isSame(1, $exitCode, $actual);
 

diff --git a/tests/Commands/ValidateCsvReportsTest.php b/tests/Commands/ValidateCsvReportsTest.php
@@ -451,7 +451,7 @@ private static function getReport(?string $reportType = null): string
             $options['report'] = $reportType;
         }
 
-        [$output, $exitCode] = Tools::virtualExecution('validate:csv', $options);
+        [$output, $exitCode] = Tools::virtualExecution('validate-csv', $options);
         isSame(1, $exitCode, $output);
 
         $output = \str_replace([