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.

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

onHover and documentation improvements #230

Merged
merged 7 commits into from
May 6, 2020
Merged

Conversation

skovhus
Copy link
Collaborator

@skovhus skovhus commented Apr 27, 2020

Closes #221

Some iteration on the onHover and onCompletion documentation:

  • refactoring to centralize shared man / help commands
  • formatting of man pages (tested on GNU, POSIX, BSD)
  • onHover now also returns symbol information (similar to the onCompletion handler)
  • memorization

ls completion before and after

Notice the formatting of the man page.

_ ls completion before

_ ls completion after

ls hover before and after

Notice the formatting of the man page.

_ ls hover before

_ ls hover after

Variable hover before and after

Variable and function symbols in the current file and in the workspace it now returned on hover (similar to how they are returned on completion).

_ variable hover before

_ variable hover after

@skovhus skovhus marked this pull request as ready for review April 27, 2020 09:50
skovhus added 5 commits May 6, 2020 12:31
@skovhus skovhus force-pushed the documentation-improvements branch from 6866370 to 4d5d368 Compare May 6, 2020 10:32
@codecov
Copy link

codecov bot commented May 6, 2020

Codecov Report

Merging #230 into master will increase coverage by 1.01%.
The diff coverage is 64.51%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #230      +/-   ##
==========================================
+ Coverage   70.59%   71.61%   +1.01%     
==========================================
  Files          18       18              
  Lines         517      539      +22     
  Branches       81       87       +6     
==========================================
+ Hits          365      386      +21     
  Misses        131      131              
- Partials       21       22       +1     
Impacted Files Coverage Δ
server/src/builtins.ts 100.00% <ø> (+9.09%) ⬆️
server/src/executables.ts 90.62% <ø> (+1.73%) ⬆️
server/src/reservedWords.ts 100.00% <ø> (+40.00%) ⬆️
server/src/server.ts 57.14% <40.00%> (+2.17%) ⬆️
server/src/analyser.ts 80.27% <50.00%> (-0.55%) ⬇️
server/src/util/sh.ts 82.97% <82.85%> (-17.03%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 991ad3d...8777456. Read the comment docs.

@skovhus skovhus merged commit d03a676 into master May 6, 2020
@skovhus skovhus deleted the documentation-improvements branch May 6, 2020 10:37
akurtakov added a commit to akurtakov/shellwax that referenced this pull request May 27, 2020
Language server changelog:
1.16.1

    Fix brace expansion bug
(bash-lsp/bash-language-server#240)
    Do not crash if bash is not installed
(bash-lsp/bash-language-server#242)

1.16.0

    Improved completion handler for parameter expansions
(bash-lsp/bash-language-server#237)

1.15.0

    Use comments above symbols for documentation
(bash-lsp/bash-language-server#234,
bash-lsp/bash-language-server#235)

1.14.0

    onHover and onCompletion documentation improvements
(bash-lsp/bash-language-server#230)
    support 0/1 as values for HIGHLIGHT_PARSING_ERRORS
(bash-lsp/bash-language-server#231)

1.13.1

    Gracefully handle glob failures
(bash-lsp/bash-language-server#224,
bash-lsp/bash-language-server#226)
    Maintenance
(bash-lsp/bash-language-server#222,
bash-lsp/bash-language-server#225)


Signed-off-by: Alexander Kurtakov <[email protected]>
akurtakov added a commit to eclipse-shellwax/shellwax that referenced this pull request May 27, 2020
Language server changelog:
1.16.1

    Fix brace expansion bug
(bash-lsp/bash-language-server#240)
    Do not crash if bash is not installed
(bash-lsp/bash-language-server#242)

1.16.0

    Improved completion handler for parameter expansions
(bash-lsp/bash-language-server#237)

1.15.0

    Use comments above symbols for documentation
(bash-lsp/bash-language-server#234,
bash-lsp/bash-language-server#235)

1.14.0

    onHover and onCompletion documentation improvements
(bash-lsp/bash-language-server#230)
    support 0/1 as values for HIGHLIGHT_PARSING_ERRORS
(bash-lsp/bash-language-server#231)

1.13.1

    Gracefully handle glob failures
(bash-lsp/bash-language-server#224,
bash-lsp/bash-language-server#226)
    Maintenance
(bash-lsp/bash-language-server#222,
bash-lsp/bash-language-server#225)


Signed-off-by: Alexander Kurtakov <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extend onHover with symbol information
1 participant