Improvements tests and minor fixes (#9)

- Update command description to reflect schema validation.
- Update schema option description to include supported file types.
- Add a new task to the TODO list.
- Remove unnecessary comment from the code.

.github/workflows/main.yml

@@ -175,14 +175,13 @@ jobs:
           name: Reports - ${{ matrix.php-version }}
           path: build/
 
+
   docker:
     name: Docker
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
 
       - name: 🐳 Building Docker Image
         run: make build-docker
@@ -193,25 +192,3 @@ jobs:
       - name: Reporting example via Docker
         run: make demo-docker --no-print-directory
         continue-on-error: true
-
-  github-action:
-    name: GitHub Action
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - name: 👍 Valid CSV file
-        uses: ./
-        with:
-          csv: tests/fixtures/demo.csv
-          schema: tests/schemas/demo_valid.yml
-
-      - name: 👎 Invalid CSV file
-        uses: ./
-        with:
-          csv: tests/fixtures/demo.csv
-          schema: tests/schemas/demo_invalid.yml
-        continue-on-error: true

README.md

@@ -155,14 +155,14 @@ So there are options here for all occasions.
 
 
 Description:
-  Validate CSV file by rule
+  Validate CSV file by schema.
 
 Usage:
   validate:csv [options]
 
 Options:
   -c, --csv=CSV                  CSV filepath to validate.
-  -s, --schema=SCHEMA            Schema rule filepath.
+  -s, --schema=SCHEMA            Schema rule filepath. It can be a .yml/.json/.php file.
   -o, --output=OUTPUT            Report output format. Available options: text, table, github, gitlab, teamcity, junit [default: "table"]
       --no-progress              Disable progress bar animation for logs. It will be used only for text output format.
       --mute-errors              Mute any sort of errors. So exit code will be always "0" (if it's possible).
@@ -445,6 +445,7 @@ It's random ideas and plans. No orderings and deadlines. <u>But batch processing
 
 * [ ] Filename pattern validation with regex (like "all files in the folder should be in the format `/^[\d]{4}-[\d]{2}-[\d]{2}\.csv$/`").
 * [ ] CSV/Schema file discovery in the folder with regex filename pattern (like `glob(./**/dir/*.csv)`).
+* [ ] Build phar file and release via GitHub Actions.
 * [ ] If option `--csv` is a folder, then validate all files in the folder.
 * [ ] If option `--csv` is not specified, then the STDIN is used. To build a pipeline in Unix-like systems.
 * [ ] If option `--schema` is not specified, then validate only super base level things (like "is it a CSV file?").

src/Commands/ValidateCsv.php

@@ -25,26 +25,25 @@
 
 /**
  * @psalm-suppress PropertyNotSetInConstructor
- * @codeCoverageIgnore
  */
 final class ValidateCsv extends CliCommand
 {
     protected function configure(): void
     {
         $this
             ->setName('validate:csv')
-            ->setDescription('Validate CSV file by rule')
+            ->setDescription('Validate CSV file by schema.')
             ->addOption(
                 'csv',
                 'c',
                 InputOption::VALUE_REQUIRED,
-                'CSV filepath to validate. If not set or empty, then the STDIN is used.',
+                'CSV filepath to validate.',
             )
             ->addOption(
                 'schema',
                 's',
                 InputOption::VALUE_REQUIRED,
-                'Schema rule filepath',
+                'Schema rule filepath. It can be a .yml/.json/.php file.',
             )
             ->addOption(
                 'output',
@@ -73,7 +72,8 @@ protected function executeAction(): int
 
             if ($this->isTextMode()) {
                 $this->_(
-                    '<yellow>CSV file is not valid!</yellow> Found <e>' . $errorSuite->count() . '</e> errors.',
+                    '<yellow>CSV file is not valid!</yellow> ' .
+                    'Found <yellow>' . $errorSuite->count() . '<yellow> errors.',
                     OutLvl::E,
                 );
             }

src/Validators/ErrorSuite.php

@@ -128,7 +128,7 @@ private function renderPlainText(): string
             $result[] = (string)$error;
         }
 
-        return \implode("\n", $result);
+        return \implode("\n", $result) . "\n";
     }
 
     private function renderTable(): string
@@ -161,7 +161,7 @@ private function prepareSourceSuite(): SourceSuite
             $case         = $suite->addTestCase($caseName);
             $case->line   = $error->getLine();
             $case->file   = $this->csvFilename;
-            $case->errOut = $error->getMessage();
+            $case->errOut = (string)$error;
         }
 
         return $suite;