Skip to content
Normal view History Permalink
README.rst 2.21 KiB
Newer Older
nimrod's avatar
Scaffolding.
nimrod committed
1 2 3 
YAML tool
#########
nimrod's avatar
CI status badge.  
nimrod committed
4 5 6 7 
.. image:: https://git.shore.co.il/nimrod/yamltool/badges/main/pipeline.svg
    :target: https://git.shore.co.il/nimrod/yamltool/-/commits/main
    :alt: pipeline status
nimrod's avatar
Scaffolding.
nimrod committed
8 9 10 11 12 13 
YAML tool, a clone of the json.tool Python module for YAML.

This tool provides a simple command line interface to validate and pretty-print
YAML documents while trying to preserve as much as possible from the original
documents (like comments and anchors).
nimrod's avatar
First try.  
nimrod committed
14 15 16 17 18 
Usage
-----

.. code:: shell
nimrod's avatar
Allow pretty printing files in place.  
nimrod committed
19 
    usage: yt [-h] [-i] [files ...]
nimrod's avatar
First try.  
nimrod committed
20
nimrod's avatar
Allow pretty printing files in place.  
nimrod committed
21 
    YAML tool, a clone of the json.tool Python module for YAML.
nimrod's avatar
First try.  
nimrod committed
22
nimrod's avatar
Allow pretty printing files in place.  
nimrod committed
23 24 25 
    This tool provides a simple command line interface to validate and pretty-print
    YAML documents while trying to preserve as much as possible from the original
    documents (like comments and anchors).
nimrod's avatar
First try.  
nimrod committed
26
nimrod's avatar
Allow pretty printing files in place.  
nimrod committed
27 28 
    positional arguments:
      files           a YAML file to be validated or pretty-printed
nimrod's avatar
First try.  
nimrod committed
29
nimrod's avatar
Allow pretty printing files in place.  
nimrod committed
30 31 32 33 34 35 36 37 38 39 40 
    optional arguments:
      -h, --help      show this help message and exit
      -i, --in-place  Perform the pretty-print in place, overwriting the existing files.

    When enabling --in-place, all files are processed as input files.
    When --in-place is not enabled and there are more then 2 files
    passed, the last files is considered as the output file. If you
    wish to pretty-print multiple files and output to standard out,
    specify the last file as "-" .
    Please note that specifying multiple input files will concatenate
    them, resulting in a single file that has multiple documents.
nimrod's avatar
First try.  
nimrod committed
41
nimrod's avatar
Pre-commit hook.  
nimrod committed
42 43 44 
pre-commit hook
---------------
nimrod's avatar
Fix typo.  
nimrod committed
45 
YAML tool can be used as a `pre-commit <https://pre-commit.com/>`_ hook by
nimrod's avatar
Pre-commit hook.  
nimrod committed
46 47 48 49 50 51 52 53 54 55 56 
adding the following to your :code:`.pre-commit-config.yaml` file:

.. code:: yaml

    ---
    repos:
      - repo: https://git.shore.co.il/nimrod/yamltool.git
        rev: 0.1.0  # Check for the latest tag or run pre-commit autoupdate.
        hooks:
          - id: yamltool
nimrod's avatar
Scaffolding.
nimrod committed
57 58 59 60 61 62 63 64 65 66 67 68 69 
License
-------

This software is licensed under the MIT license (see the :code:`LICENSE.txt`
file).

Author
------

Nimrod Adar, `contact me <nimrod@shore.co.il>`_ or visit my `website
<https://www.shore.co.il/>`_. Patches are welcome via `git send-email
<http://git-scm.com/book/en/v2/Git-Commands-Email>`_. The repository is located
at: https://git.shore.co.il/nimrod/.