Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implement auto-completion #56

Closed
hohwille opened this issue Sep 28, 2023 · 2 comments · Fixed by #187
Closed

Implement auto-completion #56

hohwille opened this issue Sep 28, 2023 · 2 comments · Fixed by #187
Assignees
@jan-vcapgemini
Labels
bash CLI IDEasy command-line-interface (parsing args, etc.) commandlet completion auto-completion in bash or build in CLI enhancement New feature or request
Milestone
release:2024.03.001

Comments

@hohwille
Copy link
Member

As a IDEasy user, I want to have command-line auto-completion so that I can be more productive and do not always have to read the help pages.

We had implemented this in devonfw-ide with manually bash scripts and the bash completion infrastructure.
My vision is that we pass the arguments to auto-complete directly into our Java main program.
So more or less Ide complete «args» would be called and we solve this with a CompleteCommandlet.
By finding the proper commandlet to invoke we can find its arguments and depending on their type automatically determine the possible options. That is why I prepared according specific Property sub-classes so that for a VersionProperty we know that a version-number is to be passed and from out tool-commandlet to be invoked, we can figure out the possible and matching versions.

BTW: This story is not easy and therefore not good for beginners. Also I learned that debugging auto-completion while using it is tricky as you can not use debug output to the console while pressing [Tab] key. It is therefore good to have an understanding of how auto-completion in bash works and then first have JUnits covering the different cases (completion of a single word where a prefix of that word is already given vs. a new word is started, etc.). If still some debugging is needed it is better to temporary write a log-file with the input and output of the auto-completion to later understand what went wrong and why... Good luck with this story :)
@hohwille hohwille added enhancement New feature or request bash commandlet labels Sep 28, 2023
@hohwille hohwille added this to the release:2024.01.001 milestone Sep 28, 2023
@github-project-automation github-project-automation bot moved this to 🆕 New in IDEasy board Sep 28, 2023
@jan-vcapgemini jan-vcapgemini self-assigned this Oct 6, 2023
@jan-vcapgemini jan-vcapgemini moved this from 🆕 New to Research in IDEasy board Oct 6, 2023
@jan-vcapgemini jan-vcapgemini mentioned this issue Oct 23, 2023
Closed
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Oct 23, 2023
@jan-vcapgemini
devonfw#56: added licenses
d7db2b0 
added jline license
added jansi license
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Oct 24, 2023
@jan-vcapgemini
devonfw#56: implemented requested changes
6c2652e 
added jline.version property to pom
fixed context based help command
removed AnsiConsole
@tobka777 tobka777 moved this from Research to 🏗 In progress in IDEasy board Oct 27, 2023
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Oct 31, 2023
@jan-vcapgemini
devonfw#56: completions up to level 3
6dc807b 
removed SystemRegistry and replaced with IdeCompleter
added options completion
added version completion
added tool completion
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Oct 31, 2023
@jan-vcapgemini
devonfw#56: added 1st tests
9996846 
added tests using tab completion
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Oct 31, 2023
@jan-vcapgemini
devonfw#56: cleanup and help completion
4d92d24 
added version number sorting
removed picocli example code
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Nov 2, 2023
@jan-vcapgemini
devonfw#56: fixed multiple initializations
fc68138 
fixed javadoc
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Nov 2, 2023
@jan-vcapgemini
devonfw#56: fixed some issues
986dcc6 
fixed version number sorting
removed used option and alias
removed jansi dependency
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Nov 7, 2023
@jan-vcapgemini
devonfw#56: implemented options completion
22991e4 
implemented first version of option completion with cleanup of used options
converted commandletOptions from String to actual Property
adjusted tests
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Nov 7, 2023
@jan-vcapgemini
devonfw#56: removed findSubCommandlet
3e99f66
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Nov 7, 2023
@jan-vcapgemini
devonfw#56: moved tests to cli
047abe8
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Nov 7, 2023
@jan-vcapgemini
devonfw#56: added new constant
67b35db 
added new constant for maximum results to display
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Nov 7, 2023
@jan-vcapgemini
devonfw#56: refactored Ide class
2f95364 
adjusted visibility of applyAndRun to private
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Nov 20, 2023
@jan-vcapgemini
devonfw#56: added support for options
e97a52d 
added setLogLevel method to AbstractIdeContext
added loggerFactory class variable to AbstractIdeContext
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Nov 20, 2023
@jan-vcapgemini
devonfw#56: combined options and tool commands completion
0d7af44 
added test for prevention of options after command
added test which handles options before a command
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Nov 20, 2023
@jan-vcapgemini
devonfw#56: fixed version test
cc1a165
@tobka777 tobka777 moved this from 🏗 In progress to Team Review in IDEasy board Nov 21, 2023
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Nov 21, 2023
@jan-vcapgemini
devonfw#56: changed visibility of addCandidates
7334b5e
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Nov 21, 2023
@jan-vcapgemini
devonfw#56: refactored ReaderTestSupport
3ed6dd4 
renamed ReaderTestSupport to AutocompletionReaderTestSupport
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Nov 21, 2023
@jan-vcapgemini
devonfw#56: removed jansi from LICENSE
31d7571
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Nov 21, 2023
@jan-vcapgemini
devonfw#56: removed CompleteCommandlet
4bc8ce1
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Dec 12, 2023
@jan-vcapgemini
devonfw#56: refactored invalid pattern
223e364 
split pattern into several parts
added patternCompiled constant
changed checkInvalidPattern param to String
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Dec 14, 2023
@jan-vcapgemini
devonfw#56: adjusted exception handling
776689b 
made sure that all exceptions get catched and reported with an error message
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Dec 14, 2023
@jan-vcapgemini
devonfw#56: optimized check for invalid patterns
7f7a207 
moved check for invalid patterns to the top to stop autocomplete early before doing other stuff
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Dec 14, 2023
@jan-vcapgemini
devonfw#56: implemented requested change
37005ee 
added another try block for catching run CLI exceptions
@hohwille hohwille added completion auto-completion in bash or build in CLI CLI IDEasy command-line-interface (parsing args, etc.) labels Jan 4, 2024
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Jan 8, 2024
@jan-vcapgemini
devonfw#56: implemented requested change
79fde21 
renamed initializeJlineCompletion to runWithInteractiveCompletion and adjusted comments
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Jan 8, 2024
@jan-vcapgemini
devonfw#56: implemented requested change
ba1ae7d 
replaced redundant code with setLogLevel(minLogLevel)
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Jan 8, 2024
@jan-vcapgemini
devonfw#56: implemented requested changes
2460b74 
adjusted TODO's (added link to issues)
removed commented code
moved processCliArgument into else block
added error codes in case of exceptions
changed runWithInteractiveCompletion from void to int to be able to use error codes
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Jan 8, 2024
@jan-vcapgemini
devonfw#56: implemented requested changes
72d79d4 
replaced Throwable with Exception
renamed retrieveCliArgument to initContext
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Jan 8, 2024
@jan-vcapgemini
devonfw#56: implemented requested changes
ce01b3c 
replaced -v and --version with VersionCommandlet
fixed CTRL+D missing return and exit code
added test for VersionCommandlet autocompletion
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Jan 8, 2024
@jan-vcapgemini
devonfw#56: implemented requested change
635e7a6 
changed to more descriptive name and description
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Jan 8, 2024
@jan-vcapgemini
devonfw#56: fixed HelpCommandlet test
82cf24d 
removed -v and --version
jan-vcapgemini added a commit to jan-vcapgemini/IDEasy that referenced this issue Jan 9, 2024
@jan-vcapgemini
devonfw#56: implemented requested change
c2d4f5b 
removed CommandletRegistry
hohwille added a commit to hohwille/IDEasy that referenced this issue Jan 10, 2024
@hohwille
devonfw#56: autocompletion redesign
64db525
@hohwille hohwille mentioned this issue Jan 10, 2024
Merged
hohwille added a commit to hohwille/IDEasy that referenced this issue Jan 11, 2024
@hohwille
devonfw#56: fixed autocompletion. Seems I should remove CliArgument «…
5ddf9da 
…start» and redesign CliArguments again as it does not feel consistent but rather hacky
hohwille added a commit to hohwille/IDEasy that referenced this issue Jan 15, 2024
@hohwille
devonfw#56: fixed version sorting
7f7e4cd
hohwille added a commit to hohwille/IDEasy that referenced this issue Jan 22, 2024
@hohwille
devonfw#56: implement auto-completion for bash via CompleteCommandlet
8e22fd3
@hohwille hohwille linked a pull request Jan 22, 2024 that will close this issue
#56: completion bash only #187
Merged
jan-vcapgemini added a commit to hohwille/IDEasy that referenced this issue Jan 23, 2024
@jan-vcapgemini
devonfw#56: implemented requested changes
42ea369 
fixed typo
added TODO
hohwille added a commit that referenced this issue Jan 23, 2024
@hohwille
#56: completion bash only (#187)
4327271
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in IDEasy board Jan 23, 2024
@hohwille hohwille mentioned this issue Jan 23, 2024
Closed
hohwille added a commit to hohwille/IDEasy that referenced this issue Jan 25, 2024
@hohwille
devonfw#56: improved prompt
153399d
hohwille added a commit to hohwille/IDEasy that referenced this issue Jan 26, 2024
@hohwille
devonfw#56: cleanup of jline shell
afc1d52
This was referenced Feb 15, 2024
Closed
Open
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jan-vcapgemini jan-vcapgemini

Labels
bash CLI IDEasy command-line-interface (parsing args, etc.) commandlet completion auto-completion in bash or build in CLI enhancement New feature or request
Projects
IDEasy board
Status: ✅ Done
Milestone
release:2024.03.001
Development

Successfully merging a pull request may close this issue.

#56: completion bash only hohwille/IDEasy
#56 implement autocompletion jan-vcapgemini/IDEasy
2 participants
@hohwille @jan-vcapgemini