style: add pre-commit

[Tieqiong]

1. Add pre-commit hooks and configuration files:

• black, sort, flake8, codespell: standard skpkg configuration
• clang-format: Google style clang formatter

We should discuss on how we setup codespell here, as in regular skpkg packages we refer to ignore_words and ignore_lines in pyproject.toml, which doesn't exist here. I'm able to use the ignore_word file directly into pre-commit.yaml by making it a shell command (which force the comment symbol from ;; to # ), but I'm not sure how to add ignore_lines.

We might also want to add an extra cpplint check after some maintenance is done on the code. I already added it in .pre-commit-config.yaml but commented out for now.

2. Remove travis ci and local conda recipe: I think we don't need them anymore.

@sbillinge please check, thanks!

[sbillinge]

We should discuss on how we setup codespell here, as in regular skpkg packages we refer to ignore_words and ignore_lines in pyproject.toml, which doesn't exist here. I'm able to use the ignore_word file directly into pre-commit.yaml by making it a shell command (which force the comment symbol from ;; to # ), but I'm not sure how to add ignore_lines.

I would add a pyproject.toml. it only needs to have the [tool.black] and [tool.codespell] blocls in it. Nothing about building the package. Will this break setuptools for everything else if we do that?

[sbillinge]

cpplint would be good but let's get everything working first.

[sbillinge]

remove travis and conda recipe": correct

[sbillinge]

is there a reason why the tests are not funning on the PR? Do tests pass?

[Tieqiong]

@sbillinge Thanks for the comments. This cpp library doesn't use setuptool, and I think adding a pyproject.toml is fine.

We never got the original tests to work, and I believe we discussed this before and decided to rewrite all tests using modernized cpp testing suits. All the tests on this for now depend on diffpy.srreal.