Skip to content

Commit

Permalink
MarkdownBear: Refactor to Linter v2 API
Browse files Browse the repository at this point in the history
  • Loading branch information
@sils
Makman2 authored and sils committed Apr 25, 2016
1 parent 5a1e155 commit 4f8c710
Showing 1 changed file with 71 additions and 78 deletions.
149 changes: 71 additions & 78 deletions bears/markdown/MarkdownBear.py
View file
Original file line number Diff line number Diff line change
@@ -1,84 +1,77 @@
import json
import re

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


class MarkdownBear(Lint, LocalBear):
executable = 'remark'
diff_message = "The text does not comply to the set style."
arguments = '--no-color --quiet'
gives_corrected = True
use_stdin = True
@linter(executable='remark',
use_stdin=True,
output_format='corrected',
diff_message='The text does not comply to the set style.')
class MarkdownBear:
"""
Raises issues against style violations on markdown files.
"""

def run(self, filename, file,
markdown_bullets: str="-",
markdown_closed_headings: bool=False,
markdown_setext_headings: bool=False,
markdown_emphasis: str="*",
markdown_strong: str="*",
markdown_encode_entities: bool=False,
markdown_codefence: str="`",
markdown_fences: bool=True,
markdown_list_indent: str="1",
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):
@staticmethod
def create_arguments(filename, file, config_file,
markdown_bullets: str="-",
markdown_closed_headings: bool=False,
markdown_setext_headings: bool=False,
markdown_emphasis: str="*",
markdown_strong: str="*",
markdown_encode_entities: bool=False,
markdown_codefence: str="`",
markdown_fences: bool=True,
markdown_list_indent: str="1",
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.
:param markdown_bullets:
Character to use for bullets in lists. Can be "-", "*" or "+".
:param markdown_closed_headings:
Whether to close Atx headings or not. if true, extra # marks will
be required after the heading. eg: `## Heading ##`.
:param markdown_setext_headings:
Whether to use setext headings. A setext heading uses underlines
instead of # marks.
:param markdown_emphasis:
Character to wrap strong emphasis by. Can be "_" or "*".
:param markdown_strong:
Character to wrap slight emphasis by. Can be "_" or "*".
:param markdown_encode_entities:
Whether to encode symbols that are not ASCII into special HTML
characters.
:param markdown_codefence:
Used to find which characters to use for code fences. Can be "`" or
"~".
:param markdown_fences:
Use fences for code blocks.
:param markdown_list_indent:
Used to find spacing after bullet in lists. Can be "1", "tab" or
"mixed".
:param markdown_bullets: Character to use for bullets
in lists. Can be "-", "*"
or "+".
:param markdown_closed_headings: Whether to close Atx headings
or not. if true, extra # marks
will be required after the
heading. eg: `## Heading ##`.
:param markdown_setext_headings: Whether to use setext headings.
A setext heading uses
underlines instead of # marks.
:param markdown_emphasis: Character to wrap strong
emphasis by. Can be "_" or "*".
:param markdown_strong: Character to wrap slight
emphasis by. Can be "_" or "*".
:param markdown_encode_entities: Whether to encode symbols that
are not ASCII into special
HTML characters.
:param markdown_codefence: Used to find which characters
to use for code fences.
Can be "`" or "~".
:param markdown_fences: Use fences for code blocks.
:param markdown_list_indent: Used to find spacing after
bullet in lists.
Can be "1", "tab" or "mixed"
- "1" - 1 space after bullet.
- "tab" - Use tab stops to
begin a sentence after the
bullet.
- "mixed" - Use "1" when the
list item is only 1 line,
"tab" if it spans multiple.
:param markdown_loose_tables: Whether to use pipes for the
outermost borders in a table.
:param markdown_spaced_tables: Whether to add space between
pipes in a table.
:param markdown_list_increment: Whether an ordered lists
numbers should be incremented.
:param markdown_horizontal_rule: The horizontal rule character.
Can be '*', '_' or '-'.
:param markdown_horizontal_rule_spaces: Whether spaces should be added
between horizontal rule
characters.
:param markdown_horizontal_rule_repeat: The number of times the
horizontal rule character will
be repeated.
- "1" - 1 space after bullet.
- "tab" - Use tab stops to begin a sentence after the bullet.
- "mixed" - Use "1" when the list item is only 1 line, "tab" if it
spans multiple.
:param markdown_loose_tables:
Whether to use pipes for the outermost borders in a table.
:param markdown_spaced_tables:
Whether to add space between pipes in a table.
:param markdown_list_increment:
Whether an ordered lists numbers should be incremented.
:param markdown_horizontal_rule:
The horizontal rule character. Can be '*', '_' or '-'.
:param markdown_horizontal_rule_spaces:
Whether spaces should be added between horizontal rule characters.
:param markdown_horizontal_rule_repeat:
The number of times the horizontal rule character will be repeated.
"""
self.remark_configs = {
remark_configs = {
"bullet": markdown_bullets, # - or *
"closeAtx": markdown_closed_headings, # Bool
"setext": markdown_setext_headings, # Bool
Expand All @@ -96,8 +89,8 @@ def run(self, filename, file,
"ruleSpaces": markdown_horizontal_rule_spaces, # Bool
"ruleRepetition": markdown_horizontal_rule_repeat, # int
}
config_json = json.dumps(self.remark_configs)
# Remove { and } (remark adds it on its own) and escape it
settings = re.escape(config_json[1:-1])
self.arguments += " --setting " + settings
return self.lint(filename, file)

config_json = json.dumps(remark_configs)
# Remove { and } as remark adds them on its own
settings = config_json[1:-1]
return '--no-color', '--quiet', '--setting', settings

0 comments on commit 4f8c710

Please sign in to comment.