How do blank_line_after_opening_tag and linebreak_after_opening_tag work in Pint?

[mloru]

I have a set of rules that I use with PHP-CS-Fixer, and they include these two:

 'blank_line_after_opening_tag' => false,
 'linebreak_after_opening_tag' => false,

So, the first line of my php files looks like this:

<?php declare(strict_types=1);

I tried to port my set of rules to Pint, so they result in:

 "blank_line_after_opening_tag": false,
 "linebreak_after_opening_tag": false,

but I am not able to reproduce the same behavior as PHP-CS-Fixer, since this results in:

<?php

declare(strict_types=1);

Am I missing something?

[ahmett]

I tried the example case in a fresh install of Laravel 10; it worked as expected. The configuration I tested is down below. Maybe there are conflicts with other rules or preset (if there are any).

pint.json (Preset is optionally used in this config. It will work either way correctly.)

{
    "preset": "laravel",
    "rules": {
        "blank_line_after_opening_tag": false,
        "linebreak_after_opening_tag": false
    }
}

Also, have you tried directly passing the configuration to the Pint?

pint --config vendor/my-company/coding-style/pint.json

If it still isn't working, can you share some details about your app so we can investigate the problem further?

[mloru]

@ahmett thanks for your heads up.
I did some trial and error and you're right: using the configuration you provided doesn't mess up the first lines in my files (i.e. it keeps the opening PHP tag and the declare(strict types=1); instruction on the same line). But then I kept investigating.
This is my whole config file (ported from the configuration I use on PHP-CS-Fixer):

{
    "preset": "laravel",
    "rules": {
        "@Symfony": true,
        "@Symfony:risky": true,
        "@PHP71Migration": true,
        "@PHP71Migration:risky": true,
        "@PHPUnit75Migration:risky": true,
        "@DoctrineAnnotation": true,
        "blank_line_after_opening_tag": false,
        "combine_consecutive_unsets": true,
        "concat_space": {
            "spacing": "one"
        },
        "linebreak_after_opening_tag": false,
        "mb_str_functions": true,
        "native_function_invocation": false,
        "no_superfluous_phpdoc_tags": false,
        "no_useless_else": true,
        "no_useless_return": true,
        "not_operator_with_space": true,
        "ordered_imports": {
            "imports_order": [
                "class",
                "function",
                "const"
            ],
            "sort_algorithm": "alpha"
        },
        "php_unit_strict": true,
        "phpdoc_align": true,
        "phpdoc_add_missing_param_annotation": {
            "only_untyped": false
        },
        "phpdoc_no_empty_return": false,
        "phpdoc_order": true,
        "phpdoc_separation": false,
        "phpdoc_to_comment": false,
        "phpdoc_var_without_name": false,
        "self_accessor": false,
        "single_import_per_statement": false,
        "single_trait_insert_per_statement": false,
        "strict_comparison": true,
        "strict_param": true,
        "yoda_style": false,
        "php_unit_test_annotation": {
            "style": "annotation"
        },
        "global_namespace_import": {
            "import_classes": true,
            "import_constants": true,
            "import_functions": true
        },
        "binary_operator_spaces": {
            "operators": {
                "|": null
            }
        },
        "php_unit_method_casing": false
    }
}

It turns out that running Pint with this configuration messes up my <?php declare(strict_types=1); instructions. If I revert the changes to the code, remove the "@Symfony": true rule and run Pint again, I have the effect I'm looking for.
But if I add it again, run Pint (so that my first lines get messed up), then I remove "@Symfony": true and run it again, the empty line between the opening tag and the declare instruction does not go away.
It looks like a strange behavior to me, am I missing something?

[ahmett]

@mloru Yes, the @Symfony ruleset includes the blank_line_after_opening_tag and linebreak_after_opening_tag rules and it's overriding your definition. You can check this from here.

Here is a quick fix for you:

Use this tool to export all rules from the @Syfmony ruleset. (Ensure you set the JSON format and select expand presets option when exporting the rule list.)

In your pint.json, replace the @Symfony ruleset definition with its expanded rules and delete the conflicting rules inside the expanded ruleset.

The final file should look like this:

(I know it looks verbose, but currently, that's the only workaround without touching the keyboard.)

{
  "preset": "laravel",
  "rules": {
    "array_syntax": true,
    "backtick_to_shell_exec": true,
    "binary_operator_spaces": {
      "operators": {
        "|": null
      }
    },
    "blank_line_after_namespace": true,
    "blank_line_after_opening_tag": false,
    "blank_line_before_statement": {
      "statements": [
        "return"
      ]
    },
    "blank_line_between_import_groups": true,
    "braces": {
      "allow_single_line_anonymous_class_with_empty_body": true,
      "allow_single_line_closure": true
    },
    "cast_spaces": true,
    "class_attributes_separation": {
      "elements": {
        "method": "one"
      }
    },
    "class_definition": {
      "single_line": true
    },
    "class_reference_name_casing": true,
    "clean_namespace": true,
    "compact_nullable_typehint": true,
    "concat_space": {
      "spacing": "one"
    },
    "constant_case": true,
    "declare_equal_normalize": true,
    "echo_tag_syntax": true,
    "elseif": true,
    "empty_loop_body": {
      "style": "braces"
    },
    "empty_loop_condition": true,
    "encoding": true,
    "full_opening_tag": true,
    "fully_qualified_strict_types": true,
    "function_declaration": true,
    "function_typehint_space": true,
    "general_phpdoc_tag_rename": {
      "replacements": {
        "inheritDocs": "inheritDoc"
      }
    },
    "global_namespace_import": {
      "import_classes": true,
      "import_constants": true,
      "import_functions": true
    },
    "include": true,
    "increment_style": true,
    "indentation_type": true,
    "integer_literal_case": true,
    "lambda_not_used_import": true,
    "line_ending": true,
    "linebreak_after_opening_tag": false,
    "lowercase_cast": true,
    "lowercase_keywords": true,
    "lowercase_static_reference": true,
    "magic_constant_casing": true,
    "magic_method_casing": true,
    "method_argument_space": {
      "on_multiline": "ignore"
    },
    "native_function_casing": true,
    "native_function_type_declaration_casing": true,
    "new_with_braces": true,
    "no_alias_language_construct_call": true,
    "no_alternative_syntax": true,
    "no_binary_string": true,
    "no_blank_lines_after_class_opening": true,
    "no_blank_lines_after_phpdoc": true,
    "no_break_comment": true,
    "no_closing_tag": true,
    "no_empty_comment": true,
    "no_empty_phpdoc": true,
    "no_empty_statement": true,
    "no_extra_blank_lines": {
      "tokens": [
        "attribute",
        "case",
        "continue",
        "curly_brace_block",
        "default",
        "extra",
        "parenthesis_brace_block",
        "square_brace_block",
        "switch",
        "throw",
        "use"
      ]
    },
    "no_leading_import_slash": true,
    "no_leading_namespace_whitespace": true,
    "no_mixed_echo_print": true,
    "no_multiline_whitespace_around_double_arrow": true,
    "no_short_bool_cast": true,
    "no_singleline_whitespace_before_semicolons": true,
    "no_space_around_double_colon": true,
    "no_spaces_after_function_name": true,
    "no_spaces_around_offset": true,
    "no_spaces_inside_parenthesis": true,
    "no_superfluous_phpdoc_tags": false,
    "no_trailing_comma_in_singleline": true,
    "no_trailing_whitespace": true,
    "no_trailing_whitespace_in_comment": true,
    "no_unneeded_control_parentheses": {
      "statements": [
        "break",
        "clone",
        "continue",
        "echo_print",
        "others",
        "return",
        "switch_case",
        "yield",
        "yield_from"
      ]
    },
    "no_unneeded_curly_braces": {
      "namespaces": true
    },
    "no_unneeded_import_alias": true,
    "no_unset_cast": true,
    "no_unused_imports": true,
    "no_useless_concat_operator": true,
    "no_useless_nullsafe_operator": true,
    "no_whitespace_before_comma_in_array": true,
    "no_whitespace_in_blank_line": true,
    "normalize_index_brace": true,
    "object_operator_without_whitespace": true,
    "ordered_class_elements": {
      "order": [
        "use_trait"
      ]
    },
    "ordered_imports": {
      "imports_order": [
        "class",
        "function",
        "const"
      ],
      "sort_algorithm": "alpha"
    },
    "php_unit_fqcn_annotation": true,
    "php_unit_method_casing": false,
    "phpdoc_align": true,
    "phpdoc_annotation_without_dot": true,
    "phpdoc_indent": true,
    "phpdoc_inline_tag_normalizer": true,
    "phpdoc_no_access": true,
    "phpdoc_no_alias_tag": true,
    "phpdoc_no_package": true,
    "phpdoc_no_useless_inheritdoc": true,
    "phpdoc_order": true,
    "phpdoc_return_self_reference": true,
    "phpdoc_scalar": true,
    "phpdoc_separation": false,
    "phpdoc_single_line_var_spacing": true,
    "phpdoc_summary": true,
    "phpdoc_tag_type": {
      "tags": {
        "inheritDoc": "inline"
      }
    },
    "phpdoc_to_comment": false,
    "phpdoc_trim": true,
    "phpdoc_trim_consecutive_blank_line_separation": true,
    "phpdoc_types": true,
    "phpdoc_types_order": {
      "null_adjustment": "always_last",
      "sort_algorithm": "none"
    },
    "phpdoc_var_without_name": false,
    "protected_to_private": true,
    "return_type_declaration": true,
    "semicolon_after_instruction": true,
    "short_scalar_cast": true,
    "simple_to_complex_string_variable": true,
    "single_blank_line_at_eof": true,
    "single_blank_line_before_namespace": true,
    "single_class_element_per_statement": true,
    "single_import_per_statement": false,
    "single_line_after_imports": true,
    "single_line_comment_spacing": true,
    "single_line_comment_style": {
      "comment_types": [
        "hash"
      ]
    },
    "single_line_throw": true,
    "single_quote": true,
    "single_space_after_construct": {
      "constructs": [
        "abstract",
        "as",
        "attribute",
        "break",
        "case",
        "catch",
        "class",
        "clone",
        "comment",
        "const",
        "const_import",
        "continue",
        "do",
        "echo",
        "else",
        "elseif",
        "enum",
        "extends",
        "final",
        "finally",
        "for",
        "foreach",
        "function",
        "function_import",
        "global",
        "goto",
        "if",
        "implements",
        "include",
        "include_once",
        "instanceof",
        "insteadof",
        "interface",
        "match",
        "named_argument",
        "namespace",
        "new",
        "open_tag_with_echo",
        "php_doc",
        "php_open",
        "print",
        "private",
        "protected",
        "public",
        "readonly",
        "require",
        "require_once",
        "return",
        "static",
        "switch",
        "throw",
        "trait",
        "try",
        "type_colon",
        "use",
        "use_lambda",
        "use_trait",
        "var",
        "while",
        "yield",
        "yield_from"
      ]
    },
    "single_trait_insert_per_statement": false,
    "space_after_semicolon": {
      "remove_in_empty_for_expressions": true
    },
    "standardize_increment": true,
    "standardize_not_equals": true,
    "switch_case_semicolon_to_colon": true,
    "switch_case_space": true,
    "switch_continue_to_break": true,
    "ternary_operator_spaces": true,
    "trailing_comma_in_multiline": true,
    "trim_array_spaces": true,
    "types_spaces": true,
    "unary_operator_spaces": true,
    "visibility_required": true,
    "whitespace_after_comma_in_array": true,
    "yoda_style": false,
    "@Symfony:risky": true,
    "@PHP71Migration": true,
    "@PHP71Migration:risky": true,
    "@PHPUnit75Migration:risky": true,
    "@DoctrineAnnotation": true,
    "combine_consecutive_unsets": true,
    "mb_str_functions": true,
    "native_function_invocation": false,
    "no_useless_else": true,
    "no_useless_return": true,
    "not_operator_with_space": true,
    "php_unit_strict": true,
    "phpdoc_add_missing_param_annotation": {
      "only_untyped": false
    },
    "phpdoc_no_empty_return": false,
    "self_accessor": false,
    "strict_comparison": true,
    "strict_param": true,
    "php_unit_test_annotation": {
      "style": "annotation"
    }
  }
}