Skip to content

chore!: Rename confusing tool groups and names#159

Merged
gadenbuie merged 5 commits intomainfrom
fix/157-rename-tools-and-groups
Jan 14, 2026
Merged

chore!: Rename confusing tool groups and names#159
gadenbuie merged 5 commits intomainfrom
fix/157-rename-tools-and-groups

Conversation

@gadenbuie
Copy link
Copy Markdown
Collaborator

Several tool groups and tool names have been renamed for clarity (fixes #157):

Old Name New Name
session group sessioninfo group
search group cran group
btw_tool_session_platform_info() btw_tool_sessioninfo_platform()
btw_tool_session_package_info() btw_tool_sessioninfo_package()
btw_tool_session_check_package_installed() btw_tool_sessioninfo_is_package_installed()
btw_tool_search_packages() btw_tool_cran_search()
btw_tool_search_package_info() btw_tool_cran_package()
btw_tool_files_list_files() btw_tool_files_list()
btw_tool_files_read_text_file() btw_tool_files_read()
btw_tool_files_write_text_file() btw_tool_files_write()
btw_tool_files_code_search() btw_tool_files_search()

The old names and group aliases continue to work but emit deprecation warnings. The btw.files_code_search.extensions and btw.files_code_search.exclusions options have also been renamed to btw.files_search.extensions and btw.files_search.exclusions, with the old option names emitting deprecation warnings.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR renames several tool groups and tool names for better clarity and consistency. The session group becomes sessioninfo, the search group becomes cran, and various tool names are shortened by removing redundant suffixes (e.g., _text_file, _code_search).

Changes:

  • Tool groups renamed: sessionsessioninfo, searchcran
  • Tool functions renamed with improved clarity and conciseness
  • Backward compatibility maintained through deprecation wrappers and aliases

Reviewed changes

Copilot reviewed 34 out of 35 changed files in this pull request and generated no comments.

Show a summary per file
File Description
R/deprecated.R Adds deprecation wrappers for all renamed functions
R/tool-sessioninfo.R Renames session tools to sessioninfo tools
R/tool-session-package-installed.R Updates package installation check tool name
R/tool-files.R Shortens file tool names by removing _text_file suffix
R/tool-files-search.R Renames code_search to search and updates option names
R/tool-cran.R Renames search tools to cran tools
R/tools.R Adds alias support infrastructure for backward compatibility
R/aaa-tools.R Extends tool registration to support aliases
R/btw_this.R Updates internal function calls to use new names
R/btw_client.R Updates platform info function call
tests/testthat/*.R Updates test cases to use new function names
tests/testthat/_snaps/*.md Adds deprecation warnings to snapshots
man/*.Rd Updates documentation to reflect new names
NEWS.md Documents breaking changes with migration table
NAMESPACE Exports new function names
Comments suppressed due to low confidence (1)

DESCRIPTION:1

  • The LazyData: true field is removed but this appears unrelated to the PR's purpose of renaming tools. This change should either be mentioned in the PR description or moved to a separate commit.
Package: btw

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@gadenbuie gadenbuie merged commit 9c0e257 into main Jan 14, 2026
10 checks passed
@gadenbuie gadenbuie deleted the fix/157-rename-tools-and-groups branch January 14, 2026 15:17
gadenbuie added a commit that referenced this pull request Jan 14, 2026
and correct PR number in NEWS

Follow up to #159
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.

Rename confusing tool groups and names

2 participants