Fix source command in INSTALL.md for zsh-syntax-highlighting#11
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 |
| ```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.
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.