Skip to content

Conversation

ooonea
Copy link

@ooonea ooonea commented Sep 24, 2025

Updated the source command in INSTALL.md to use the correct file extension for zsh-syntax-highlighting.

Updated the source command in INSTALL.md to use the correct file extension for zsh-syntax-highlighting.
Copy link

coderabbitai bot commented Sep 24, 2025

📝 Walkthrough

Walkthrough

Documentation update in INSTALL.md: the activation command now sources zsh-syntax-highlighting.sh instead of zsh-syntax-highlighting.zsh.

Changes

Cohort / File(s) Summary
Docs
INSTALL.md
Update activation step to source zsh-syntax-highlighting.sh instead of zsh-syntax-highlighting.zsh.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly and accurately describes the primary change of fixing the source command in INSTALL.md for zsh-syntax-highlighting, is clear and specific, and directly reflects the main update without extraneous details.
Description Check ✅ Passed The description follows the repository template by including the required comment block and succinctly explains the updated source command in INSTALL.md, clearly stating the purpose of the change.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 09c89b6 and 4248285.

📒 Files selected for processing (1)
  • INSTALL.md (1 hunks)

```bash
# ...
source /some/path/to/your/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
source /some/path/to/your/zsh-syntax-highlighting/zsh-syntax-highlighting.sh
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Restore .zsh extension in the example source line.

The upstream zsh-syntax-highlighting plugin ships zsh-syntax-highlighting.zsh, and this is the file users are instructed to source in their .zshrc. Switching the example to .sh points to a non-existent path and will break the activation instructions. Please keep the .zsh suffix here.

-      source /some/path/to/your/zsh-syntax-highlighting/zsh-syntax-highlighting.sh
+      source /some/path/to/your/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
📝 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
source /some/path/to/your/zsh-syntax-highlighting/zsh-syntax-highlighting.sh
source /some/path/to/your/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
🤖 Prompt for AI Agents
In INSTALL.md around line 23, the example source path uses the incorrect .sh
extension which points to a non-existent file; change the filename in the
example back to zsh-syntax-highlighting.zsh so the source line matches the
upstream plugin and will correctly activate when added to users' .zshrc.

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

Successfully merging this pull request may close these issues.

1 participant