Skip to content

Commit 6d35639

Browse files
committed
feature #11274 initial setup for liniting the Documentation (OskarStark)
This PR was merged into the 3.4 branch. Discussion ---------- initial setup for liniting the Documentation <!-- If your pull request fixes a BUG, use the oldest maintained branch that contains the bug (see https://symfony.com/roadmap for the list of maintained branches). If your pull request documents a NEW FEATURE, use the same Symfony branch where the feature was introduced (and `master` for features of unreleased versions). --> Commits ------- f671fce initial DOCtor-RST setup.
2 parents 48f963b + f671fce commit 6d35639

File tree

2 files changed

+85
-0
lines changed

2 files changed

+85
-0
lines changed

.doctor-rst.yaml

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
rules:
2+
no_inheritdoc: ~
3+
avoid_repetetive_words: ~
4+
blank_line_after_directive: ~
5+
short_array_syntax: ~
6+
no_app_console: ~
7+
typo: ~
8+
replacement: ~
9+
composer_dev_option_not_at_the_end: ~
10+
yarn_dev_option_at_the_end: ~
11+
versionadded_directive_should_have_version: ~
12+
deprecated_directive_should_have_version: ~
13+
no_composer_req: ~
14+
no_php_open_tag_in_code_block_php_directive: ~
15+
no_blank_line_after_filepath_in_php_code_block: ~
16+
no_blank_line_after_filepath_in_yaml_code_block: ~
17+
no_blank_line_after_filepath_in_xml_code_block: ~
18+
no_blank_line_after_filepath_in_twig_code_block: ~
19+
php_prefix_before_bin_console: ~
20+
use_deprecated_directive_instead_of_versionadded: ~
21+
no_space_before_self_xml_closing_tag: ~
22+
no_explicit_use_of_code_block_php: ~
23+
ensure_order_of_code_blocks_in_configuration_block: ~
24+
american_english: ~
25+
valid_use_statements: ~
26+
lowercase_as_in_use_statements: ~
27+
ordered_use_statements: ~
28+
no_namespace_after_use_statements: ~
29+
correct_code_block_directive_based_on_the_content: ~
30+
max_blank_lines:
31+
max: 2
32+
replace_code_block_types: ~
33+
use_https_xsd_urls: ~
34+
blank_line_before_directive: ~
35+
extension_xlf_instead_of_xliff: ~
36+
valid_inline_highlighted_namespaces: ~
37+
indention: ~
38+
unused_links: ~
39+
40+
# 3.4
41+
versionadded_directive_major_version:
42+
major_version: 3
43+
44+
versionadded_directive_min_version:
45+
min_version: '3.0'
46+
47+
# do not report as violation
48+
whitelist:
49+
regex:
50+
- '/FOSUserBundle(.*)\.yml/'
51+
- '/``.yml``/'
52+
- '/(.*)\.orm\.yml/' # currently DoctrineBundle only supports .yml
53+
lines:
54+
- 'in config files, so the old ``app/config/config_dev.yml`` goes to'
55+
- '#. The most important config file is ``app/config/services.yml``, which now is'
56+
- 'code in production without a proxy, it becomes trivially easy to abuse your'
57+
- '.. _`EasyDeployBundle`: https://github.com/EasyCorp/easy-deploy-bundle'
58+
- 'The bin/console Command'
59+
- '# username is your full Gmail or Google Apps email address'
60+
- '.. _`LDAP injection`: http://projects.webappsec.org/w/page/13246947/LDAP%20Injection'
61+
- '.. versionadded:: 0.21.0' # Encore
62+
- '.. versionadded:: 2.4.0' # SwiftMailer
63+
- '.. versionadded:: 1.26' # Twig
64+
- '.. versionadded:: 1.30' # Twig
65+
- '.. versionadded:: 1.2' # MakerBundle
66+
- '.. versionadded:: 1.11' # MakerBundle
67+
- '.. versionadded:: 1.3' # MakerBundle
68+
- '.. versionadded:: 1.8' # MakerBundle
69+
- '0 => 123' # assertion for var_dumper - components/var_dumper.rst
70+
- '1 => "foo"' # assertion for var_dumper - components/var_dumper.rst
71+
- '$var .= "Because of this `\xE9` octet (\\xE9),\n";'
72+
- "`Deploying Symfony 4 Apps on Heroku`_."
73+
- ".. _`Deploying Symfony 4 Apps on Heroku`: https://devcenter.heroku.com/articles/deploying-symfony4"

.github/workflows/lint.yaml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
on: push
2+
name: Lint
3+
jobs:
4+
doctor-rst:
5+
name: DOCtor-RST
6+
runs-on: ubuntu-latest
7+
steps:
8+
- uses: actions/checkout@master
9+
- name: DOCtor-RST
10+
uses: docker://oskarstark/doctor-rst
11+
with:
12+
args: --short

0 commit comments

Comments
 (0)