class RLintBear(LocalBear, Lint):
executable = 'Rscript'
arguments = "-e 'library(lintr)' -e 'lintr::lint(\"{filename}\")'"
output_regex = re.compile(r'(.*?):(?P<line>\d+):(?P<column>\d+):'
r' (?P<severity>\S+): (?P<message>.*)')
severity_map = {
"style": RESULT_SEVERITY.NORMAL,
"warning": RESULT_SEVERITY.NORMAL,
"error": RESULT_SEVERITY.MAJOR
}
LANGUAGES = {"R"}
AUTHORS = {'The coala developers'}
AUTHORS_EMAILS = {'*****@*****.**'}
REQUIREMENTS = {
RscriptRequirement(package='lintr',
flag='-e',
repo='http://cran.rstudio.com')
}
LICENSE = 'AGPL-3.0'
CAN_DETECT = {'Syntax', 'Formatting'}
prerequisite_command = ["Rscript", "-e", "library(lintr)"]
prerequisite_fail_msg = 'R library "lintr" is not installed.'
def run(self, filename, file):
'''
Checks the code with `lintr`.
'''
return self.lint(filename)
class RLintBear:
"""
Checks the code with ``lintr``.
"""
LANGUAGES = {'R'}
AUTHORS = {'The coala developers'}
AUTHORS_EMAILS = {'*****@*****.**'}
REQUIREMENTS = {
RscriptRequirement(package='lintr',
flag='-e',
repo='http://cran.rstudio.com')
}
LICENSE = 'AGPL-3.0'
CAN_DETECT = {'Syntax', 'Formatting'}
@staticmethod
def create_arguments(filename, file, config_file):
return ('-e', 'library(lintr)', '-e',
'lintr::lint("' + escape(filename, '\\"') + '")')
class FormatRBear:
"""
Check and correct formatting of R Code using known formatR utility.
"""
LANGUAGES = {'R'}
AUTHORS = {'The coala developers'}
AUTHORS_EMAILS = {'*****@*****.**'}
REQUIREMENTS = {
RscriptRequirement(package='formatR',
flag='-e',
repo='http://cran.rstudio.com')
}
LICENSE = 'AGPL-3.0'
ASCIINEMA_URL = 'https://asciinema.org/a/0y0oxtak18v492jdyfqwpw1n4'
CAN_FIX = {'Formatting'}
@staticmethod
@deprecate_settings(indent_size='tab_width')
def create_arguments(filename,
file,
config_file,
r_keep_comments: bool = True,
r_keep_blank_lines: bool = True,
r_braces_on_next_line: bool = False,
r_use_arrows: bool = False,
indent_size: int = SpacingHelper.DEFAULT_TAB_WIDTH,
r_max_expression_length: int = 0):
"""
:param r_keep_comments:
Determines whether comments are kept or not.
:param r_keep_blank_lines:
Determines whether blank lines are kept or not.
:param r_braces_on_next_line:
Determines whether a brace should be placed on the next line.
Example:
If ``True``,
```
if (...) {
```
changes to
```
if (...)
{
```
If ``False`` the brace is placed on the same line.
:param r_use_arrows:
Determines whether the assignment operator ``=`` should be replaced
by an arrow ``<-`` or not.
Example: If ``True``, ``x = 1`` changes to ``x <- 1``.
:param indent_size:
Number of spaces per indentation level.
:param r_max_expression_length:
Maximum number of characters for an expression.
Example: If ``20`` then
```
1 + 1 + 1 + 1 + 1 + 1 + 1
```
changes to
```
1 + 1 + 1 + 1 + 1 + 1 +
1
```
"""
options = {
'source="' + escape(filename, '"\\') + '"',
'blank=' + _map_to_r_bool(r_keep_blank_lines),
'brace.newline=' + _map_to_r_bool(r_braces_on_next_line),
'comment=' + _map_to_r_bool(r_keep_comments),
'arrow=' + _map_to_r_bool(r_use_arrows),
'indent=' + str(indent_size)
}
if r_max_expression_length:
options.add('width.cutoff=' + str(r_max_expression_length))
rcode = 'library(formatR);formatR::tidy_source({})'.format(
','.join(options))
return '-e', rcode
def test_installed_requirement(self):
self.assertTrue(RscriptRequirement('base').is_installed())
def test_not_installed_requirement(self):
self.assertFalse(RscriptRequirement('some_bad_package').is_installed())