richdynamix / magestead

Repository Config

checks:
    php:
        uppercase_constants: true
        simplify_boolean_return: true
        use_self_instead_of_fqcn: true
        return_doc_comments: true
        prefer_while_loop_over_for_loop: true
        parameters_in_camelcaps: true
        no_short_variable_names:
            minimum: '3'
        optional_parameters_at_the_end: true
        no_short_method_names:
            minimum: '3'
        line_length:
            max_length: '120'
        naming_conventions:
            local_variable: '^[a-z][a-zA-Z0-9]*$'
            abstract_class_name: ^Abstract|Factory$
            utility_class_name: 'Utils?$'
            constant_name: '^[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*$'
            property_name: '^[a-z][a-zA-Z0-9]*$'
            method_name: '^(?:[a-z]|__)[a-zA-Z0-9]*$'
            parameter_name: '^[a-z][a-zA-Z0-9]*$'
            interface_name: '^[A-Z][a-zA-Z0-9]*Interface$'
            type_name: '^[A-Z][a-zA-Z0-9]*$'
            exception_name: '^[A-Z][a-zA-Z0-9]*Exception$'
            isser_method_name: '^(?:is|has|should|may|supports)'
        function_in_camel_caps: true
        encourage_single_quotes: true
        classes_in_camel_caps: true
        avoid_unnecessary_concatenation: true
        avoid_todo_comments: true
        avoid_perl_style_comments: true
        avoid_multiple_statements_on_same_line: true
        avoid_fixme_comments: true
        align_assignments: true

coding_style:
    php:
        braces:
            classes_functions:
                class: new-line
                function: end-of-line
        upper_lower_casing:
            keywords:
                general: lower
            constants:
                true_false_null: upper