Add Markdown Lint and README.md formatting (#187)

This commit includes adding `Markdown Lint` to the GitHub workflow. This
will help in maintaining consistent formatting and code quality in
markdown files.

Updates were also made to enhance code readability by improving the
structure and formatting in the YAML scripts, PHP test files, and the
markdown readme file.

Moreover, a new `.editorconfig` file was added to manage markdown files
and `.markdownlint.yml` file was added to configure the linter.

Lastly, `Makefile` was updated to include commands for running markdown
tests.

.editorconfig

@@ -22,3 +22,12 @@ trim_trailing_whitespace = true
 insert_final_newline = true
 indent_style = space
 indent_size = 4
+
+[*.md]
+max_line_length = 150
+
+[Makfile]
+indent_style = tab
+
+[{*yml,*yaml}]
+indent_size = 2

.github/workflows/main.yml

@@ -136,6 +136,20 @@ jobs:
         run: make codestyle --no-print-directory
 
 
+  markdown-lint:
+    name: Markdown Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: 👍 Markdown Lint
+        uses: articulate/actions-markdownlint@v1
+        with:
+          config: .markdownlint.yml
+          files: '*.md'
+
+
   verify-php-binary:
     name: Verify PHP binary
     runs-on: ubuntu-latest

.markdownlint.yml

@@ -0,0 +1,37 @@
+#
+# JBZoo Toolbox - Csv-Blueprint.
+#
+# This file is part of the JBZoo Toolbox project.
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @license    MIT
+# @copyright  Copyright (C) JBZoo.com, All rights reserved.
+# @see        https://github.com/JBZoo/Csv-Blueprint
+#
+
+# See https://github.com/DavidAnson/markdownlint/tree/main/doc
+
+MD043: false
+
+MD033:
+  allowed_elements:
+    - summary
+    - details
+    - table
+    - tr
+    - td
+    - b
+    - br
+
+MD012:
+  maximum: 2
+
+MD013:
+  line_length: 150
+  heading_line_length: 120
+  code_blocks: false
+  tables: false
+  headings: true
+  strict: false
+  stern: false

Makefile

@@ -156,3 +156,8 @@ bench-phar: ##@Benchmarks Run CSV file with Phar
 bench-php: ##@Benchmarks Run CSV file with classic PHP binary
 	$(PHP_BIN) ./csv-blueprint --ansi --version
 	-$(BLUEPRINT) $(BENCH_CSV) $(BENCH_SCHEMAS) $(BENCH_FLAGS)
+
+# Extrat tests #########################################################################################################
+test-md: ##@Tests Run Markdown tests
+	$(call title,"Markdown lint")
+	@markdownlint --config .markdownlint.yml *.md