Autocomplete #2023
Autocomplete #2023
Conversation
| $local_machine_helper = $this->getContainer()->get(LocalMachineHelper::class); | ||
| if (!$local_machine_helper->getFilesystem()->exists($filename)) { | ||
| throw new TerminusNotFoundException( | ||
| 'Please generate the autocomplete script using the `composer autocomplete:build` command.' |
There was a problem hiding this comment.
Should there be a different message if you are running Terminus via a PHAR?
There was a problem hiding this comment.
in theory the Phar should have the compiled/cached autocomplete script that's generated during the build process, this is for someone running the composer version
| */ | ||
| protected function getFilename() | ||
| { | ||
| return $this->config->get('assets_dir') . "/autocomplete.txt"; |
There was a problem hiding this comment.
This should go into the cache dir. The assets dir holds the ASCII art.
There was a problem hiding this comment.
I'll adjust the location
There was a problem hiding this comment.
@TeslaDethray so my intent with this was to cache the autocomplete script so it could be included with the Phar instead of including all the libraries used to generate it. The cache dir looks like it's user specific, and wouldn't be bundled into the phar. Would it make sense to create a separate folder just for caching the autocomplete script?
| $autocomplete = shell_exec('symfony-autocomplete bin/terminus'); | ||
| file_put_contents('assets/autocomplete.txt', $autocomplete); | ||
| } else { | ||
| echo "Please install dev dependencies, or run composer global require bamarni/symfony-console-autocomplete"; |
There was a problem hiding this comment.
The project in question recommends composer global require, but we should not.
There was a problem hiding this comment.
Oh, never mind. bamarni/symfony-console-autocomplete has no dependencies, so it's actually safe to use it with composer global require.
There was a problem hiding this comment.
yeah, my assumption is that almost no one will ever run this, most people will get this via the CI generated Phar file. This will only be needed using Terminus via composer
|
Would love to see this merged. In the meantime @nullvariable or @stevector can you educate my noob self on how the composer solution works? Do I need to install composer on all the machines i want autocomplete to work with or just on the client i am SSH'ing from? This seems like a pretty big oversight on the termius devs part. Thanks for any help! TAB autocomplete === 👼 |
|
@dwasyluk composer is only needed if you're building terminus from source. If you're using the packaged Right now to use this branch you would have to install composer and generate the phar file yourself, but that phar is portable and you could use on any machine with php. Once this is completed and merged the build process will generate all of this for you. |
|
Hey @nullvariable: I just now noticed this PR. Nice work! If it helps any, I have created an autocomplete terminus plugin. See https://github.com/terminus-plugin-project/terminus-autocomplete-plugin. It would be cool if we could collaborate and combine our ideas. |
Adds a feature for #1595
Provides an autocomplete feature compatible with zsh and bash-completion. Allows for easy tab completion in supported shells.
I may have over complicated this, but in order to minimize the distribution size I've adopted a strategy for caching the autocomplete script. This allows us to only generate the autocomplete script when building the phar file, since we don't need the script to be dynamic. I suppose one downside of this is that it may not pickup plugins.
Very open to additional thoughts and improvements. Currently requires that you set the following in your
.zshrcfile: