generate_config_file.py

View code on Github

Functionality to generate a configuration file for i18n-check.

i18n_check.cli.generate_config_file.config_file_is_valid() bool[source]

Check that the configuration file for i18n-check is not empty and has the necessary keys.

Returns:
bool

True if the i18n-check configuration file is valid. False otherwise.

i18n_check.cli.generate_config_file.write_to_file(src_dir: str, i18n_dir: str, i18n_src_file: str, file_types_to_check: list[str] | None, checks: Dict[str, dict]) None[source]

Writing to the i18n source JSON file.

Parameters:
src_dirstr

Input src dir directory.

i18n_dirstr

Input i18n-dir directory.

i18n_src_filestr

Input i18n-dir-src directory.

file_types_to_checklist[str]

Input file extensions for checks.

checksdict

The boolean values for checks being enabled or not.

i18n_check.cli.generate_config_file.receive_data() None[source]

Interact with user to configure a .yml file.

i18n_check.cli.generate_config_file.generate_config_file() None[source]

Generate a configuration file for i18n-check based on user inputs.