Skip to content

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.

Sign up for GitHub

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: master
Choose a base branch
from
Open

Fix source command in INSTALL.md for zsh-syntax-highlighting #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Download using the [GitHub .zip download](https://github.com/dracula/zsh-syntax-

```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.

# ...
```

Expand Down