lint (version 0.3)

make_class_finder: Finder Functions

Finders are helper functions that assist in the definition of style checks. These function assist by finding the regions that are either included or excluded from check. Each finder must accept the following arguments and as well as the variadic argument ....

1. file
2. lines
3. parse.data

Order of arguments is not guaranteed so explicit names use is required, since use of named arguments is guaranteed. In addition other arguments may be added later. Each finder is expected to return a find formated data.frame.

Custom finders are encouraged, but finders for common classes are included in the package.

Description

Finder Functions

Finders are helper functions that assist in the definition of style checks. These function assist by finding the regions that are either included or excluded from check. Each finder must accept the following arguments and as well as the variadic argument ....

1. file
2. lines
3. parse.data

Order of arguments is not guaranteed so explicit names use is required, since use of named arguments is guaranteed. In addition other arguments may be added later. Each finder is expected to return a find formated data.frame.

Custom finders are encouraged, but finders for common classes are included in the package.

Usage

make_class_finder(classes)
  find_comment(..., parse.data)
  find_basic_comment(..., parse.data)
  find_inside_comment(..., parse.data)
  find_doc_comment(..., parse.data)
  find_string(..., parse.data)
  find_symbol(..., parse.data)
  find_number(..., parse.data)
  find_function_args(..., parse.data)
  find_function_body(..., lines, file, parse.data = getParseData(parse(file, keep.source = TRUE)))
  find_call_args(..., file, parse.data = getParseData(parse(file)))

Arguments

classes

with make_class_finder the getParseData classes to find.

file

the file being examined.

lines

the lines being examined.

parse.data

data from getParseData

...

extra arguments that include file, and lines