-
Couldn't load subscription status.
- Fork 13
Fix source command in INSTALL.md for zsh-syntax-highlighting #11
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
base: master
Are you sure you want to change the base?
Conversation
Updated the source command in INSTALL.md to use the correct file extension for zsh-syntax-highlighting.
📝 WalkthroughWalkthroughDocumentation update in INSTALL.md: the activation command now sources zsh-syntax-highlighting.sh instead of zsh-syntax-highlighting.zsh. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ```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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| 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.
Updated the source command in INSTALL.md to use the correct file extension for zsh-syntax-highlighting.