symfony-docs/.doctor-rst.yaml at 7.4 · symfony/symfony-docs · GitHub

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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
rules:
    american_english: ~
    avoid_repetetive_words: ~
    blank_line_after_anchor: ~
    blank_line_after_directive: ~
    blank_line_before_directive: ~
    composer_dev_option_not_at_the_end: ~
    correct_code_block_directive_based_on_the_content: ~
    deprecated_directive_should_have_version: ~
    ensure_attribute_between_backticks_in_content: ~
    ensure_bash_prompt_before_composer_command: ~
    ensure_class_constant: ~
    ensure_correct_format_for_phpfunction: ~
    ensure_exactly_one_space_before_directive_type: ~
    ensure_exactly_one_space_between_link_definition_and_link: ~
    ensure_explicit_nullable_types: ~
    ensure_github_directive_start_with_prefix:
        prefix: 'Symfony'
    ensure_link_bottom: ~
    ensure_link_definition_contains_valid_url: ~
    ensure_order_of_code_blocks_in_configuration_block: ~
    ensure_php_reference_syntax: ~
    extend_abstract_controller: ~
    filepath_and_namespace_should_match:
        namespace_mapping:
            'src/': 'App\'
            'tests/': 'App\Tests\'
        ignored_namespaces:
            - '/^Acme/'
            - '/^Shared/'
        ignored_paths:
            - '/^config\//'
            - '/^example\.com\//'
            - '/^apps\/api\/tests\//'
    # extension_xlf_instead_of_xliff: ~
    forbidden_directives:
        directives:
            - '.. index::'
            - directive: '.. caution::'
              replacements: ['.. warning::', '.. danger::']
    indention: ~
    lowercase_as_in_use_statements: ~
    max_blank_lines:
        max: 2
    max_colons: ~
    no_app_console: ~
    no_attribute_redundant_parenthesis: ~
    no_blank_line_after_filepath_in_php_code_block: ~
    no_blank_line_after_filepath_in_twig_code_block: ~
    no_blank_line_after_filepath_in_xml_code_block: ~
    no_blank_line_after_filepath_in_yaml_code_block: ~
    no_brackets_in_method_directive: ~
    no_broken_ref_directive: ~
    no_composer_req: ~
    no_directive_after_shorthand: ~
    no_duplicate_use_statements: ~
    no_empty_directive: ~
    no_empty_literals: ~
    no_explicit_use_of_code_block_php: ~
    no_footnotes: ~
    no_inheritdoc: ~
    no_merge_conflict: ~
    no_namespace_after_use_statements: ~
    no_non_breaking_space: ~
    no_php_open_tag_in_code_block_php_directive: ~
    no_relative_doc_path: ~
    no_space_before_self_xml_closing_tag: ~
    no_typographic_quotes: ~
    non_static_phpunit_assertions: ~
    only_backslashes_in_namespace_in_php_code_block: ~
    only_backslashes_in_use_statements_in_php_code_block: ~
    ordered_use_statements: ~
    php_prefix_before_bin_console: ~
    remove_trailing_whitespace: ~
    replace_code_block_types: ~
    replacement: ~
    short_array_syntax: ~
    space_between_label_and_link_in_doc: ~
    space_between_label_and_link_in_ref: ~
    string_replacement: ~
    title_underline_length_must_match_title_length: ~
    typo: ~
    unused_links: ~
    use_deprecated_directive_instead_of_versionadded: ~
    use_double_backticks_for_inline_literals: ~
    use_named_constructor_without_new_keyword_rule: ~
    use_https_xsd_urls: ~
    valid_inline_highlighted_namespaces: ~
    valid_use_statements: ~
    versionadded_directive_should_have_version: ~
    yaml_instead_of_yml_suffix: ~

    versionadded_directive_major_version:
        major_version: 7

    versionadded_directive_min_version:
        min_version: '7.0'

    deprecated_directive_major_version:
        major_version: 7

    deprecated_directive_min_version:
        min_version: '7.0'

exclude_rule_for_file:
    - path: configuration/multiple_kernels.rst
      rule_name: replacement
    - path: page_creation.rst
      rule_name: no_php_open_tag_in_code_block_php_directive
    - path: frontend/create_ux_bundle.rst
      rule_name: argument_variable_must_match_type
    - path: contributing/documentation/format.rst
      rule_name: no_relative_doc_path
    - path: components/phpunit_bridge.rst
      rule_name: indention

# do not report as violation
whitelist:
    regex:
        - '/``.yml``/'
        - '/(.*)\.orm\.yml/' # currently DoctrineBundle only supports .yml
    lines:
        - 'in config files, so the old ``app/config/config_dev.yml`` goes to'
        - '#. The most important config file is ``app/config/services.yml``, which now is'
        - 'The bin/console Command'
        - '.. _`LDAP injection`: http://projects.webappsec.org/w/page/13246947/LDAP%20Injection'
        - '.. versionadded:: 2.8.0' # Doctrine
        - '.. versionadded:: 1.9.0' # Encore
        - '.. versionadded:: 1.18' # Flex in setup/upgrade_minor.rst
        - '.. versionadded:: 1.0.0' # Encore
        - '.. versionadded:: 2.7.1' # Doctrine
        - '123,' # assertion for var_dumper - components/var_dumper.rst
        - '"foo",' # assertion for var_dumper - components/var_dumper.rst
        - '$var .= "Because of this `\xE9` octet (\\xE9),\n";'
        - '.. versionadded:: 0.2' # MercureBundle
        - '.. versionadded:: 3.6' # MonologBundle
        - '.. versionadded:: 3.8' # MonologBundle
        - '.. versionadded:: 3.5' # Monolog
        - '.. versionadded:: 3.0' # Doctrine ORM
        - '.. _`a feature to test applications using Mercure`: https://github.com/symfony/panther#creating-isolated-browsers-to-test-apps-using-mercure-or-websocket'
        - 'End to End Tests (E2E)'
        - '.. versionadded:: 2.2.0' # Panther
        - '* Inline code blocks use double-ticks (````like this````).'
        - 'the `HTML5 color format`_ (``/^#[0-9a-f]{6}$/i``). If it doesn''t match it,'
        - '.. deprecated:: 2.29' # UX TogglePassword
        - '.. versionadded:: 3.11.0' # MonologBundle