add pre-commit-hooks.nix

This commit is contained in:
Moritz Böhme 2022-12-01 11:50:10 +01:00
parent 03c43a840e
commit 78136c27a0
Signed by: moritz
GPG key ID: 970C6E89EB0547A9
4 changed files with 214 additions and 25 deletions

1
.envrc Normal file
View file

@ -0,0 +1 @@
use flake

175
.gitignore vendored Normal file
View file

@ -0,0 +1,175 @@
# Created by https://www.toptal.com/developers/gitignore/api/direnv,python,nix
# Edit at https://www.toptal.com/developers/gitignore?templates=direnv,python,nix
### direnv ###
.direnv
.envrc
### Python ###
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
.pybuilder/
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock
# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/
# pytype static type analyzer
.pytype/
# Cython debug symbols
cython_debug/
# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
### Python Patch ###
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
poetry.toml
# End of https://www.toptal.com/developers/gitignore/api/direnv,python,nix

1
.pre-commit-config.yaml Symbolic link
View file

@ -0,0 +1 @@
/nix/store/0c3460gjwiqhy7j000ckyrk4ypcnsmlw-pre-commit-config.json

View file

@ -8,30 +8,42 @@
};
outputs = { self, nixpkgs, flake-utils, pre-commit-hooks }:
flake-utils.lib.eachDefaultSystem (system:
let
pkgs = nixpkgs.legacyPackages.${system};
minVersion = 8;
maxVersion = 11;
mkPython = version: "python3${toString version}";
pythonVersions = map mkPython (pkgs.lib.lists.range minVersion maxVersion);
mkDevShell = version: pkgs.mkShell {
buildInputs = [ pkgs.${version} pkgs.poetry ];
};
in
{
devShells = pkgs.lib.genAttrs pythonVersions mkDevShell // {
default = self.devShells.${system}.${mkPython maxVersion};
};
checks.pre-commit-check = pre-commit-hooks.lib."${system}".run {
src = ./.;
hooks = {
nixpkgs-fmt.enable = true;
statix.enable = true;
shellcheck.enable = true;
black.enable = true;
isort.enable = true;
flake-utils.lib.eachDefaultSystem
(system:
let
pkgs = nixpkgs.legacyPackages.${system};
minVersion = 8;
maxVersion = 11;
mkPython = version: "python3${toString version}";
pythonVersions = map mkPython (pkgs.lib.lists.range minVersion maxVersion);
mkDevShell = version: pkgs.mkShell {
buildInputs = [ pkgs.${version} pkgs.poetry ];
};
};
});
addPreCommit = shell: shell.overrideAttrs (old: {
inherit (self.checks.${system}.pre-commit-check) shellHook;
});
devShells = pkgs.lib.genAttrs pythonVersions mkDevShell;
preCommitShells = pkgs.lib.mapAttrs' (name: value: pkgs.lib.nameValuePair (name + "-precommit") (addPreCommit value)) devShells;
allShells = devShells // preCommitShells;
in
{
devShells = allShells // {
default = self.devShells.${system}."${mkPython maxVersion}-precommit";
};
checks.pre-commit-check = pre-commit-hooks.lib."${system}".run {
src = ./.;
hooks = {
nixpkgs-fmt.enable = true;
statix.enable = true;
shellcheck.enable = true;
black.enable = true;
isort.enable = true;
};
};
}) // {
templates.default = {
path = ./.;
description = "A adhoc python environment";
};
};
}