In the log outuput it would be cool to get the log output colorized according to the lint/fix status :

• green : nothing had to be done
• orange : fixes have been done
• red : lint did not pass and no fix could be applied : human intervention required

cf https://github.com/opt-nc/yamlfixer/blob/add-pypi-version-badge/README.md#-prerequisites

Install only is

python3 -m pip install yamlfixer-opt-nc

now

Context

Some of uf like one liners as they are cool and fun to use... and help promote nice looking shell scripts

Actions

• [x] Please create a one liner that send putput direclty in jq
• [x] Any other oneliners

1️⃣ Description

Yamlfixer version is not set in Dockerfile when yamlfixer is released. Yamlfixer version installed is not the last, but the version before.

Reason: The publication of the new version on pip registry is done after the docker image build and publish.

📑 Steps to Reproduce

Steps to reproduce the behavior:

docker pull optnc/yamlfixer:0.4.8
docker image ls
REPOSITORY                                        TAG                 IMAGE ID       CREATED             SIZE
optnc/yamlfixer                                   0.4.8               693169d2843d   About an hour ago   74.6MB

❯ docker run -i -t --name yamlfixer_0.4.8 --rm 693169d2843d /bin/sh
/ # yamlfixer --version
yamlfixer v0.4.7

2️⃣ Expected behavior

yamlfixer --version should return v.0.4.8

Additional context

Pip publication is done on release only, whereas docker image publication is done on push too. So, tag "latest" on docker image doesn't contains the latest version of the yamlfixer.

📜 Read (and accept) this before

• [x] I am respectful : this is free software and efforts are made on free time, with 💙
• [x] I have looked at the current project roadmap
• [x] I have already looked in current and past issues so I'm sure others did not already push a simlar issue
• [x] I make one single issue per feature request so the team can work efficienlty on it
• [x] I am aware of Unix philosophy : Make each program do one thing well
• [x] When (and if) your feature is implemented, be thankful and help promote the project by sharing the issue on social networks (twitter, linkedIn, dev.to...) and dropping the url on te issue

❔ Context

Detail the current situation/difficultes or problem you are facing and how you think yamlfixer could help :

👉 Actually we neeed to call a command line to run a yamlfixer command.

... but in some cases, it is possible that we could have to always run the same command with the same parameters from the same directory.

💡 Proposed solution

Detail here what you would like yamlfixer to do to help on the problematic.

In that case, the command line can be historized/versioned for example in CI scenarios.

it could looke like that :

yamlfixer --conf PATH_TO_YMLFXR_CONF

All parameters could be put in the conf file.. probably as simple yml file so it could be linted itsefl by yamlfixer and also deal with potential hierarchical parameters.

By default .yamllint could be the conf file (thanks for pointing this @tamere-allo-peter 👍 )

📑 Linked resources

• How gomplate implements that

👉 Context

Actually when we run yamlfixer command line we don't have a nice to read shell outputs yaml quality summary. It could be nice to get such a nice thing for the end user.

💡 Feature Request

Get a kind of dedicated summary section that may look like this (with emojis) :

Linted files summary : 

✔️ examples/good.yml
❗    examples/bad.yml (2 issues)

💵 Benefits

• Visual and very easy to interpret
• Makes it easy to make screenshots so people share output bu dropping images in chat while working on contents... and then save time while collaborating

👉 Contexte

Actually, the -version output is very convenient for human but could be simpler so code/programs (unit testing, scripts automation,...) could interact with it easier.

Actually we get this :

$ python3 yamlfixer --version
yamlfixer v0.1.2

💡 Feature request

As many other tools, could you instead returnas folllows (no more decoration) :

v0.1.2

... or add an option that adds decoration... like a verbose version of --version that could add :

• full tool name
• copyright elements
• GH repo url
• ...

👉 Context

A huge refactoring has been performed and it looks like it has broken the way the docker image was initially working.

The docker image has to be fixed as its is a very convenient way to use it in CI or any other use case.

👇 Reproducing issue

1️⃣ Katacoda steps

1. Go to the dedicated Katacoda scenario
2. Do all steps [1..4]
3. Reproduce the issue on Step 5/5

2️⃣ From any shell

1. Get the image, mount current dir with data samples and get a shell on it :

clear
git clone https://github.com/opt-nc/yamlfixer
cd yamlfixer
docker run -it -v $PWD/examples:/examples --rm optnc/yamlfixer /bin/sh

2. Try to execute yamlfixer

cd examples
ls -la
yamlfixer --summary *.yml

3. Get the error message

/bin/sh: yamlfixer: Permission denied

✔️ Definition Of Done

• [ ] Katacoda scenario up and running on the docker step
• [ ] Shell script would rework as it was previously working

NB : Feel free to contact me if we need to update the Katacoda Scenario on the docker part (Step 5)

Hi

With Python 3.8, after installing current version I get:

 $ yamlfixer conf/
Traceback (most recent call last):
  File "/Users//miniconda3/envs/py38/bin/yamlfixer", line 5, in <module>
    from yamlfixer.__main__ import run
  File "/Users//miniconda3/envs/py38/lib/python3.8/site-packages/yamlfixer/__main__.py", line 24, in <module>
    from .yamlfixer import YAMLFixer
  File "/Users//miniconda3/envs/py38/lib/python3.8/site-packages/yamlfixer/yamlfixer.py", line 25, in <module>
    from .filefixer import FileFixer
  File "/Users//miniconda3/envs/py38/lib/python3.8/site-packages/yamlfixer/filefixer.py", line 23, in <module>
    import magic
  File "/Users//miniconda3/envs/py38/lib/python3.8/site-packages/magic/__init__.py", line 209, in <module>
    libmagic = loader.load_lib()
  File "/Users//miniconda3/envs/py38/lib/python3.8/site-packages/magic/loader.py", line 49, in load_lib
    raise ImportError('failed to find libmagic.  Check your installation')
ImportError: failed to find libmagic.  Check your installation

📜 Read (and accept) this before

• [x] I am respectful : this is free software and efforts are made on free time, with 💙
• [x] I have looked at the current project roadmap
• [x] I have already looked in current and past issues so I'm sure others did not already push a simlar issue
• [x] I make one single issue per feature request so the team can work efficienlty on it
• [x] I am aware of Unix philosophy : Make each program do one thing well
• [x] When (and if) your feature is implemented, be thankful and help promote the project by sharing the issue on social networks (twitter, linkedIn, dev.to...) and dropping the url on te issue

❔ Context

Detail the current situation/difficultes or problem you are facing and how you think yamlfixer could help :

:point_right: Actuallu the --backup option only generated .org file extension : for sose usecases it would be convenient to be able to customize that (instead of having to manually copy files).

💡 Proposed solution

Detail here what you would like yamlfixer to do to help on the problematic.

• add a --backsupsuffix option so end user can customize backup files inside yamlfixer options

It could be interesting/cool to be able to produce a nice looking ASCII banner. For example during demos it helps communicating with people.

We could also add a sentence like theone below (under the ASCII art)

The tool that fixes your yaml... for you.

If could be displayed while calling :

--help ⚠️ (could break help2man) ⚠️ --banner : perfect for demo purpose

❔ Context

Fix quoted-strings. Docs: https://yamllint.readthedocs.io/en/stable/rules.html#module-yamllint.rules.quoted_strings

💡 Proposed solution

1. Change quote-type to double or single accordingly;
2. Remove unnecessary quotes when required is set to only-when-needed;
3. Add quotes when required is set to true;
4. Remove quoted quotes when allow-quoted-quotes is false.

1️⃣ Description

yamlfixer passes YAML files through yamllint by sending their content to yamllint's standard input.

Due to this behavior, yamllint doesn't know the input files' names, and so is unable to match them to ignore directives in .yamllint, if any is present.

📑 Steps to Reproduce

Steps to reproduce the behavior:

jerome@OPT17844:~/work$ yamllint -v
yamllint 1.26.3

jerome@OPT17844:~/work$ yamlfixer -v
yamlfixer v0.9.13

jerome@OPT17844:~/work$ cat meta/main.yml
---
galaxy_info:
  galaxy_tags: []
    # List tags for your role here, one per line. A tag is
    # a keyword that describes and categorizes the role.

# yamllint repots a comments-indentation problem
jerome@OPT17844:~/work$ yamllint --strict meta/main.yml
meta/main.yml
  4:5       warning  comment not indented like content  (comments-indentation)

# Then we create a .yamllint file
jerome@OPT17844:~/work$ cat .yamllint
---

extends: default

rules:
  line-length:
    max: 160
  comments-indentation:
    ignore: |
      meta/main.yml

# Now the meta/main.yml file is correctly ignored for rule comments-indentation
jerome@OPT17844:~/work$ yamllint --strict meta/main.yml
jerome@OPT17844:~/work$

# But yamlfixer wants to fix it anyway
jerome@OPT17844:~/work$ yamlfixer --summary meta/main.yml
Files to fix: 1
0 files were already correct before
1 files were modified but problems remain
0 files were entirely fixed
0 files were skipped
0 files were not writable
0 files with unknown status
   MODIFIED meta/main.yml (handled 1/1)
jerome@OPT17844:~/work$ 

2️⃣ Expected behavior

The expected behavior is for yamllint to not report any comments-indentation problem on the meta/main.yml file to yamlfixer, so that yamlfixer doesn't try to fix them.

So yamlfixer should be modified to pass file names to yamllint for real files, and only pass content on yamllint's stdin when its own input is stdin.

1️⃣ Description

Since branch protection it seems Docker Image doesn't get the right yamlfixer version. It get the main branch content before the merge

See logs for Bump version: 0.7.3 -> 0.8.0 Docker Image CI #199 :

#7 22.87   Stored in directory: /root/.cache/pip/wheels/3c/de/35/2cbb99955fa449eeddb2b433b4369035ee5bdf0fc121035ffe
#7 22.87 Successfully built yamlfixer-opt-nc yamllint pyyaml
#7 22.88 Installing collected packages: pyyaml, pathspec, yamllint, yamlfixer-opt-nc
#7 23.07 Successfully installed pathspec-0.9.0 pyyaml-6.0 yamlfixer-opt-nc-0.7.3 yamllint-1.26.3
#7 23.07 WARNING: Running pip as the 'root' user can result in broken permissions and conflicting behaviour with the system package manager. It is recommended to use a virtual environment instead: https://pip.pypa.io/warnings/venv
#7 DONE 23.3s

📑 Steps to Reproduce

Steps to reproduce the behavior:

Do a release

2️⃣ Expected behavior

Version of yamlfixer in docker image should be the same as the one just released.

❔ Context

Fig is terminal that gains everyday in popularity, hence it would be cool to get a dedicated completion for yamlfixer

🎯 Target

Explain what do you expect from this issue.

💰 Gains

• Ease of use and UX
• Popularity

❔ Context

Neither GitHub Actions, nor it seems Docker, provide a tty to commands, making yamlfixer unnecessarily read input from stdin.

🎯 Target

Check if the implemented workaround works.

💰 Gains

• Stopping work on fixing this problem.

⚠️ Risks

• Keeping this problem

❔ Context

As a long term contriutor to schemacrawler it would be interesting to make some connections between these two community driven projects.

🎯 Target

Explain what do you expect from this issue.

If appliable, ask for some standard conf files that rely on yaml.

💰 Gains

What are the gains of implementing this issue for this project.

• Make bridged between our projects
• make it possible to lint and fix conf files withing shemacrawler and then make support process easier for schemacrawel
• get more resources in the examples dir

⚠️ Risks

What are the risks if we don't implement this issue.

• N/A