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

Example of using pylint as a pre-commit hook does not mention use of spelling extra #9465

Closed
ssbarnea opened this issue Feb 26, 2024 · 1 comment · Fixed by #9463
Closed

Comments

@ssbarnea
Copy link
Contributor

ssbarnea commented Feb 26, 2024

Bug description

At this moment there is no documentation on how to install the spelling extra when defining the pylint pre-commit hook. Just adding a pyenchant inside additional_dependencies does risk installing a version that is not compatible with the runtime requirements from https://github.com/pylint-dev/pylint/blob/main/pyproject.toml#L56

Configuration

No response

Command used

-

Pylint output

-

Expected behavior

Pylint version

-

OS / Environment

No response

Additional dependencies

No response

@ssbarnea ssbarnea added the Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling label Feb 26, 2024
@Pierre-Sassoulas
Copy link
Member

In the doc we have a pre-commit installation guide: https://pylint.readthedocs.io/en/latest/user_guide/installation/pre-commit-integration.html#pre-commit-integration, where we suggest to use a local installation (where the install would supposedly be pip install pylint[spelling] if using pyenchant). I don't like the additional_dependencies solution because it's duplicating the dependencies between pre-commit config and the default packaging (pre-commit is never going to support editable install afair). We're going to upgrade the pre-commit doc in #9463, we could detail what to do if you feel it's necessary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants