feat(highlight): ZSH syntax highlighting with zi/zunit tokens#729
Closed
ss-o wants to merge 8 commits into
Closed
Conversation
docs(annexes): update available meta-plugins list Signed-off-by: Salvydas Lukosius <ss-o@users.noreply.github.com> Co-authored-by: Salvydas Lukosius <ss-o@users.noreply.github.com>
- Creates src/prism/prism-zsh.js extending bash grammar
- Registers ZSH builtins (setopt, autoload, compinit, zstyle, bindkey,
typeset, unsetopt, zle, zmodload, zstyle, zcompile, etc.) as builtin tokens
- Registers zi and zunit as keyword tokens for distinct highlighting
- Adds ZSH parameter expansion flag pattern ${(flags)var}
- Swizzles prism-include-languages to load the custom grammar
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
All 49 docs files with ZSH-specific content (zi, setopt, autoload, compinit, zstyle, bindkey, zle, etc.) now use the `zsh` language identifier for proper syntax highlighting. Generic POSIX shell one-liners (curl install commands) remain as `shell`. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Deploying zsh with
|
| Latest commit: |
834f37b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b5252fd6.zsh.pages.dev |
| Branch Preview URL: | https://agents-zsh-syntax-highlighti.zsh.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a custom Prism grammar for zsh and updates documentation code fences to use zsh where Zsh-specific syntax appears, enabling more accurate syntax highlighting across the Docusaurus site.
Changes:
- Added a custom Prism
zshlanguage (built onbash) with extra tokens forzi,zunit, Zsh builtins, and parameter expansion flags. - Swizzled Docusaurus’ Prism language loader to register the custom
zshgrammar afterbashloads. - Migrated many MDX code blocks from
shell tozsh to opt into the new highlighting.
Reviewed changes
Copilot reviewed 51 out of 51 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/theme/prism-include-languages.js | Loads configured Prism additionalLanguages then registers the custom zsh grammar. |
| src/prism/prism-zsh.js | Defines the custom Prism zsh grammar extending bash. |
| ecosystem/plugins/zzcomplete.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/plugins/zui.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/plugins/zsh_unique_id.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/plugins/zsh_startify.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/plugins/zsh_select.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/plugins/zsh_navigation_tools.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/plugins/zsh_modules.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/plugins/zsh_editing_workbench.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/plugins/zsh_comand_architect.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/plugins/zprompts.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/plugins/zi_console.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/plugins/zconvey.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/plugins/zbrowse.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/plugins/h-s-mw.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/plugins/f-sy-h.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/plugins/diff-so-fancy.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/packages/02_usage.mdx | Updates Zi/Zsh examples to use zsh highlighting. |
| ecosystem/packages/01_synopsis.mdx | Updates Zi/Zsh examples to use zsh highlighting. |
| ecosystem/annexes/9_rust.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/annexes/8_linkbin.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/annexes/7_unscope.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/annexes/6_submods.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/annexes/5_readurl.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/annexes/4_patch-dl.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/annexes/3_default_ice.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/annexes/20_test.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/annexes/2_meta_plugins.mdx | Updates code fences to zsh and modifies the meta-plugin table content. |
| ecosystem/annexes/19_eval.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/annexes/1_bin_gem_node.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| ecosystem/annexes/0_overview.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| docs/guides/syntax/10_bindkey.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| docs/guides/syntax/02_for.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| docs/guides/syntax/01_standard.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| docs/guides/03_benchmark.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| docs/guides/02_customization.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| docs/guides/01_commands.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| docs/getting_started/03_migration.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| docs/getting_started/02_overview.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| docs/getting_started/01_installation.mdx | Updates some fenced blocks to zsh highlighting in installation guide tabs. |
| community/gallery/collection/07_themes.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| community/gallery/collection/06_plugins.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| community/gallery/collection/05_services.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| community/gallery/collection/04_snippets.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| community/gallery/collection/03_programs.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| community/gallery/collection/02_completions.mdx | Updates fenced blocks to zsh highlighting (and retains some code-block meta). |
| community/gallery/collection/01_collection.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| community/03_zsh_native_scripting_handbook.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| community/02_zsh_plugin_standard.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
| community/01_zsh_guide/01_roadmap/10_expansion.mdx | Updates Zsh-related fenced blocks to use zsh highlighting. |
Comments suppressed due to low confidence (1)
community/gallery/collection/02_completions.mdx:62
- Same issue here:
showlinenumbersshould beshowLineNumbersfor Docusaurus to render line numbers.
```zsh showlinenumbers
zi_completion has'…'
| alias: 'attr-value', | ||
| }, | ||
| }); | ||
| })(Prism); |
Comment on lines
77
to
81
| Install and include minimal configuration with recommended <Link to="/ecosystem/annexes/overview">annexes</Link> and setup <Link to="https://github.com/zdharma/zunit">zdharma/zunit</Link>: | ||
|
|
||
| ```shell | ||
| ```zsh | ||
| sh -c "$(curl -fsSL get.zshell.dev)" -- -a zunit | ||
| ``` |
| > - It's optional and can be removed if not required. | ||
|
|
||
| ```shell showlinenumbers | ||
| ```zsh showlinenumbers |
Comment on lines
63
to
66
| | @fuzzy | [fzf][] (package), [fzy][] (package), [skim][], [peco][] | | ||
| | @fuzzy-src | fzf-go, [fzy][], skim-cargo, peco-go | | ||
| | @prezto | PZTM::archive, PZTM::directory, PZTM::utility | | ||
| | @ohmyzsh-lib | OMZL::git, OMZL::history, OMZL::vcs_info, OMZL::clipboard, OMZL::completion, OMZL::theme-and-appearance, OMZL::prompt_info_functions, OMZL::termsupport, OMZL::key-bindings, OMZL::compfix, OMZL::directories, OMZL::functions | | ||
| | @py-utils | [pyenv][] (package) | |
Member
Author
|
@copilot apply changes based on the comments in this thread |
Signed-off-by: Sall <59910950+ss-o@users.noreply.github.com>
Agent-Logs-Url: https://github.com/z-shell/wiki/sessions/2c76788c-a874-4a1c-8b35-33bf9c1c64a6 Co-authored-by: ss-o <59910950+ss-o@users.noreply.github.com>
Contributor
Implemented the requested thread fixes in commit Screenshot: unable to capture a browser render in this runner, but |
Member
Author
|
@copilot don't see changes, here is built site: https://agents-zsh-syntax-highlighti.zsh.pages.dev/community/zunit/zunit-installation |
Agent-Logs-Url: https://github.com/z-shell/wiki/sessions/e1acf6bd-e68a-4ed6-8487-b8c5fc8a82d5 Co-authored-by: ss-o <59910950+ss-o@users.noreply.github.com>
Contributor
Pushed a follow-up so the change is visible on that page: commit Screenshot (local verification): Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Member
Author
|
@copilot yes it works. can we also assign additional colors? higlighting has too few colors it blends |
Signed-off-by: Sall <59910950+ss-o@users.noreply.github.com>
Agent-Logs-Url: https://github.com/z-shell/wiki/sessions/da846b7a-ce9e-4b26-aecf-2941cecebb52 Co-authored-by: ss-o <59910950+ss-o@users.noreply.github.com>
Contributor
Done in Screenshot: Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Contributor
|
Size Change: +110 kB (+1.75%) Total Size: 6.4 MB
ℹ️ View Unchanged
|
Member
Author
|
Superseded by #728 — grammar, CSS token colors, and MDX conversions merged into the feature branch with improvements (TypeScript module, comprehensive palette, named capture groups). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds proper ZSH syntax highlighting to all code blocks, replacing generic
shellhighlighting with a custom Prism grammar that understands ZSH-specific syntax including project commands.Changes
New: Custom Prism ZSH grammar (
src/prism/prism-zsh.js)bashgrammar as a basezi,zunit→keywordtoken (distinct highlight color)builtintoken:setopt,unsetopt,autoload,compinit,compdef,zstyle,bindkey,zle,typeset,zmodload,zparseopts, and more${(U)var},${(f)var}etc. →attr-valuetokenNew: Swizzled loader (
src/theme/prism-include-languages.js)additionalLanguagesloading behaviourrequire('../prism/prism-zsh.js')afterbashloads (dependency order)zshis intentionally not added toadditionalLanguagesin config — Docusaurus would error trying to find the non-existentprismjs/components/prism-zsh.jsDocs: 49 MDX files migrated
All
shellcode blocks containing ZSH-specific syntax (zi,setopt,autoload,compinit,bindkey, etc.) updated tozsh. Generic POSIX one-liners (e.g.sh -c "$(curl ...)"install commands) remain asshell.Testing
Expected:
zi load,setopt,autoload,compinitall render with distinct token colors in ZSH code blocks.