Add pre-commit configuration

[mdeweerd]

This proposes a pre-commit configuration.

Running pre-commit with this setup will modify (format, optimize) source code and also report a number of notifications preventign commit if you install pre-commit on the repository.

You can run pre-commit on all files without committing using pre-commit run -a .

[larsoner]

Can you iterate until CIs are green? I think ideally we wouldn't need to change any existing code with the given pre-commit configuration. We should make any changes to existing flake/style stuff in a separate PR probably.

[mdeweerd]

Added extra ignores and moved most configurations to pyproject.toml .

I did not correct the following notification when running pre-commit when it runs mypy as it would require fixing the source itself:

codespell_lib/tests/test_dictionary.py:15: error: Unused "type: ignore" comment
        import aspell  # type: ignore[import]
        ^
Found 1 error in 1 file (checked 7 source files)

[larsoner]

I did not correct the following notification when running pre-commit when it runs mypy as it would require fixing the source itself:

Feel free to make this change. We need to get CIs green

[mdeweerd]

I did not correct the following notification when running pre-commit when it runs mypy as it would require fixing the source itself:

Feel free to make this change. We need to get CIs green

That is not what is turning the tests red.
https://github.com/codespell-project/codespell/actions/runs/3642917335/jobs/6150567655

My guess is that during the testcase the setup.cfg is read and this is modifying the behavior.

So either I move the codespell configuration to another toml file, or the tests would need to reference a forced configuration file.
I'll go with a separate codespell configuration for the moment to see what that gives and then - at a later time - the tests could be updated.

[mdeweerd]

How can I fix this?

missing from sdist:
  pyproject-codespell.precommit-toml
make: *** [Makefile:48: check-manifest] Error 1
Error: Process completed with exit code 2.

(Note: separating the codespell configuration made the tests pass).

[mdeweerd]

@larsoner Thanks, I overlooked that MANIFEST.in somehow.. .

I ignore some more errors for mypy in the pre-commit run to avoid detecting more/less than the CI flow.

I also applied the pyupgrade changes so that it is all done.

[larsoner]

Just a couple of minor things then I think it's good to go in!

[larsoner]

Is this for this PR, or a follow-up, or is this comment outdated and can be removed, or ...?

[mdeweerd]

I left it in pyproject.toml as a reminder tat IMHO the configuration should be ultimately there in that format.

Currently there are 2 issues:

1. The format is not recognized by codespell (see the other toml file);
2. The configuration impacts the test - which means that the tests are subject to the project codespell configuration itself. So ideally the tests should not rely on the codespell configuration in the project's setup.cfg, pyproject.toml, ... .

[mdeweerd]

I managed to get rid of the setup.cfg and move the flake8 configuration to pyproject.toml (and I moved more configurations from pre-commit-config to pyproject.toml).

[larsoner]

Thanks @mdeweerd !

[mdeweerd]

Good, I improved the pre-commit configurat a bit just now though.

[larsoner]

Feel free to open another PR. Bonus points if you want to add list-of-str support to our TOML as well!