rougail-output-ansible/src/rougail/output_ansible/config.py

"""
Silique (https://www.silique.fr)
Copyright (C) 2024

This program is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
details.

You should have received a copy of the GNU Lesser General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
"""

from pathlib import Path


def get_rougail_config(
    *,
    backward_compatibility=True,
) -> dict:
    options = """
list:
  description:  parameter added only to be compatible with Ansible
  negative_description:  parameter added only to be compatible with Ansible
  default: false
  disabled:
    type: jinja
    jinja: |
      {% if step.output != 'ansible' %}
      disabled
      {% endif %}

json:
  redefine: true
  disabled:
    type: jinja
    jinja: |
      {% if step.output != 'json' and step.output != 'ansible' %}
      disabled
      {% endif %}

ansible:
  description: Configuration of output Ansible
  disabled:
    variable: step.output
    when_not: ansible

  host_namespace:
    description: Namespace with host values
    default: "hosts"
"""
    return {
        "name": "ansible",
        "process": "output",
        "options": options,
        "level": 60,
    }


__all__ = ("get_rougail_config",)