summaryrefslogtreecommitdiffstats
path: root/vendor/stripe/stripe-php/.php-cs-fixer.php
blob: 6d282983accaae00a9e3723f05a15f7666358f94 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
<?php

$finder = PhpCsFixer\Finder::create()
    ->notPath('tests/TestCase.php');

$config = new PhpCsFixer\Config();
$config->setRiskyAllowed(true);
$config->setRules([
    // Rulesets
    '@PSR2' => true,
    '@PhpCsFixer' => true,
    '@PhpCsFixer:risky' => true,
    '@PHP56Migration:risky' => true,
    '@PHPUnit57Migration:risky' => true,

    // Additional rules
    'fopen_flags' => true,
    'linebreak_after_opening_tag' => true,
    // This one is non-deterministic based on what environment you are running it in and what `get_defined_constants` returns.
    'native_constant_invocation' => false,
    'native_function_invocation' => [
        "strict" => false,
    ],

    // --- Diffs from @PhpCsFixer / @PhpCsFixer:risky ---

    // This is the same as the default for the @PhpCsFixer ruleset, minus
    // the following values: ['include', 'include_once', 'require',
    // 'require_once']. We could enable them and remove this line after
    // updating codegen for the `init.php` file to be compliant.
    'blank_line_before_statement' => ['statements' => ['break', 'case', 'continue', 'declare', 'default', 'exit', 'goto', 'return', 'switch', 'throw', 'try']],

    // This is just prettier / easier to read.
    'concat_space' => ['spacing' => 'one'],

    // This causes strange ordering with codegen'd classes. We might be
    // able to enable this if we update codegen to output class elements
    // in the correct order.
    'ordered_class_elements' => false,

    // Keep this disabled to avoid unnecessary diffs in PHPDoc comments of
    // codegen'd classes.
    'phpdoc_align' => false,

    // This is a "risky" rule that causes a bug in our codebase.
    // Specifically, in `StripeObject.updateAttributes` we construct new
    // `StripeObject`s for metadata. We can't use `self` there because it
    // needs to be a raw `StripeObject`.
    'self_accessor' => false,

    // Visibility annotations are not supported by php5.6
    'visibility_required' => false,

    // Apparently "uninitialized" is distinct from "null" in some versions of PHP
    // so I am defensively disabling this rule so as to not cause breaking changes
    // but we can feel free to remove it in a major version (or maybe in a minor if
    // we devote some effort into determining that it is safe)
    'no_null_property_initialization' => false,

    // We have to support `@return void` to satisfy Symfony deprecations helper.
    // See https://github.com/stripe/stripe-php/pull/1230
    'phpdoc_no_empty_return' => false,
]);
$config->setFinder($finder);
return $config;