fix(coding-conventions): Rename capitalized 'Legend' function to 'legend' - #121928
Open
sentry[bot] wants to merge 2 commits into
Open
fix(coding-conventions): Rename capitalized 'Legend' function to 'legend'#121928sentry[bot] wants to merge 2 commits into
sentry[bot] wants to merge 2 commits into
Conversation
github-actions
Bot
added
the
Scope: Frontend
ryan953
added
the
Trigger: getsentry tests
baseChart.tsx imported Legend via a relative path and was missed by the rename, breaking typecheck and every chart test. usageChart shadowed the new lowercase import with a local variable. Alias both to makeLegend.
github-actions
Bot
removed
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
Legendfunction instatic/app/components/charts/components/legend.tsxwas named with a capital letter, which conventionally signifies a React component. However, this function is an echarts configuration factory, returning aLegendComponentOptionobject, not a React element.This naming mismatch caused the React Compiler's
no-capitalized-function-callsrule to flag direct calls toLegendas violations, as it reserves capitalized identifiers for components that should be invoked with JSX.This change renames
export function Legendtoexport function legendinstatic/app/components/charts/components/legend.tsx.All five affected call sites have been updated to reflect this change:
static/app/views/issueDetails/eventGraph.tsxstatic/app/chartcuterie/timeseries.tsxstatic/app/chartcuterie/slack.tsxstatic/app/views/organizationStats/usageChart/index.tsxstatic/gsAdmin/components/customers/customerStats.tsx(usingmakeLegendalias to avoid local variable collision).This resolves the
no-capitalized-function-callswarning for this specific instance and aligns the function's naming with React's conventions for non-component utilities.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-1TV