├── project ├── build.properties └── plugins.sbt ├── .gitignore ├── .scalafmt.conf ├── scala-native.nix ├── src ├── main │ └── scala │ │ ├── net │ │ └── andimiller │ │ │ └── decline │ │ │ └── completion │ │ │ └── Completion.scala │ │ └── com │ │ └── monovore │ │ └── decline │ │ └── completion │ │ └── Folder.scala └── test │ └── scala │ └── net │ └── andimiller │ └── decline │ └── completion │ └── CompletionSpec.scala ├── README.md └── LICENSE /project/build.properties: -------------------------------------------------------------------------------- 1 | sbt.version = 1.9.3 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .bsp 2 | target 3 | project/project 4 | .jvm 5 | .native 6 | .js 7 | -------------------------------------------------------------------------------- /.scalafmt.conf: -------------------------------------------------------------------------------- 1 | version = 3.5.9 2 | align.preset = most 3 | maxColumn = 140 4 | rewrite.rules = [SortImports] 5 | runner.dialect = scala213source3 6 | -------------------------------------------------------------------------------- /scala-native.nix: -------------------------------------------------------------------------------- 1 | let 2 | pkgs = import {}; 3 | stdenv = pkgs.stdenv; 4 | in rec { 5 | clangEnv = stdenv.mkDerivation rec { 6 | name = "clang-env"; 7 | shellHook = '' 8 | alias cls=clear 9 | ''; 10 | LLVM_BIN = pkgs.clang + "/bin"; 11 | buildInputs = with pkgs; [ 12 | stdenv 13 | sbt 14 | openjdk 15 | boehmgc 16 | libunwind 17 | clang 18 | zlib 19 | s2n 20 | nodejs 21 | ]; 22 | }; 23 | } 24 | -------------------------------------------------------------------------------- /project/plugins.sbt: -------------------------------------------------------------------------------- 1 | addSbtPlugin("com.eed3si9n" % "sbt-projectmatrix" % "0.9.0") 2 | addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.13.2") 3 | addSbtPlugin("org.scala-native" % "sbt-scala-native" % "0.4.14") 4 | addSbtPlugin("org.portable-scala" % "sbt-scala-native-crossproject" % "1.2.0") 5 | addSbtPlugin("org.portable-scala" % "sbt-scalajs-crossproject" % "1.2.0") 6 | addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.0") 7 | addSbtPlugin("org.xerial.sbt" % "sbt-sonatype" % "2.4") 8 | addSbtPlugin("com.jsuereth" % "sbt-pgp" % "1.1.0") 9 | -------------------------------------------------------------------------------- /src/main/scala/net/andimiller/decline/completion/Completion.scala: -------------------------------------------------------------------------------- 1 | package net.andimiller.decline.completion 2 | 3 | import cats.implicits._ 4 | import com.monovore.decline._ 5 | import com.monovore.decline.completion.Folder 6 | 7 | object Completion { 8 | 9 | def bashCompletion(c: Command[_]): String = { 10 | val model = Folder.buildModel(c) 11 | val conditions = model.completionTree().toList.sortBy(-_._1.size).map { case (path, wordsWithHelp) => 12 | val (words, _) = wordsWithHelp.separate 13 | val cond = path.reverse.zipWithIndex 14 | .map { case (cmd, idx) => 15 | s"\"$${cmds[$idx]}\" = \"$cmd\"" 16 | } 17 | .mkString("[[ ", " && ", " ]]") 18 | s"""if $cond; then 19 | | COMPREPLY=( $$(compgen -W '${words.mkString(" ")}' -- "$$cur")) 20 | | return 21 | |fi 22 | |""".stripMargin 23 | } 24 | 25 | s""" 26 | |_${c.name}() 27 | |{ 28 | |local cmds=($${COMP_WORDS[@]//-*}) # Filter out any flags or options 29 | |local cur 30 | |if [[ "$$SHELL" =~ ".*zsh" ]]; then 31 | | cur=$$COMP_CWORD 32 | |else 33 | | cur=`_get_cword` 34 | |fi 35 | |${conditions.mkString("\n")} 36 | |} 37 | |complete -F _${c.name} ${c.name} 38 | |""".stripMargin 39 | } 40 | 41 | def zshBashcompatCompletion(c: Command[_]): String = 42 | """autoload bashcompinit 43 | |bashcompinit 44 | |""".stripMargin + bashCompletion(c) 45 | 46 | } 47 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # decline-completion 2 | A module for the decline command line parser to enable bash and zsh autocomplete 3 | 4 | ## Caveats 5 | 6 | This is currently oriented around supporting command line interfaces with a lot of subcommands, and will traverse the tree and expose options available on each subcommand for autocomplete. 7 | 8 | If you heavily use shared configuration options which are not attached to subcommands, be aware these are currently not supported, but may be in a future release. 9 | 10 | ## Usage 11 | 12 | Add the dependency, currently available for JVM, JS and Native: 13 | 14 | ```scala 15 | libraryDependencies ++= List( 16 | "net.andimiller" %%% "decline-completion" % "0.0.2" 17 | ) 18 | ``` 19 | 20 | Add a new subcommand that can expose the output from this library: 21 | 22 | ```scala 23 | lazy val othercommand = Opts.subcommand("???", "???").as(???) 24 | 25 | lazy val completion = Opts.subcommand("completion", "output autocompletion scripts for common shells") { 26 | val bash = Opts.subcommand("bash", "output autocompletion script for bash").as( 27 | IO.println( 28 | Completion.bashCompletion(cli) 29 | ) 30 | ) 31 | val bash = Opts.subcommand("bash", "output autocompletion script for bash").as( 32 | IO.println( 33 | Completion.zshBashcompatCompletion(cli) 34 | ) 35 | ) 36 | 37 | } 38 | 39 | lazy val cli = Command("myprogram", "my program does things") { 40 | othercommand orElse completion 41 | } 42 | ``` 43 | 44 | Then call it on the command line to use it: 45 | 46 | ### bash 47 | 48 | ```sh 49 | myprogram completion bash > myprogram-completion.bash 50 | source myprogram-completion.bash 51 | ``` 52 | 53 | ### zsh 54 | 55 | ```sh 56 | myprogram completion zsh > myprogram-completion.zsh 57 | source myprogram-completion.zsh 58 | ``` 59 | -------------------------------------------------------------------------------- /src/test/scala/net/andimiller/decline/completion/CompletionSpec.scala: -------------------------------------------------------------------------------- 1 | package net.andimiller.decline.completion 2 | 3 | import cats.effect.IO 4 | import cats.implicits._ 5 | import com.monovore.decline.completion.Folder 6 | import com.monovore.decline.completion.Folder.CompleteableCommand 7 | import com.monovore.decline.{Command, Opts} 8 | import munit.CatsEffectSuite 9 | 10 | class CompletionSpec extends CatsEffectSuite { 11 | test("Folder should fold a cli into a model we can use") { 12 | val cli = Command("foo", "the foo command") { 13 | (Opts.argument[String]("file.txt"), Opts.flag("verbose", "enable verbose logs").orNone.map(_.isDefined)).mapN { case (f, v) => 14 | 123 15 | } 16 | } 17 | IO { 18 | Folder.buildModel(cli) 19 | }.assertEquals( 20 | CompleteableCommand( 21 | "foo", 22 | "the foo command", 23 | List("--help" -> "Print help and usage information.", "--verbose" -> "enable verbose logs"), 24 | List("file.txt") 25 | ) 26 | ) 27 | } 28 | test("Completion should be able to produce zsh and bash scripts") { 29 | val deeper = Command("binary", "help") { 30 | val number = Opts.argument[Int]("n") 31 | val verbose = Opts.flag("verbose", "enable verbose debug logs").orFalse 32 | val extraFlag = Opts.flag("extra-flag", "extra flag only on add, with a short form", "e") 33 | val add = Opts.subcommand("add", "add two numbers") { 34 | (number, number, verbose, extraFlag).mapN { case (a, b, v, _) => 35 | if (v) println(s"adding $a and $b") 36 | println(a + b) 37 | } 38 | } 39 | val multiply = Opts.subcommand("multiply", "multiply two numbers") { 40 | (number, number, verbose).mapN { case (a, b, v) => 41 | if (v) println(s"multiplying $a and $b") 42 | println(a * b) 43 | } 44 | } 45 | add orElse multiply 46 | } 47 | IO { 48 | Completion.bashCompletion(deeper) 49 | Completion.zshBashcompatCompletion(deeper) 50 | } 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /src/main/scala/com/monovore/decline/completion/Folder.scala: -------------------------------------------------------------------------------- 1 | package com.monovore.decline.completion 2 | 3 | import cats.implicits._ 4 | import com.monovore.decline.Opts.Name 5 | import com.monovore.decline.{Command, Opt, Opts} 6 | 7 | object Folder { 8 | 9 | case class CompleteableCommand( 10 | name: String, 11 | help: String, 12 | flags: List[(String, String)] = Nil, 13 | arguments: List[String] = Nil, 14 | subcommands: List[CompleteableCommand] = Nil 15 | ) { 16 | 17 | private def completionTree(path: List[String])(c: CompleteableCommand): Map[List[String], List[(String, String)]] = { 18 | val here = c.name :: path 19 | val completions = c.flags ++ c.subcommands.map(s => s.name -> s.help) 20 | c.subcommands 21 | .map { s => 22 | completionTree(here)(s) 23 | } 24 | .fold(Map(here -> completions)) { case (m, n) => m ++ n } 25 | } 26 | 27 | def completionTree(): Map[List[String], List[(String, String)]] = completionTree(List.empty)(this) 28 | } 29 | 30 | type Modifier = CompleteableCommand => CompleteableCommand 31 | 32 | def nameToString(n: Name): String = n match { 33 | case Opts.LongName(flag) => "--" + flag 34 | case Opts.ShortName(flag) => "-" + flag 35 | } 36 | 37 | def one(p: Opt[_]): Modifier = p match { 38 | case Opt.Regular(names, metavar, help, visibility) => 39 | c => c.copy(flags = c.flags ++ names.map(nameToString).tupleRight(help)) 40 | case Opt.OptionalOptArg(names, _, _, _) => 41 | c => c.copy(arguments = c.arguments ++ names.map(nameToString)) 42 | case Opt.Flag(names, help, visibility) => 43 | c => c.copy(flags = c.flags ++ names.map(nameToString).tupleRight(help)) 44 | case Opt.Argument(metavar) => 45 | c => c.copy(arguments = c.arguments ++ List(metavar)) 46 | } 47 | 48 | def many(p: Opts[_]): Modifier = p match { 49 | case Opts.Pure(_) => identity 50 | case Opts.HelpFlag(a) => 51 | c => c.copy(flags = c.flags.prepended("--help", "Print help and usage information.")) 52 | case Opts.App(f, a) => 53 | many(f) andThen many(a) 54 | case Opts.OrElse(a, b) => 55 | many(a) andThen many(b) 56 | case Opts.Single(opt) => 57 | one(opt) 58 | case Opts.Repeated(opt) => 59 | one(opt) 60 | case Opts.Validate(a, _) => 61 | many(a) 62 | case Opts.Subcommand(s) => 63 | c => c.copy(subcommands = c.subcommands.prepended(buildModel(s))) 64 | case _: Opts.Env => identity 65 | case _ => identity 66 | } 67 | 68 | def buildModel(c: Command[_]): CompleteableCommand = 69 | many(c.options)(CompleteableCommand(c.name, c.header)) 70 | 71 | } 72 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------