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

[ENHANCE]: Error message for plugin. #4441

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+19 −7
Open

[ENHANCE]: Error message for plugin. #4441

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
94f6334
(fix): error message for plugin
Typocalypse Aug 22, 2024
ac2c9c8
(refactor): define func only if checks fail
Typocalypse Aug 23, 2024
9b41eff
Merge branch 'main' into typocalypse/fix_plugin_error
Typocalypse Aug 26, 2024
1a777ca
Fully support Python 3.13, including CI testing and wheel building (#…
EwoutH Aug 26, 2024
9d48c4d
(chore): improve branching
Typocalypse Aug 26, 2024
97c7f23
Merge branch 'main' into typocalypse/fix_plugin_error
Typocalypse Aug 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions plugin/black.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,28 @@ if exists("g:load_black")
finish
endif

if v:version < 700 || !has('python3')
func! __BLACK_MISSING()
echo "The black.vim plugin requires vim7.0+ with Python 3.6 support."
endfunc
command! Black :call __BLACK_MISSING()
command! BlackUpgrade :call __BLACK_MISSING()
command! BlackVersion :call __BLACK_MISSING()
" check if vim version is too old
if v:version < 700
echo "The black.vim plugin requires Vim 7.0+."
finish
endif

" check if Vim has Python 3 support
if !has('python3')
echo "The black.vim plugin requires Vim compiled with Python 3.8+ support."
finish
endif
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will hide the version requirements if python3 support is not available. I think it will be more useful to use:

if v:version < 700
    ...
elseif !has('python3')
    ...
endif

Of course with this if you had very old vim and you get vim 7+ without python3 support you will find about the python3 support on the second try. The current error message avoid this issue by displaying both requirements, but fail to explain what is the actual issue.

We can do something like this:

Vim is too old:

Vim {version} is too old.
The black.vim plugin requires Vim 7.0+ with python3 support.

Python3 is missing:

Python3 support is not available.
The black.vim plugin requires Vim 7.0+ with python3 support.


" define commands inly if all checks are passed
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

inly -> only?

func! BlackNotSupported()
echo "The black.vim plugin cannot be used with this Vim executable."
endfunc
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like this function is defined when both check pass, but it should be define only if any of the checks did not pass.

Also BlackNotSupported looks like a public name that a user may call from the vim prompt line. The original function has a __ prefix.

How about something like this:

if version is too:
    define __BlackNotSupported with version error message
elif python3 suppoort is mising:
    define __BlackNotSupported with python3 error message

if __BlackNotSupported is defined:
    define Black, BlackUpgrade, BlackVersion functions

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for you suggestion.


command! Black :call BlackNotSupported()
command! BlackUpgrade :call BlackNotSupported()
command! BlackVersion :call BlackNotSupported()


let g:load_black = "py1.0"
if !exists("g:black_virtualenv")
if has("nvim")
Expand Down