ProfessionalWiki / SimpleBatchUpload

Checkout Config

build:
    # The build contains everything related to running test, deployment and analysis commands.
    services:
        mariadb: 10

    dependencies:
        override:
            - true     # do not install any dependencies
    tests:
        override:
            - ~/build/tests/setup/run-tests.sh

    nodes:
        code-analysis-and-test-mw-master:
            environment:
                php: 7.3
                variables:
                    MW: master
                    SBU: composer
            tests:
                override:
                    -   command: ~/build/tests/setup/run-tests.sh --coverage-clover ~/coverage.xml
                        coverage:
                            file: ~/coverage.xml
                            format: clover
                    -   command: phpcs-run
                        use_website_config: true
                    - php-scrutinizer-run --enable-security-analysis
        test-mw-min-version:
            environment:
                php: 7.0
                variables:
                    MW: 1.31.0
                    SBU: download
        test-mw-1.31:
            environment:
                php: 7.1
                variables:
                    MW: 1.31.3
                    SBU: composer
        test-mw-1.32:
            environment:
                php: 7.2
                variables:
                    MW: 1.32.3
                    SBU: download
        test-mw-1.33:
            environment:
                php: 7.2
                variables:
                    MW: 1.33.0
                    SBU: download

filter:
# The filter section defines which files are analyzed, where dependencies are located and which files should be completely ignored.
    dependency_paths:
        - mw
    excluded_paths:
        - mw/extensions

build_failure_conditions: {}
# The build failure conditions section allows you to define failure conditions where a build should be failed based on findings in the analysis.
# Findings can be that code coverage has decreased below a certain point, or that new issues have been found, etc.

Global Config

checks:
    php:
        parameters_in_camelcaps: true
        properties_in_camelcaps: true
        no_goto: true
        return_doc_comments: true
        parameter_doc_comments: true
        param_doc_comment_if_not_inferrable: true
        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)'
        more_specific_types_in_doc_comments: true
        check_method_contracts:
            verify_interface_like_constraints: true
            verify_documented_constraints: true
            verify_parent_constraints: true
    javascript:
        no_else_return: true
        no_alert: true
        eqeqeq: true
        no_loop_var_assign: true

coding_style:
    php:
        indentation:
            general:
                use_tabs: true
        spaces:
            around_operators:
                concatenation: true
            within:
                brackets: true
                array_initializer: true
                grouping: true
                function_call: true
                function_declaration: true
                if: true
                for: true
                while: true
                switch: true
                catch: true
        braces:
            classes_functions:
                class: end-of-line
                function: end-of-line
                closure: end-of-line
            if:
                opening: end-of-line
            for:
                opening: end-of-line
            while:
                opening: end-of-line
            do_while:
                opening: end-of-line
            switch:
                opening: end-of-line
            try:
                opening: end-of-line
        upper_lower_casing:
            keywords:
                general: lower
            constants:
                true_false_null: lower