Lint on GitHub Actions via pre-commit

[hugovk]

Follow on from #100.

[AlexWaygood]

In general I prefer to use pre-commit.ci, but I know that this is easier to setup in that it doesn't require giving the pre-commit.ci bot permissions on this repo :)

[hugovk]

why-not-both.gif? :)

People who fork this repo might enable the CI for testing for their fork, and find lint issues sooner. (And not every lint issue is auto-fixable when a PR is opened.)

Fail fast.

[AlexWaygood]

why-not-both.gif? :)

no reason except CO2 emissions :)

[AlexWaygood]

I'm a fan of autofixes, so we could add fix = true for local use. But we can leave adding that to a followup PR; we'd want to check exactly which rules we're okay with being autofixed etc.

[JulienPalard]

I never got hooked to pre-commits, they felt too slow for me. But with only ruff and black and the few fast things that will get skipped most of the times, it should be OK, I'm willing to try :)

LGTM.

[AlexWaygood]

LGTM, thanks!

[AlexWaygood]

Possibly we could enable this setting for black. I don't much like the magic trailing comma, and I think most of the current black maintainers don't really like it much either. But I also don't care that much, if you disagree :)

Suggested change

	[tool.black]
	[tool.black]
	skip-magic-trailing-comma = true

[hugovk]

I don't mind too much. This is the only change it would make:

diff --git a/sphinxlint/cli.py b/sphinxlint/cli.py
index c0a5638..0cab6d4 100644
--- a/sphinxlint/cli.py
+++ b/sphinxlint/cli.py
@@ -76,11 +76,7 @@ def parse_args(argv=None):
         help="verbose (print all checked file names)",
     )
     parser.add_argument(
-        "-i",
-        "--ignore",
-        action="append",
-        help="ignore subdir or file path",
-        default=[],
+        "-i", "--ignore", action="append", help="ignore subdir or file path", default=[]
     )
     parser.add_argument(
         "-d",

I can see there could be value keeping it, if we wanted to make sure each parser.add_argument block had each arg on its own line. 🤷

[AlexWaygood]

I'd personally vote for my suggestion above^, but no strong opinion either way. Feel free to merge!

[hugovk]

I never got hooked to pre-commits, they felt too slow for me. But with only ruff and black and the few fast things that will get skipped most of the times, it should be OK, I'm willing to try :)

LGTM.

Yeah, pre-commit --the thing that runs before you commit -- definitely isn't for everyone, and I don't want to make anyone install it locally if they don't want to.

A good thing about pre-commit -- the tool -- is that you don't have to enable it to run when you git commit locally, and it's still very useful for:

• defining all these extra hooks/plugins/tools
• making it easy to run as Git pre-commit locally
• making it easy to run as a standalone lint tool locally
• making it easy to run on the CI, with the same pinned tool versions
• making it easy to update the pins

[AlexWaygood]

Yeah, I hate running checks before committing, but love the tool pre-commit, for exactly the reasons @hugovk lists above

[JulienPalard]

I was using tox for all linters :)

Feel free to merge.