Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modules support #11

Merged
merged 59 commits into from
Aug 15, 2024
Merged

Modules support #11

merged 59 commits into from
Aug 15, 2024

Conversation

radbasa
Copy link
Collaborator

@radbasa radbasa commented Aug 13, 2024

Description

  • Adds local module support
  • Adds alias support

Install local package:

devtools::install_local(<path to box.lsp>)

# in project
box.lsp::use_box_lsp()

# restart R session to properly load languageserver
box::use(
  stringr[str_count, sss = str_extract]
)

box::use(
  app/logic/module_a[...],   # some_function()
  app/logic/module_b[a_function, ttt = b_function]
)

Should auto-complete and show signatures:

str_count()
sss()

some_function()
a_function()
ttt()

An alias of a package function loses its link to the source documentation. sss() loses the stringr::str_extract() link.

Definition of Done

  • The change is thoroughly documented.
  • The CI passes (R CMD check, linter, unit tests, spelling).
  • Any generated files have been updated (e.g. .Rd files with roxygen2::roxygenise())

@radbasa radbasa requested a review from jakubnowicki August 13, 2024 06:02
Base automatically changed from add-function-signatures to main August 15, 2024 05:54
@radbasa radbasa merged commit bba7099 into main Aug 15, 2024
5 checks passed
@radbasa radbasa deleted the modules-support branch August 15, 2024 06:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants