bears.natural_language.MarkdownBear

Complexity

Total Complexity

2

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

2 Methods

Rating	Name	Duplication	Size	Complexity
A	config_file()	0	2	1
B	run()	0	38	1

import json

from coalib.bearlib.abstractions.Lint import Lint
from coalib.bears.LocalBear import LocalBear


class MarkdownBear(Lint, LocalBear):
    executable = 'remark'
    diff_message = "The text does not comply to the set style."
    arguments = '-c {config_file}'
    gives_corrected = True
    use_stdin = True

    def config_file(self):
        return json.dumps(self.remark_configs).splitlines(keepends=True)

    def run(self, filename, file,
            markdown_bullets: str="-",
            markdown_use_closed_headings: bool=False,
            markdown_use_setext_headings: bool=False,
            markdown_emphasis: str="_",
            markdown_strong: str="*",
            markdown_encode_entities: bool=False,
            markdown_codefence: str="`",
            markdown_usefences: bool=False,
            markdown_list_indent: str="tab",
            markdown_loose_tables: bool=False,
            markdown_spaced_tables: bool=True,
            markdown_list_increment: bool=True,
            markdown_horizontal_rule: str='*',
            markdown_horizontal_rule_spaces: bool=False,
            markdown_horizontal_rule_repeat: int=3):
        """
        Raises issues against style violations on markdown files.
        """
        self.remark_configs = {
            "bullet": markdown_bullets,                        # Bool
            "closeAtx": markdown_use_closed_headings,          # Bool
            "setext": markdown_use_setext_headings,            # Bool
            "emphasis": markdown_emphasis,                     # char (_ or *)
            "strong": markdown_strong,                         # char (_ or *)
            "entities": markdown_encode_entities,              # Bool
            "fence": markdown_codefence,                       # char (~ or `)
            "fences": markdown_usefences,                      # Bool
            "listItemIndent": markdown_list_indent,            # int or "tab"
                                                               # or "mixed"
            "looseTable": markdown_loose_tables,               # Bool
            "spacedTable": markdown_spaced_tables,             # Bool
            "incrementListMarker": markdown_list_increment,    # Bool
            "rule": markdown_horizontal_rule,                  # - or * or _
            "ruleSpaces": markdown_horizontal_rule_spaces,     # Bool
            "ruleRepetition": markdown_horizontal_rule_repeat, # int
        }
        return self.lint(filename, file)