Avoid use of concatenation when producing CSS classnames #2312
Conversation
This file contains 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
Dynamically concatenating values to produce CSS classnames makes it difficult to identify which values are / may be used, often leading to stale styles being left behind as developers are unsure whether they're safe to remove. Where possible we should ensure the entire CSS classname appears as a single string in the codebase so it's easily searchable. This also becomes increasingly important when using tooling to identify unused styles. Some components such as `LogFormat` are exceptions to this rule due to the potentially large number of values involved, and the affected classnames already have an easily searchable prefix. These prefixes can be excluded from the tooling to avoid them being pruned as they depend on user content only available at runtime.
tekton-robot
added
the
size/M
tekton-robot
requested review from
briangleeson,
LyndseyBu and
steveodonovan
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: briangleeson The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
tekton-robot
added
the
approved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes
Dynamically concatenating values to produce CSS classnames makes it
difficult to identify which values are / may be used, often leading
to stale styles being left behind as developers are unsure whether
they're safe to remove.
Where possible we should ensure the entire CSS classname appears
as a single string in the codebase so it's easily searchable. This
also becomes increasingly important when using tooling to identify
unused styles.
Some components such as
LogFormatare exceptions to this ruledue to the potentially large number of values involved, and the
affected classnames already have an easily searchable prefix. These
prefixes can be excluded from the tooling to avoid them being pruned
as they depend on user content only available at runtime.
Submitter Checklist
As the author of this PR, please check off the items in this checklist:
functionality, content, code)
See the contribution guide
for more details.