Warn against block.id usage #595
Open
+170
−2
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
miazbikowski
force-pushed
the
miaz/warn-block-id-usage
branch
2 times, most recently
from
c60ac80
to
14f7744
Compare
charlespwd
approved these changes
Nov 15, 2024
Comment on lines
27
to
52
| return { | ||
| // BAD: {% if block.id == "123" %} | ||
| // BAD: {% if block.id == some_variable %} | ||
| // BAD: {% if block[id] == "id" or block.id %} | ||
| // FINE: <div data-block-id="{{ block.id }}"> | ||
| // FINE:document.querySelector(`[data-block-id="${block.id}"]`) | ||
| async Comparison(node, ancesors) { | ||
| if (node.comparator === '==' && node.left.type === NodeTypes.VariableLookup && isUsingBlockId(node.left)) { | ||
| reportWarning(context, node.position); | ||
| } | ||
| }, | ||
|
|
||
| // BAD {% case block.id %} | ||
| async VariableLookup(node, ancestors) { | ||
| const parentNode = ancestors.at(-1); | ||
| if (parentNode?.type === NodeTypes.LiquidTag && parentNode.name === 'case') { | ||
| if (isUsingBlockId(node)) { | ||
| reportWarning(context, node.position); | ||
| } | ||
| } | ||
| } | ||
| }; | ||
| }, |
There was a problem hiding this comment.
So tidy. So simple. So beautiful 🥹
miazbikowski
force-pushed
the
miaz/warn-block-id-usage
branch
from
14f7744
to
651a723
Compare
miazbikowski
force-pushed
the
miaz/warn-block-id-usage
branch
from
651a723
to
c4813ff
Compare
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.
What are you adding in this PR?
Part of #463
We want to warn developers against the use of
block.idin their liquid code in cases where the ID's instability could cause problems. This PR addresses usage inif,elseif,unlessandcaseblocks. (I've got some comments in the code to demonstrate the cases)Note: did not end up doing
assignas a variable can have valid use cases (like those in my code comments)Follow ups
Dev docs PR
What did you learn?
console.logwill break your code and not tell you why. This is because of the language server.Before you deploy
changesetallChecksarray insrc/checks/index.tsyarn buildand committed the updated configuration filestheme-app-extension.ymlconfigchangesetchangeset