[LINT_BUG]: Handle non-syntactic function and object names (back ticks)

[SaintRod]

box.linters version

0.10.5

Sample source code to lint

Assume test.R is a file with the below box import statement and 01_example.R is some file that exports stuff.

Sometimes it's useful to add a numeric prefix to indicate the order of operations.

The below box::use call doesn't fail but the box.linters does.

box::use(
  . / `01_example`[...],
)

Lint command used

box::use(
  box.linters[box_default_linters],
  here[here],
  lintr[lint],
)

lint(
  filename = here("test.R"),
  linters = box_default_linters$box_unused_attached_mod_linter
)

Lint result

Error: Linter 'box_unused_attached_mod_linter' failed in ./test.R: <text>:1:5: unexpected input
1: ./01_
        ^

Expected result

If box doesn't return an error, then its linters probably shouldn't either.

If the numeric prefix naming convention isn't recommended, then that's what the lint should say.

[SaintRod]

PS. I'm not using box.linters with rhino

[caldwellst]

I came here to post the same error. This is not because of numeric prefixing, but because of the use of backticks, which are required because starting a variable name with numbers is not valid in R.

Note that this also fails using the {box} recommended testing approach, where __test__ modules are nested in every module and are called in the module __init__.R file like so:

if (is.null(box::name())) {
    box::use(./`__tests__`)
}

For now I am going to simply rename the testing directory to tests, but clearly this isn't desirable behavior as {box} allows backticked module names and in some areas recommends their usage.

[radbasa]

Will take a look at supporting back ticks in the box::use() calls.

[SaintRod]

#151 related

[radbasa]

Non-syntactic (backticks) examples:

Function names

SPECIALs

box::use(
  magrittr[`%>%`]
)

c(1, 2, 3) %>% sum()

box::use(
  path/module[`**`],
)

# where
# `**` <- function(x, y) {
#   x ^ y
# }

2 ** 4

SYMBOL_FUNCTION_CALLs

box::use(
  path/module[`1_function`],
)

# where
# `1_function` <- function(x, y) {
#   x ^ y
# }

`1_function`(2, 4)

box::use(
  path/module[...],
)

# where
# `1_function` <- function(x, y) {
#   x ^ y
# }

`1_function`(2, 4)

Module names

box::use(
  path/`1_module`
)

`1_module`$some_function()

box::use(
  path/`1_module`[a],
)

a()

box::use(
  path/`1_module`[...]
)

a()

XML analysis

c(1,2) %>% sum()
`01_function`(2, 3)

%>% is a SPECIAL
`01_function`() is a SYMBOL_FUNCTION_CALL

```R
box::use(
  magrittr[`%>%`],
  path/module[`01_function`]
)

%>% is a SYMBOL
`01_function` is a SYMBOL

`**` <- function(x, y) {
  x ^ y
}

`01_function` <- function() {
}

** is a SYMBOL LEFT_ASSIGNed a FUNCTION
`01_function` is a SYMBOL LEFT_ASSIGNed a FUNCTION

box::use(
  path/module[...],
  path/`1_module`[...]
)

module is a SYMBOL
`1_module` is a SYMBOL

box::use(
  path/module,
  path/`1_module`
)

module$func()
`1_module`$func()

module in box::use and named function call are SYMBOLs
`1_module` in box::use and named funcation call are SYMBOLs

`1_object` <- 2
`1_object` + 2

`1_object` is a SYMBOL