feature #6963 [Yaml] Add lint:yaml command usage (chalasr, javiereguiluz)

xabbuh · xabbuh · commit 7a8e74a38e5b · 2016-11-28T22:25:36.000+01:00
This PR was submitted for the master branch but it was merged into the 3.2 branch instead (closes #6963). Discussion ---------- [Yaml] Add lint:yaml command usage This documents symfony/symfony#19139 (merged on 3.2) and closes symfony/symfony#19916. Commits ------- ed4cb40 Remove an unneeded code directive 44b4ad0 Use `terminal` instead of `bash` for console code 78075c1 Yaml] Add lint:yaml command usage
diff --git a/components/yaml.rst b/components/yaml.rst
@@ -293,6 +293,51 @@ flag::
     //       Line
     //       String
 
+Syntax Validation
+~~~~~~~~~~~~~~~~~
+
+The syntax of YAML contents can be validated through the CLI using the
+:class:`Symfony\\Component\\Yaml\\Command\\LintCommand` command.
+
+First, install the Console component:
+
+.. code-block:: terminal
+
+    $ composer require symfony/console
+
+Create a console application with ``lint:yaml`` as its only command::
+
+    // lint.php
+
+    use Symfony\Component\Console\Application;
+    use Symfony\Component\Yaml\Command\LintCommand;
+
+    (new Application('yaml/lint'))
+        ->add(new LintCommand())
+        ->getApplication()
+        ->setDefaultCommand('lint:yaml', true)
+        ->run();
+
+Then, execute the script for validating contents:
+
+.. code-block:: terminal
+
+    # validates a single file
+    $ php lint.php path/to/file.yml
+
+    # or all the files in a directory
+    $ php lint.php path/to/directory
+
+    # or contents passed to STDIN
+    $ cat path/to/file.yml | php lint.php
+
+The result is written to STDOUT and uses a plain text format by default.
+Add the ``--format`` option to get the output in JSON format:
+
+.. code-block:: terminal
+
+    $ php lint.php path/to/file.yml --format json
+
 Learn More
 ----------
 
