rougail-cli/src/rougail/cli/config.py

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

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 .i18n import _


def get_rougail_config(
    *,
    backward_compatibility: bool = True,  # pylint: disable=unused-argument
) -> dict:
    options = f"""
cli:
  description: {_('Command line options')}

  config_file:
    description: {_('Loads command line parameters from a file')}
    type: unix_filename
    commandline: false
    params:
      allow_relative: true
    default: .rougailcli.yml

  debug: false  # {_('Displays debug informations')}

  warnings: true  # {_('Displays command line option warnings informations')}

  versions: false  # {_('Displays Rougail version and all its components')}

  load_config:
    default: true
    hidden: true

  read_write: false  # {_('Configuration in output step is in read_write mode')}
"""
    return {
        "options": options,
        "process": None,
    }