github.com/andresbott/yamlfmt@v0.1.0/README.md (about)

     1  # yamlfmt
     2  Yet another yaml formatter
     3  
     4  ## Use
     5  
     6  usage examples
     7  ```
     8  # print help
     9  yamlfmt -h
    10  
    11  # quietly format .yaml and .yml files in the current dir
    12  yamlfmt ./ -q
    13  
    14  # recurisvely print differences in .yaml and .yml, dry run
    15  yamlfmt ./... -v -d
    16  
    17  ```
    18  
    19  ### formatting 
    20  changes applied to the files are as follows:
    21  
    22  * the indentation is set to 2 spaces.
    23  * line breaks are reduced to only one.
    24  * quotes in keys and values are removed whenever it is possible.
    25  
    26  
    27  ## Development
    28  
    29  #### Requirements
    30  
    31  * go
    32  * make
    33  * goreleaser
    34  * golangci-lint
    35  * git
    36  
    37  #### Release
    38  
    39  make sure you have your gh token stored locally in ~/.goreleaser/gh_token
    40  
    41  to release a new version:
    42  ```bash 
    43  make release  version="v0.1.2"
    44  ```