fix(shell): declare the dialect for the sourced contract.config.sh - #240
Open
hyperpolymath wants to merge 1 commit into
Open
fix(shell): declare the dialect for the sourced contract.config.sh#240hyperpolymath wants to merge 1 commit into
hyperpolymath wants to merge 1 commit into
Conversation
shellcheck SC2148 ('target shell is unknown') on contract.config.sh.
Deliberately a directive, not a shebang. The file is SOURCED by
tools/check-contract.sh and never executed as its own process, so a shebang
would claim an execution model it does not have. '# shellcheck shell=bash'
states the dialect without making that false claim.
Placed on line 2, immediately after the SPDX header, so the estate rule that
SPDX must be line 1 still holds — shellcheck directives are honoured anywhere
before the first command.
Found by an estate-wide sweep of 5,111 scripts across 375 repos: 85 files lack
a shell declaration. Only first-party files were changed; HOL's ATP scripts and
the ReScript compiler's own test fixtures were excluded as vendored upstream
code, where a shebang would create permanent divergence for a lint warning.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📜 Recent review details⏰ Context from checks skipped due to timeout. (3)
|
| Layer / File(s) | Summary |
|---|---|
Declare Bash dialect contract.config.sh |
Adds a ShellCheck directive that identifies the script as Bash. |
Estimated code review effort: 1 (Trivial) | ~2 minutes
Merge Risk: ⚪ Minimal · up to e76b4
This localized change only declares the shell dialect for linting and does not alter runtime behavior; no actionable merge-blocking risk remains beyond normal checks and review.
Poem
A rabbit checks the Bash-bound line
ShellCheck reads the dialect sign
One small directive joins the code
The script now bears its proper mode
Carrots compile in neat array
🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Description check | The description clearly explains the change, its rationale, placement, and scope. It does not provide the required RSR checklist status or a Testing section, so the template requirements are incomplet… | Add the required template sections. Mark each applicable RSR Quality Checklist item, and document the commands or checks used to test the change. Add Screenshots or terminal output if applicable. |
✅ Passed checks (4 passed)
| Check name | Status | Explanation |
|---|---|---|
| Title check | ✅ Passed | The title clearly and concisely identifies the Bash dialect declaration added to the sourced contract.config.sh file. |
| Docstring Coverage | ✅ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1… |
| Linked Issues check | ✅ Passed | Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | ✅ Passed | Check skipped because no linked issues were found for this pull request. |
Full details: Description check
Explanation
The description clearly explains the change, its rationale, placement, and scope. It does not provide the required RSR checklist status or a Testing section, so the template requirements are incomplete.
Full details: Docstring Coverage
Explanation
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1 files.
- Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
- Create stacked PR
- Commit on current branch
📝 Generate docstrings
- Create stacked PR
- Commit on current branch
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
|
Up to standards ✅🟢 Issues
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
This PR addresses the ShellCheck warning SC2148 in contract.config.sh by adding a shell directive. By using # shellcheck shell=bash instead of a shebang, the script is correctly identified as a sourced file rather than an executable. The directive is placed appropriately after the SPDX license header to comply with project standards. Codacy analysis confirms the PR is up to standards with no new quality or complexity issues.
Test suggestions
- Verify that ShellCheck no longer reports SC2148 for contract.config.sh.
- Ensure the script remains valid for sourcing by tools/check-contract.sh.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify that ShellCheck no longer reports SC2148 for contract.config.sh.
2. Ensure the script remains valid for sourcing by tools/check-contract.sh.
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
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.
shellcheck
SC2148(target shell is unknown) oncontract.config.sh.Deliberately a directive, not a shebang. The file is
sourced bytools/check-contract.shand never executed as its own process, so a shebang would claim an execution model it does not have.# shellcheck shell=bashstates the dialect without making that false claim.Placed on line 2, immediately after the SPDX header, so the estate rule that SPDX must be line 1 still holds — shellcheck directives are honoured anywhere before the first command.
Found by an estate-wide sweep of 5,111 scripts across 375 repos: 85 files lack a shell declaration. Only first-party files were changed — HOL's ATP scripts and the ReScript compiler's own test fixtures were excluded as vendored upstream code, where a shebang would create permanent divergence for a lint warning.