Skip to content

Shellcheck Showcase #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Shellcheck Showcase #6

wants to merge 1 commit into from

Conversation

nimratcoderabbit
Copy link

@nimratcoderabbit nimratcoderabbit commented Jul 14, 2025

image

Summary by CodeRabbit

  • New Features
    • Introduced a new script that greets the user, lists all .txt files in the current directory, and echoes back user input.

Copy link

coderabbitai bot commented Jul 14, 2025

📝 Walkthrough

Walkthrough

A new shell script named test.sh was introduced. The script prints a greeting, lists all .txt files in the current directory, prompts the user for input, and then echoes back the user's response.

Changes

File(s) Change Summary
shellcheck/test.sh Added a script to greet, list .txt files, prompt, and echo input.

Poem

In the shell, a greeting rings clear,
"Hello world!" for all to hear.
It lists the .txt with a bashful glance,
Awaits your words—gives you a chance.
Type your thought, see it rebound,
In test.sh, your voice is found!
🐚✨

Impact Analysis

New shell script for greeting, listing .txt files, and echoing user input

ℹ️ Low 🔄 Impacts behavior

A new script, test.sh, allows users to print a greeting, list all .txt files in the current directory, and interactively echo back user input. This provides a simple utility for users to interact with files and receive feedback in the terminal.

Test the script in directories with and without .txt files, and provide various user inputs (including empty input and special characters) to verify correct output and robustness.

🔍 Related Files
  • shellcheck/test.sh
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch preview/shellcheck

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (3)
shellcheck/test.sh (3)

5-5: Quote variable expansion in echo.

Unquoted $name undergoes word-splitting and globbing. Quote it to print safely.

-echo Hello $name
+echo "Hello $name"

12-13: Read input safely and provide a prompt.

Use read -r to prevent backslash interpretation and prompt the user for clarity.

-read input
-echo You typed $input
+read -r -p "Enter something: " input
+echo "You typed: $input"

1-1: Consider enabling strict-mode flags up front.

Adding set -euo pipefail helps the script fail fast on errors or unset variables.

-#!/bin/bash
+#!/usr/bin/env bash
+set -euo pipefail
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ef04b8d and 508d567.

📒 Files selected for processing (1)
  • shellcheck/test.sh (1 hunks)
🧰 Additional context used
🪛 Shellcheck (0.10.0)
shellcheck/test.sh

[error] 7-7: Iterating over ls output is fragile. Use globs.

(SC2045)

Comment on lines +7 to +10
for file in $(ls *.txt)
do
echo $file
done
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Replace the ls-parsing loop with a robust glob loop.

for file in $(ls *.txt) breaks on filenames with spaces or newlines and fails when no .txt files exist. Glob expansion avoids both issues and keeps the code POSIX-friendly.

-for file in $(ls *.txt)
-do
-  echo $file
-done
+for file in *.txt; do
+  # Skip the loop when no .txt files are present
+  [ -e "$file" ] || continue
+  echo "$file"
+done
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
for file in $(ls *.txt)
do
echo $file
done
for file in *.txt; do
# Skip the loop when no .txt files are present
[ -e "$file" ] || continue
echo "$file"
done
🧰 Tools
🪛 Shellcheck (0.10.0)

[error] 7-7: Iterating over ls output is fragile. Use globs.

(SC2045)

🤖 Prompt for AI Agents
In shellcheck/test.sh around lines 7 to 10, replace the loop using `for file in
$(ls *.txt)` with a glob-based loop like `for file in *.txt` to handle filenames
with spaces or newlines correctly and avoid errors when no `.txt` files exist,
ensuring POSIX compatibility and robustness.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant