fix(coding-conventions): Rename ToolBox to getToolBox in charts components - #121926
Open
sentry[bot] wants to merge 1 commit into
Open
fix(coding-conventions): Rename ToolBox to getToolBox in charts components#121926sentry[bot] wants to merge 1 commit into
sentry[bot] wants to merge 1 commit into
Conversation
github-actions
Bot
added
the
Scope: Frontend
ryan953
added
the
Trigger: getsentry tests
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
ToolBoxfunction, a utility for generating EChartsToolboxComponentOptionobjects, was named with a capital letter. This violates React's naming convention for non-component functions, which reserves capitalized names for React components.This capitalization triggered the
no-capitalized-function-callslint rule and React Compiler diagnostic, flagging it as a potential component being called incorrectly.To resolve this, the
ToolBoxfunction has been renamed togetToolBoxin its definition (static/app/components/charts/components/toolBox.tsx) and all its import and call sites across the codebase. Thegetprefix clarifies its role as a factory function and avoids naming collisions with local variables (e.g.,const toolBox = useMemo(...)inuseChartXRangeSelection.tsx).Legal Boilerplate
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
Fixes CODING-CONVENTIONS-1YB