SKUNK-1029 Document by_ref exception for shell rule S1481 #5952
+12
−0
Conversation
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
Contributor
sebastien-marichal
approved these changes
Dec 8, 2025
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Add exception to S1481 shell rule documenting that variables passed by reference to functions containing 'by_ref' in their name are considered used. This prevents false positives when variables are passed as plain word arguments to functions that modify them indirectly. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
This is not exactly an exception, we still check that it is used, but in another way.
romainbrenguier
force-pushed
the
romain/update-S1481
branch
from
99af0e6 to
3de462c
Compare
|
|
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
by_refin their name$varexpansions) toby_reffunctions are counted as legitimate variable usagesContext
The S1481 rule ("Unused local variables should be removed") was reporting false positives for bash patterns where variables are passed by reference to functions. In patterns like:
local result status get_values_by_ref result statusThe variables
resultandstatusappear as plain words (not$resultor$status), which are not detected as variable usages by the tree-sitter grammar. The documentation now reflects that the rule recognizes this idiom by checking if the function name containsby_refand counting word arguments matching declared variable names as legitimate usages.