yamlfmt

A simple opionated yaml formatter that keeps your comments!

yamlfmt is just a cli wrapper around the ruamel.yaml python library, which happens to have the unique quality of keeping comments.

Usage

Note: The formatting used is subject to change without notice. Once a format seems to stick v1.0 will be tagged and the format will not change.

❯ yamlfmt -h
usage: yamlfmt [-h] [-w] [file [file ...]]

positional arguments:
  file         file to parse

optional arguments:
  -h, --help   show this help message and exit
  -w, --write  write formatted outpout to (source) file instead of stdout

Examples

Lets see yamlfmt in action:

Simple example from ruamel.yaml docs

❯ yamlfmt <<EOF
# example
name:
  # details
  family: Smith   # very common
  given: Alice    # one of the siblings
EOF
# example
name:
  # details
  family: Smith   # very common
  given: Alice    # one of the siblings

Travis-CI nodejs example

❯ yamlfmt <<EOF
language: node_js

# test on two node.js versions: 0.6 and 0.8
node_js:
  - 0.6
  - 0.8

# configure notifications (email, IRC, campfire etc)
# please update this section to your needs!
notifications:
  irc: "irc.freenode.org#travis"
EOF
language: node_js

# test on two node.js versions: 0.6 and 0.8
node_js:
- 0.6
- 0.8

# configure notifications (email, IRC, campfire etc)
# please update this section to your needs!
notifications:
  irc: irc.freenode.org#travis

Complex example from ruamel.yaml docs

❯ yamlfmt <<EOF
- &CENTER {x: 1, y: 2}
- &LEFT {x: 0, y: 2}
- &BIG {r: 10}
- &SMALL {r: 1}
# All the following maps are equal:
# Explicit keys
- x: 1
  y: 2
  r: 10
  label: center/big
# Merge one map
- <<: *CENTER
  r: 10
  label: center/big
# Merge multiple maps
- <<: [*CENTER, *BIG]
  label: center/big
# Override
- <<: [*BIG, *LEFT, *SMALL]
  x: 1
  label: center/big
EOF
- &CENTER {x: 1, y: 2}
- &LEFT {x: 0, y: 2}
- &BIG {r: 10}
- &SMALL {r: 1}
# All the following maps are equal:
# Explicit keys
- x: 1
  y: 2
  r: 10
  label: center/big
# Merge one map
- <<: *CENTER
  r: 10
  label: center/big
# Merge multiple maps
- <<: [*CENTER, *BIG]
  label: center/big
# Override
- <<: [*BIG, *LEFT, *SMALL]
  x: 1
  label: center/big

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yamlfmt-0.1.5.tar.gz (2.8 kB view details)

Uploaded Jun 28, 2017 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

yamlfmt-0.1.5-py3-none-any.whl (4.5 kB view details)

Uploaded Jun 28, 2017 Python 3

File details

Details for the file yamlfmt-0.1.5.tar.gz.

File metadata

Download URL: yamlfmt-0.1.5.tar.gz
Upload date: Jun 28, 2017
Size: 2.8 kB
Tags: Source
Uploaded using Trusted Publishing? No

File hashes

Hashes for yamlfmt-0.1.5.tar.gz
Algorithm	Hash digest
SHA256	`a72103a1c8237761ffcd7260d524c20e842c3d251de5dee1559795a2384ec842`
MD5	`42c18281d65a0b32c72fb928b95e2352`
BLAKE2b-256	`4354941dad45470756d8e317392586c6d2c28df40a4c9059d68cfcad0e1e2c92`

See more details on using hashes here.

File details

Details for the file yamlfmt-0.1.5-py3-none-any.whl.

File metadata

Download URL: yamlfmt-0.1.5-py3-none-any.whl
Upload date: Jun 28, 2017
Size: 4.5 kB
Tags: Python 3
Uploaded using Trusted Publishing? No

File hashes

Hashes for yamlfmt-0.1.5-py3-none-any.whl
Algorithm	Hash digest
SHA256	`63cb015c342b2694a870c713ec6d18ec34dab2cd8dd58c32698b7d98bc0b2672`
MD5	`4aa2a28713cfa3cf9476499fe597e0a3`
BLAKE2b-256	`fb07254afc3d618215c155e53e1802bc44c7c6b22fd7b8039ffe186378aef256`