drgn/.pre-commit-config.yaml

repos:
-   repo: https://github.com/pycqa/isort
    rev: 5.12.0
    hooks:
    -   id: isort
        name: isort (python)
        exclude: ^contrib/
-   repo: https://github.com/psf/black
    rev: 23.7.0
    hooks:
    -   id: black
        exclude: ^contrib/
-   repo: https://github.com/pycqa/flake8
    rev: 6.0.0
    hooks:
    -   id: flake8
        exclude: ^contrib/
-   repo: https://github.com/pre-commit/mirrors-mypy
    rev: v0.931
    hooks:
    -   id: mypy
        args: [--show-error-codes, --strict, --no-warn-return-any, --no-warn-unused-ignores]
        files: ^drgn/.*\.py|_drgn.pyi$
Add pre-commit During PRs, lint and mypy errors can show up in the CI tests, which is useful, but can introduce unnecessary churn on the PR as small lint fixes are pushed. This commit adds (optional) support for pre-commit, a tool which can be configured to run as a git pre-commit hook, running linters on all changed code to catch issues before you push your code. Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com> 2021-12-22 22:40:06 +00:00			`repos:`
			`- repo: https://github.com/pycqa/isort`
pre-commit: Update isort version to 5.12.0 Currently on Ubuntu 22.04 LTS, pre-commit hook installation is broken for isort, with an error that can be seen at [1]. The solution is to update isort to 5.12.0. [1]: https://github.com/PyCQA/isort/issues/2077 Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com> 2023-01-30 17:27:11 +00:00			`rev: 5.12.0`
Add pre-commit During PRs, lint and mypy errors can show up in the CI tests, which is useful, but can introduce unnecessary churn on the PR as small lint fixes are pushed. This commit adds (optional) support for pre-commit, a tool which can be configured to run as a git pre-commit hook, running linters on all changed code to catch issues before you push your code. Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com> 2021-12-22 22:40:06 +00:00			`hooks:`
			`- id: isort`
			`name: isort (python)`
Create contrib directory It's come up several times that it'd be nice to have somewhere to dump drgn scripts that people write while debugging without requiring them to be cleaned up and scrutinized in code review. Serapheim Dimitropoulos noted that several projects have a "contrib" directory for this purpose. See [1]. Let's create one, document it, exclude it from pre-commit, and move our (mostly unmaintained) examples there. 1: https://drewdevault.com/2020/06/06/Add-a-contrib-directory.html Signed-off-by: Omar Sandoval <osandov@osandov.com> 2022-11-02 08:03:52 +00:00			`exclude: ^contrib/`
Add pre-commit During PRs, lint and mypy errors can show up in the CI tests, which is useful, but can introduce unnecessary churn on the PR as small lint fixes are pushed. This commit adds (optional) support for pre-commit, a tool which can be configured to run as a git pre-commit hook, running linters on all changed code to catch issues before you push your code. Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com> 2021-12-22 22:40:06 +00:00			`- repo: https://github.com/psf/black`
pre-commit: update Black to 23.7.0 This added one minor style fix. Signed-off-by: Omar Sandoval <osandov@osandov.com> 2023-07-19 22:51:36 +01:00			`rev: 23.7.0`
Add pre-commit During PRs, lint and mypy errors can show up in the CI tests, which is useful, but can introduce unnecessary churn on the PR as small lint fixes are pushed. This commit adds (optional) support for pre-commit, a tool which can be configured to run as a git pre-commit hook, running linters on all changed code to catch issues before you push your code. Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com> 2021-12-22 22:40:06 +00:00			`hooks:`
			`- id: black`
Create contrib directory It's come up several times that it'd be nice to have somewhere to dump drgn scripts that people write while debugging without requiring them to be cleaned up and scrutinized in code review. Serapheim Dimitropoulos noted that several projects have a "contrib" directory for this purpose. See [1]. Let's create one, document it, exclude it from pre-commit, and move our (mostly unmaintained) examples there. 1: https://drewdevault.com/2020/06/06/Add-a-contrib-directory.html Signed-off-by: Omar Sandoval <osandov@osandov.com> 2022-11-02 08:03:52 +00:00			`exclude: ^contrib/`
pre-commit: add flake8 This has been useful to run manually before, but I haven't added it to the CI because it was somewhat noisy. But, it reports some really useful warnings, so let's configure it for our needs and add it to pre-commit. Signed-off-by: Omar Sandoval <osandov@osandov.com> 2022-05-17 23:23:52 +01:00			`- repo: https://github.com/pycqa/flake8`
pre-commit: update isort, Black, and flake8 No changes required. mypy is still pinned for the sake of Python 3.6. Signed-off-by: Omar Sandoval <osandov@osandov.com> 2022-12-13 23:38:15 +00:00			`rev: 6.0.0`
pre-commit: add flake8 This has been useful to run manually before, but I haven't added it to the CI because it was somewhat noisy. But, it reports some really useful warnings, so let's configure it for our needs and add it to pre-commit. Signed-off-by: Omar Sandoval <osandov@osandov.com> 2022-05-17 23:23:52 +01:00			`hooks:`
			`- id: flake8`
Create contrib directory It's come up several times that it'd be nice to have somewhere to dump drgn scripts that people write while debugging without requiring them to be cleaned up and scrutinized in code review. Serapheim Dimitropoulos noted that several projects have a "contrib" directory for this purpose. See [1]. Let's create one, document it, exclude it from pre-commit, and move our (mostly unmaintained) examples there. 1: https://drewdevault.com/2020/06/06/Add-a-contrib-directory.html Signed-off-by: Omar Sandoval <osandov@osandov.com> 2022-11-02 08:03:52 +00:00			`exclude: ^contrib/`
Add pre-commit During PRs, lint and mypy errors can show up in the CI tests, which is useful, but can introduce unnecessary churn on the PR as small lint fixes are pushed. This commit adds (optional) support for pre-commit, a tool which can be configured to run as a git pre-commit hook, running linters on all changed code to catch issues before you push your code. Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com> 2021-12-22 22:40:06 +00:00			`- repo: https://github.com/pre-commit/mirrors-mypy`
pre-commit: roll mypy back to v0.931 pre-commit/mirrors-mypy@d37f9c4f0c433417baf54659f3e89a5467364668 added "from __future__ import annotations", which doesn't work on Python 3.6. Python 3.6 is EOL, so it's probably time to drop it, but that should be a different, intentional change. Signed-off-by: Omar Sandoval <osandov@osandov.com> 2022-04-01 01:00:26 +01:00			`rev: v0.931`
Add pre-commit During PRs, lint and mypy errors can show up in the CI tests, which is useful, but can introduce unnecessary churn on the PR as small lint fixes are pushed. This commit adds (optional) support for pre-commit, a tool which can be configured to run as a git pre-commit hook, running linters on all changed code to catch issues before you push your code. Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com> 2021-12-22 22:40:06 +00:00			`hooks:`
			`- id: mypy`
pre-commit: add --show-error-codes to mypy This is useful for adding type: ignore[<code>] comments. Signed-off-by: Omar Sandoval <osandov@osandov.com> 2022-12-13 22:58:51 +00:00			`args: [--show-error-codes, --strict, --no-warn-return-any, --no-warn-unused-ignores]`
Add pre-commit During PRs, lint and mypy errors can show up in the CI tests, which is useful, but can introduce unnecessary churn on the PR as small lint fixes are pushed. This commit adds (optional) support for pre-commit, a tool which can be configured to run as a git pre-commit hook, running linters on all changed code to catch issues before you push your code. Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com> 2021-12-22 22:40:06 +00:00			`files: ^drgn/.*\.py\|_drgn.pyi$`