search

csachs / pyproject-flake8

pyproject-flake8 (pflake8), a monkey patching wrapper to connect flake8 with pyproject.toml configuration
The Unlicense
170 stars 17 forks source link

Document "integration" with vscode flake8 plugin #26

Open MatrixManAtYrService opened 1 year ago

MatrixManAtYrService commented 1 year ago

Perhaps this should have been obvious, but you can tell the vscode flake8 plugin to call pflake8 by placing this in .vscode/settings.json (presuming that poetry creates venv's called .venv in your project root as it does for me).

{
    "flake8.importStrategy": "fromEnvironment",
    "flake8.path": [
        ".venv/bin/pflake8"
    ],
}

If you don't feel like putting this in the readme, even just having this closed issue lying around might be enough to make this solution searchable.

csachs commented 1 year ago

It can certainly be added to the README, do you like to open a PR or should I just add it?

MatrixManAtYrService commented 1 year ago

I'll leave it to you to decide where it fits. "Anywhere, even in the issues comments" already scratches my itch and I'm not sure how far along the "integrations with particular editors" path you want to go.

I mean, pyproject-flake8 does its job (and very nicely!) so it wouldn't be unreasonable to be a bit standoffish about documenting things that are not pyproject-flake8 (e.g. vscode).