Open elliot-100 opened 5 months ago
@elliot-100 I saw your issue + comments in the other repo, only just found my way here.
Dropping the link to my issue over there as it's related: https://github.com/isort/isort-action/issues/91 (lacking/mismatched docs on the website) No clue why they created a separate org for just the action, with zero backlinks to here...
I ran into the 'how do you make isort compatible with black' problem, and while I think I've resolved my issue via https://github.com/PyCQA/isort/issues/1518, I think part of the problem is that the documentation doesn't tell you how to set most configuration flags when using Github actions or pre-commit.
GitHub actions
From https://pycqa.github.io/isort/docs/configuration/github_action.html:
This seems to need an example of setting a few configuration flags. I suggest in the interests of DRY, one should be how to get config from
pyproject.toml
.This part of https://github.com/isort/isort-action/blob/master/README.md seems to be identical.
pre-commit
https://pycqa.github.io/isort/docs/configuration/pre-commit.html doesn't seem to have any configuration examples in the code at all. Again perhaps one should be how to get config from
pyproject.toml
.Although https://pycqa.github.io/isort/docs/configuration/black_compatibility.html does have this (doesn't have a corresponding example for GitHub actions though, I think it should):
I am happy to submit a PR even if it is a strawman.