-
Notifications
You must be signed in to change notification settings - Fork 391
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- This adds basic zsh support similarly to existing bash completion - New command "completion zsh" - Fix internal recursive command completion model for cases with deep nested commands - Backport #927 - Fixes #929
- Loading branch information
Showing
6 changed files
with
486 additions
and
65 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
41 changes: 41 additions & 0 deletions
41
...-standard/src/main/java/org/springframework/shell/standard/completion/ZshCompletions.java
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| /* | ||
| * Copyright 2023 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.springframework.shell.standard.completion; | ||
|
|
||
| import org.springframework.core.io.ResourceLoader; | ||
| import org.springframework.shell.command.CommandCatalog; | ||
|
|
||
| /** | ||
| * Completion script generator for a {@code zsh}. | ||
| * | ||
| * @author Janne Valkealahti | ||
| */ | ||
| public class ZshCompletions extends AbstractCompletions { | ||
|
|
||
| public ZshCompletions(ResourceLoader resourceLoader, CommandCatalog commandCatalog) { | ||
| super(resourceLoader, commandCatalog); | ||
| } | ||
|
|
||
| public String generate(String rootCommand) { | ||
| CommandModel model = generateCommandModel(); | ||
| return builder() | ||
| .attribute("name", rootCommand) | ||
| .attribute("model", model) | ||
| .group("classpath:completion/zsh.stg") | ||
| .appendGroup("main") | ||
| .build(); | ||
| } | ||
| } |
89 changes: 89 additions & 0 deletions
89
spring-shell-standard/src/main/resources/completion/zsh.stg
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| // | ||
| // pre content template before commands | ||
| // needs to escape some > characters | ||
| // | ||
| pre(name) ::= << | ||
| #compdef _<name> <name> | ||
| >> | ||
|
|
||
| // | ||
| // commands section with command and description | ||
| // | ||
| cmd_and_desc(command) ::= << | ||
| "<command.mainCommand>:<command.description>" | ||
| >> | ||
|
|
||
| // | ||
| // case for command to call function | ||
| // | ||
| cmd_func(name,command) ::= << | ||
| <command.mainCommand>) | ||
| _<name>_<command.commandParts:{p | <p>}; separator="_"> | ||
| ;; | ||
| >> | ||
|
|
||
| // | ||
| // recursive sub commands | ||
| // | ||
| sub_command(name,command,commands) ::= << | ||
| function _<name>_<command.commandParts:{p | <p>}; separator="_"> { | ||
| local -a commands | ||
|
|
||
| _arguments -C \ | ||
| <command.flags:{f | "<f>" \\}; separator="\n"> | ||
| "1: :->cmnds" \ | ||
| "*::arg:->args" | ||
|
|
||
| case $state in | ||
| cmnds) | ||
| commands=( | ||
| <commands:{c | <cmd_and_desc(c)>}; separator="\n"> | ||
| ) | ||
| _describe "command" commands | ||
| ;; | ||
| esac | ||
|
|
||
| case "$words[1]" in | ||
| <commands:{c | <cmd_func(name,c)>}; separator="\n"> | ||
| esac | ||
| } | ||
|
|
||
| <commands:{c | <sub_command(name,c,c.commands)>}; separator="\n\n"> | ||
| >> | ||
|
|
||
| // | ||
| // top level commands | ||
| // | ||
| top_commands(name,commands) ::= << | ||
| function _<name> { | ||
| local -a commands | ||
|
|
||
| _arguments -C \ | ||
| "1: :->cmnds" \ | ||
| "*::arg:->args" | ||
|
|
||
| case $state in | ||
| cmnds) | ||
| commands=( | ||
| <commands:{c | <cmd_and_desc(c)>}; separator="\n"> | ||
| ) | ||
| _describe "command" commands | ||
| ;; | ||
| esac | ||
|
|
||
| case "$words[1]" in | ||
| <commands:{c | <cmd_func(name,c)>}; separator="\n"> | ||
| esac | ||
| } | ||
|
|
||
| <commands:{c | <sub_command(name,c,c.commands)>}; separator="\n\n"> | ||
| >> | ||
|
|
||
| // | ||
| // main template to call from render | ||
| // | ||
| main(name, model) ::= << | ||
| <pre(name)> | ||
|
|
||
| <top_commands(name,model.commands)> | ||
| >> |
Oops, something went wrong.