Add `pre-commit`

Question

Add `pre-commit`

ma7dev opened this issue 2 years ago · 12 comments

Tools to include

black - code formatter
mypy - static type checker
pycln - remove unused imports
isort - sort imports

Skeleton to start from

# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.0.1
    hooks:
      - id: check-ast
      - id: check-builtin-literals
      - id: check-case-conflict
      - id: check-docstring-first
      - id: check-merge-conflict
      - id: check-json
      - id: check-toml
      - id: check-yaml
      - id: end-of-file-fixer
      - id: mixed-line-ending
      - id: trailing-whitespace
      - id: check-vcs-permalinks
      - id: check-shebang-scripts-are-executable
  - repo: https://github.com/pre-commit/pygrep-hooks
    rev: v1.9.0
    hooks:
      - id: python-check-mock-methods
      - id: python-no-log-warn
      - id: python-use-type-annotations
  - repo: https://github.com/hadialqattan/pycln
    rev: v1.2.5
    hooks:
      - id: pycln
        args: [--all]
  - repo: https://github.com/psf/black
    rev: 22.3.0
    hooks:
      - id: black
        additional_dependencies: ['click==8.0.4']
  - repo: https://github.com/PyCQA/isort
    rev: 5.10.1
    hooks:
      - id: isort
        args: ["--profile", "black"]

Answer 1 · 2022-07-09T11:47:09.000Z

Thank u, I was thinking about this.

Answer 2 · 2022-07-12T07:29:01.000Z

It seems that jekyll-pre-commit doesn't allow you to run pre-commit locally. We do have pre-commit configuration done correctly, but we don't want to install pre-commit through python. We would like to have some jekyll version of pre-commit to be able to utilize it when running bundle install (installing dependencies).

Answer 3 · 2022-07-19T14:57:19.000Z

Can you clarify more @sudomaze ? You can run pre-commit with bundle without pip

Answer 4 · 2022-07-19T15:01:46.000Z

@yousef337
You can't. You will need to have pip and you will need to install pre-commit through pip. jekyll-pre-commit allows you to check jekyll files using pre-commit-like setup, but it isn't actually pre-commit. At least that is what I found out when someone was trying to test this on their machine when pre-commit was added to our setup.

Answer 5 · 2022-07-19T15:30:41.000Z

You can use pre-commit from source without using pip, a small script will do, however, I think not using python may not be straightforward.

Answer 6 · 2022-07-19T15:32:22.000Z

I don't think it would be good to introduce additional complexity in our setup. We will be able to add pre-commit to our setup in the next release.

Answer 7 · 2022-07-19T15:36:42.000Z

For this release, I'm not sure if https://github.com/jish/pre-commit does not need python.

Answer 8 · 2022-07-19T15:38:19.000Z

You can try this out. If it works, then we can add it to this release.

Answer 9 · 2022-07-19T16:06:29.000Z

It works, but I think we may need to change the config yaml file for pre-commit. I will create a pr for it if I found it better than what we currently have

Answer 10 · 2022-07-23T08:53:37.000Z

What is the status of this?

Answer 11 · 2022-07-23T11:48:11.000Z

@zaidalyafeai Currently, there are some native tools that run without python, however, most of what I encountered is not a better substitution to the current setup.

Answer 12 · 2022-07-24T14:14:06.000Z

I am not the best to talk about this @MagedSaeed, any ideas? Do we just close this issue?