object_length_linter: Object length linter

In r-lib/lintr: A 'Linter' for R Code

Object length linter

Description

Check that object names are not too long. The length of an object name is defined as the length in characters, after removing extraneous parts:

Usage

object_length_linter(length = 30L)

Arguments

length

maximum variable name length allowed.

Details

• generic prefixes for implementations of S3 generics, e.g. as.data.frame.my_class has length 8.

• leading ., e.g. .my_hidden_function has length 18.

• "%%" for infix operators, e.g. ⁠%my_op%⁠ has length 5.

• trailing ⁠<-⁠ for assignment functions, e.g. ⁠my_attr<-⁠ has length 7.

Note that this behavior relies in part on having packages in your Imports available; see the detailed note in object_name_linter() for more details.

Tags

configurable, default, executing, readability, style

See Also

linters for a complete list of linters available in lintr.

Examples

# will produce lints
lint(
  text = "very_very_long_variable_name <- 1L",
  linters = object_length_linter(length = 10L)
)

# okay
lint(
  text = "very_very_long_variable_name <- 1L",
  linters = object_length_linter(length = 30L)
)

lint(
  text = "var <- 1L",
  linters = object_length_linter(length = 10L)
)

r-lib/lintr documentation built on Dec. 20, 2024, 7:24 p.m.