rougail-user-data-questionary/src/rougail/user_data_questionary/config.py

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

distribued with GPL-2 or later license

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
"""

from .i18n import _


def get_rougail_config(
    *,
    backward_compatibility=True,
) -> dict:
    """generate rougail config"""
    options = f"""
questionary:
  description: {_("Define user data interactively in the console")}
  help: {_("The user will enter variable values in a command-line interface. The variables will be displayed one after another, allowing the user to change or add values.")}
  disabled:
    jinja: >-
      {{{{ step.user_data is not propertyerror or 'questionary' not in step.user_data }}}}
    return_type: boolean
    description: {_('if questionary is not set in "step.user_data"')}

  mandatory:
    description: {_("Ask values only for mandatories variables without any value")}
    alternative_name: qm
    default: false

  show_secrets:
    description: {_("Show secrets instead of obscuring them")}
    alternative_name: qs
    type: boolean
    default: false
"""
    return {
        "name": "questionary",
        "process": "user data",
        "options": options,
        "level": 60,
    }


__all__ = ("get_rougail_config",)