.coafile

[Default]
files = *.py, coalib/**/*.py, ./coala, tests/**/*.py, docs/conf.py
ignore =
    tests/bearlib/languages/documentation/documentation_extraction_testdata/*.py,
    tests/collecting/collectors_test_dir/bears/incorrect_bear.py,

max_line_length = 80
use_spaces = True

[python]
# Patches may conflict with autopep8 so putting them in own section so they
# will be executed sequentially; also we need the LineLengthBear to double
# check the line length because PEP8Bear sometimes isn't able to correct the
# linelength.
bears = SpaceConsistencyBear, QuotesBear
language = Python
preferred_quotation = '

default_actions = *: ApplyPatchAction

[flakes]
# Do not set default_action to ApplyPatchAction as it may lead to some
# required imports being removed that might result in coala behaving weirdly.

default_action: *: ShowPatchAction

bears = PyUnusedCodeBear
language = Python
remove_all_unused_imports = true

[autopep8]
bears = PEP8Bear, PycodestyleBear
pycodestyle_ignore = E303, E121, E123, E126, E133, E226, E241, E242, E704, W503

default_actions = PEP8Bear: ApplyPatchAction

[linelength]  # Sometimes autopep8 makes too long lines, need to check after!
bears = LineLengthBear
ignore_length_regex = ^.*https?://

[DOCS]
bears = SpaceConsistencyBear, LineLengthBear

files = docs/**/*.rst, CONTRIBUTING.rst, README.rst
ignore = docs/API/**
ignore_length_regex = ^.*https?://

default_actions = SpaceConsistencyBear: ApplyPatchAction

[languagetool]
enabled = False

bears = LanguageToolBear
files = docs/**/*.rst, CONTRIBUTING.rst, README.rst
ignore = docs/API/**
languagetool_disable_rules =
    EN_QUOTES,                          # `` for links in rst files
    WHITESPACE_RULE,                    # Indents in code
    UPPERCASE_SENTENCE_START,           # Sentences start with "coala"
    COMMA_PARENTHESIS_WHITESPACE,       # Confuses .coafile
    DOUBLE_PUNCTUATION,                 # Used in `.. note::`
    SENTENCE_WHITESPACE,                # Thinks coalib.xyz should have space
    THE_PUNCT,                          # Confused by symbols in code
    EN_A_VS_AN,                         # Mistakes variable `a` to be an article
    EN_UNPAIRED_BRACKETS,               # Confused with brackets in code
    ENGLISH_WORD_REPEAT_BEGINNING_RULE, # Confuses itself in regex
    CD_NN,                              # index -> indices
    SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA,
    SENTENCE_FRAGMENT,                  # Thinks headings are sentences
    ENGLISH_WORD_REPEAT_RULE,           # Found in code
    POSSESIVE_APOSTROPHE                # Confused by directory name "objects"

[commit]
bears = GitCommitBear
shortlog_trailing_period = False
shortlog_regex = ([^:]*|[^:]+[^ ]: [A-Z0-9*].*)

[Pylint]
enabled = False

bears = PyLintBear

pylint_cli_options = --ignore\=CVS,cindex.py,tests
pylint_disable = missing-docstring, # Lots of functions don't need docstrings
                 arguments-differ, # Some child classes need to change
                                   # argument signature of a inherited function
                 bad-builtin, # Pylint doesn't like most builting functions
                              # like filter, map etc. It prefers using for
                              # loops for everything - although sometimes
                              # map and other builtins are more intuitive.
                 fixme, # Already done using KeywordBear
                 locally-disabled, # Without this a pylint pragma is also
                                   # considered an issue
                 no-member, # Currently Pylint doesn't understand our enum()
                            # making a lot of false positives here
                 bad-continuation # Our indentation style guide is
                                  # different from PEP

[LineCounting]
enabled = False

bears = LineCountBear
max_lines_per_file = 1000

[invalidlinks]
enabled = False
files = docs/**/*.rst
ignore = docs/API
bears = InvalidLinkBear

[css]
bears = CSSLintBear
files = docs/_static/**.css

[rst]
bears = reSTLintBear
files = README.rst

[text]
bears = SpaceConsistencyBear
files =
    LICENSE, ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE.md, MANIFEST.in,
    **.sh, .travis.yml, circle.yml, setup.cfg, ./docs/_static/custom.css
ignore = node_modules/**

[TODOS]
enabled = False

bears = KeywordBear
language = python 3

ci_keywords, keywords = \#TODO, \# TODO, \#FIXME, \# FIXME
cs_keywords =

[urllib]
# Encourage usage of requests library by blacklisting usage of urlopen()
bears = KeywordBear
language = python 3
keywords = urlopen