Skip to content

Improve vim plugin error message #4772

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

Merged
cobaltt7 merged 5 commits into from
Oct 5, 2025
Merged

Improve vim plugin error message #4772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7810a37
Improve vim plugin error message
sgaist Oct 4, 2025
d82a9e2
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 4, 2025
ad2ed60
Update CHANGES.md
cobaltt7 Oct 5, 2025
317ef46
Merge branch 'main' into feat/improve-vim-plugin-error-message
cobaltt7 Oct 5, 2025
4663662
Update CHANGES.md
cobaltt7 Oct 5, 2025
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
2 changes: 2 additions & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@

- Enhance GitHub Action `psf/black` to support the `required-version` major-version-only
"stability" format when using pyproject.toml (#4770)
- Improve error message for vim plugin users. It now handles independently vim version
- Vim: Warn on unsupported Vim and Python versions independently (#4772)
- Vim: Print the import paths when importing black fails (#4675)
- Vim: Fix handling of virtualenvs that have a different Python version (#4675)

Expand Down
19 changes: 14 additions & 5 deletions plugin/black.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,21 @@ if exists("g:load_black")
endif

if v:version < 700 || !has('python3')
func! __BLACK_MISSING()
echo "The black.vim plugin requires vim7.0+ with Python 3.9 support."
func! __ERROR()
let messages = []

if v:version < 700
call add(messages, "vim7.0+")
endif
if !has('python3')
call add(messages, "Python 3.9 support")
endif

echo "The black.vim plugin requires" join(messages, " and ")
endfunc
command! Black :call __BLACK_MISSING()
command! BlackUpgrade :call __BLACK_MISSING()
command! BlackVersion :call __BLACK_MISSING()
command! Black :call __ERROR()
command! BlackUpgrade :call __ERROR()
command! BlackVersion :call __ERROR()
finish
endif

Expand Down