https://github.com/unfor19/yarser

A CLI for parsing YAML anchors to regular YAML files.
https://github.com/unfor19/yarser

anchor parse parser parsing yaml yml

Last synced: 28 days ago
JSON representation

A CLI for parsing YAML anchors to regular YAML files.

• Host: GitHub
• URL: https://github.com/unfor19/yarser
• Owner: unfor19
• License: mit
• Created: 2021-08-04T20:59:17.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-09-13T18:06:20.000Z (about 3 years ago)
• Last Synced: 2024-10-02T06:03:01.576Z (about 1 month ago)
• Topics: anchor, parse, parser, parsing, yaml, yml
• Language: Go
• Homepage: https://meirg.co.il
• Size: 47.9 KB
• Stars: 7
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# yarser

[![Release](https://github.com/unfor19/yarser/actions/workflows/release.yml/badge.svg)](https://github.com/unfor19/yarser/actions/workflows/release.yml)

A CLI for parsing YAML anchors to plain YAML files.

![yarser-demo](https://assets.meirg.co.il/yarser/yarser-demo.gif)

## Features

- Parses YAML anchors

- Allows usage of `.hidden` nodes by adding the prefix `.` to a root node. All hidden nodes are omitted from the final result

In my tests, I use [tests/github-action/my-action.yml](https://github.com/unfor19/yarser/blob/master/tests/github-action/my-action.yml) as the source file, and the compiled result is [tests/github-action/my-action-compiled.yml](https://github.com/unfor19/yarser/blob/master/tests/github-action/my-action-compiled.yml). Go ahead and check how it looks like after parsing (compiling) the source YAML file.

## Getting Started

1. Download the binary file from the releases page, for example [0.0.1rc3](https://github.com/unfor19/yarser/releases/tag/0.0.1rc3)

   - macOS - Intel chips

    ```bash

    YARSER_OS="darwin" && \

    YARSER_ARCH="amd64" && \

    YARSER_VERSION="0.0.1rc3" && \

    curl -sL -o yarser "https://github.com/unfor19/yarser/releases/download/${YARSER_VERSION}/yarser_${YARSER_VERSION}_${YARSER_OS}_${YARSER_ARCH}"

    ```

   - macOS - M1 chips

    ```bash

    YARSER_OS="darwin" && \

    YARSER_ARCH="arm64" && \

    YARSER_VERSION="0.0.1rc3" && \

    curl -sL -o yarser "https://github.com/unfor19/yarser/releases/download/${YARSER_VERSION}/yarser_${YARSER_VERSION}_${YARSER_OS}_${YARSER_ARCH}"

    ```    

   - Linux - amd64

    ```bash

    YARSER_OS="linux" && \

    YARSER_ARCH="amd64" && \

    YARSER_VERSION="0.0.1rc3" && \

    curl -sL -o yarser "https://github.com/unfor19/yarser/releases/download/${YARSER_VERSION}/yarser_${YARSER_VERSION}_${YARSER_OS}_${YARSER_ARCH}"

    ```

   - [Windows WSL2](https://docs.microsoft.com/en-us/windows/wsl/install-win10) - 386

    ```bash

    YARSER_OS="linux" && \

    YARSER_ARCH="386" && \    

    YARSER_VERSION="0.0.1rc3" && \

    curl -sL -o yarser "https://github.com/unfor19/yarser/releases/download/${YARSER_VERSION}/yarser_${YARSER_VERSION}_${YARSER_OS}_${YARSER_ARCH}"   

    ```

2. Set permissions to allow execution of `yarser` binary and move to `/usr/local/bin` dir 

   ```bash

   chmod +x yarser && \

   sudo mv yarser "/usr/local/bin/yarser"

   ```

3. Parse a YAML file once - here's the YAML file with anchors that I'm testing with [my-action.yml](tests/github-action/my-action.yml)

   ```bash

   SRC_FILE_PATH="tests/github-action/my-action.yml" && \

   DST_FILE_PATH=".my-action-compiled.yml" && \

   yarser parse --watch "$SRC_FILE_PATH" "$DST_FILE_PATH"

   # INFO[2021-08-21T19:10:25+03:00] Successfully parsed tests/github-action/my-action.yml to .my-action-compiled.yml

   # Check the file .my-action-compiled.yml

   ```

4. Parse on save while editing the source file by adding the `--watch` flag

   ```bash

   SRC_FILE_PATH="tests/github-action/my-action.yml" && \

   DST_FILE_PATH=".my-action-compiled.yml" && \

   yarser parse --watch "$SRC_FILE_PATH" "$DST_FILE_PATH"

   

   # INFO[2021-08-21T19:13:47+03:00] Watching for changes in tests/github-action/my-action.yml ... 

   # INFO[2021-08-21T19:13:53+03:00] Successfully parsed tests/github-action/my-action.yml to .my-action-compiled.yml

   

   # Keep on editing and saving the source file, and it will automatically parse it

   ```

## Authors

Created and maintained by [Meir Gabay](https://github.com/unfor19)

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/unfor19/yarser/blob/master/LICENSE) file for details