clink-completions
clink-completions copied to clipboard
vladimir-kotikov
Adding suppport for gulpjs
See gulpjs.com.
When there is a local gupfile in current working directory, command prompt has a prefix [gulp] and completions shows up available tasks.
Otherwise there completions show --version and --gulpfile command. When the later one is used with valid remote gulpfile, completions again show its available tasks.
By mistake I created feature branch based on my master branch already containing a #44 bugfix which is not merged yet here. If it's a problem, let me know.
@piotr-cz, it's ok, and i can just cherry-pick https://github.com/piotr-cz/clink-completions/commit/aaafc87af66fe800f9e5a11a952d7be99ff1f712 to master
I'm testing it now and i see there is some problems with performance. I have a gulpfile with over 20 tasks and double TAB takes ~10 seconds to display available tasks. I need to take a look more thoroughly into it before i'll merge it
It takes about ~2s on my machine for 10 tasks. Each time when pressing tab key the interface is frozen.
Please try to execute tasks manually using gulp --tasks-simple and compare difference in performance - for me this takes similar amount of time as when using completion and IMHO the performance issue is in Gulp.
You may try using the --no-color and --silent flags, maybe these could improve the speed.
The node process is being executed 2x - the first time just to find out that there is more than one option so interface doesn't show anything output at all. Probably this could be worked out by returning empty table on first run or caching the results for second run . But both solutions are non-standard.
I'm using gulp v3.9, apparenty it's possible to install v4 brach releases using npm install gulpjs/gulp#4.0 -g. Maybe performance has improved there.
I've also just noticed that gulpjs has some completions available, including PowerShell. I'll check if some things may be ported to clink completion.
Another option would be to manually look up gulpfile.js for gulp.task('taskName', strings
Ah, I didn't notice that you are running gulp to get tasks list. This is indeed a thing, that causes these performance gaps. I'd recommend to look at parsing gulpfile, as you suggested.
An example of this approach is npm run completions here: https://github.com/vladimir-kotikov/clink-completions/blob/master/npm.lua#L62-L96
I'm not sure that running a regex on javascript file is good idea. I mean, what if for example the gulp.task call will be commented?
Other gulpjs completion implemetations use same method to retrieve tasks by calling --tasks-simple
Yep, also Powershell stuff uses caching, based on gulpfile's shasum, which, i guess, improves performance dramatically, as they don't need to run gulp each time to get tasks list.
Codecov Report
Merging #45 into master will not change coverage. The diff coverage is
n/a.
@@ Coverage Diff @@
## master #45 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 2 2
Lines 56 56
=====================================
Hits 56 56
Continue to review full report at Codecov.
Legend - Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,? = missing dataPowered by Codecov. Last update 34d3c0c...02f6677. Read the comment docs.
I'm willing to help make changes to this script, in order to be able to include it.
I have some questions and suggestions after reviewing the script:
Re: prompt --
Forcibly adding to the prompt isn't compatible with many custom prompts. That will need to at least be configurable, and maybe off by default.
Re: parsers --
The script tells Clink to merge 3 parsers with different syntaxes. It seems that probably isn't going to have quite the desired outcome. It's probably better to write a single parser with the desired syntax.
Newer versions of Clink have features that make it easier to use the value from the --gulpfile flag, and find it anywhere in the command line, and support multiple commands in the command line (e.g. using & to join them). See Responding to Arguments in Argmatchers.
Is there a default gulpfile that can be assumed when there's no --gulpfile flag present?