https://github.com/sergioisidoro/yashter

YAML + Stasher + Dyslexia = Yashter 📦
https://github.com/sergioisidoro/yashter

Last synced: 23 days ago
JSON representation

YAML + Stasher + Dyslexia = Yashter 📦

• Host: GitHub
• URL: https://github.com/sergioisidoro/yashter
• Owner: sergioisidoro
• Created: 2020-01-10T11:51:25.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-01-29T17:57:08.000Z (almost 5 years ago)
• Last Synced: 2024-10-05T20:41:12.259Z (3 months ago)
• Language: Python
• Homepage:
• Size: 11.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Yashter 📦 

## Stash your comments before manipulating YAML

⚠️ THIS IS AN **EXPERIMENTAL** BUNCH OF CODE THAT HAS NO GUARANTEE OF WORKING.

## Rational

Using comments in yaml locale files is a great way to provide context to translators and copy editors. However, tools like Rails i18n-tasks do not parse comments, and any action (like removing unused keys) is destructive for the comments.

Most YAML parsers and manipulators work quite the same way

I've made this so that I can stash YAML comments in a intermediary structure, and once all transformations are done, pop all the comments back again to the file.

The comments are stored in association to the keys

```

# Portuguese locales

pt: 

    # models localizations

    models:

        # Block of metal with wheels

        car: Carro

```

```

{

  "config/locales/en.yml": {

    "pt": {

      "_comments": [# Portuguese locales],

      "models": {

        "_comments": [# models localizations],

        "car": {

          "_comments": ["# Block of metal with wheels"],

        }

      }

      ...

    }

    ...

  }

  "config/locales/.../en.yml": {

      ....

  }

}

```

### Works

* Simple yerarchical yaml files (eg Ruby localization files)

* Keys have the comments **BEFORE** the keys

### Doesn't work

* Poping comments if the output YAML already contains comments

### Probably doesn't work

* Likely will break with lists or other structures

# Usage

```.sh

pipenv install

# STASH

# Does not touch the originals

pipenv run python yashter.py stash "config/locales/**/en.yml"

# Stashes things so that the original no longer has the comments

pipenv run python yashter.py stash "config/locales/**/en.yml" --replace

# POP

# This is a dry-run, and will create files alongside the originals

pipenv run python yashter.py pop

# This will replace the original locale files

pipenv run python yashter.py pop --replace

```