NAME

CPAN::Testers::Common::Client::Config - auxiliary functions for setting up CPAN Testers clients

WARNING!!!

This is a *very* early module and an EXPERIMENTAL one for that matter. The API WILL CHANGE. We're still moving stuff around, so please only use it if you understand and accept the consequences.

If you have any questions, please contact the author.

FUNCTIONS

get_config_dir()

The base directory in which your 'config.ini' and other files reside. Defaults to the '.cpantesters' directory under your home directory (if you're using Linux or OS X) or under the 'my documents' folder (if you're running Windows).

get_config_filename()

Returns the full path for the 'config.ini' file.

config_spec()

Return the full config specification structure, containing available keys and their associated data, including validators and (suggested) default values.

generate_profile( $id_file, $config )

This function runs 'metabase-profile' automatically for you. It receives as arguments $id_file, which is the name of the target metabase id file; and $config, which is a hashref of the user's 'config.ini' file.

grade_action_prompt()

Describes grade:action pairs

is_valid_action( $action_str )

Returns true when an action string is valid for grade:action pairs.

is_valid_grade( $grade_str )

Returns true when a grade string is valid for grade_action pairs.

CONFIGURATION AND ENVIRONMENT

  • PERL_CPAN_REPORTER_DIR

    Overrides the value for get_config_dir().

  • PERL_CPAN_REPORTER_CONFIG

    Overrides the value for get_config_filename().