chore: adds pre-commit hooks (cbc04d43) · Commits · git-mirror / Templates

.pre-commit-config.yaml

0 → 100644

+31 −0

Original line number	Diff line number	Diff line
		---
		fail_fast: true
		default_stages: [commit]
		repos:
		- repo: https://github.com/pre-commit/pre-commit-hooks
		rev: v3.4.0
		hooks:
		- id: check-yaml
		- id: check-added-large-files
		- id: detect-private-key
		- id: check-executables-have-shebangs
		- id: check-merge-conflict
		- id: end-of-file-fixer
		- id: trailing-whitespace
		- id: mixed-line-ending
		args: ['--fix=lf']
		description: Forces to replace line ending by the UNIX 'lf' character.
		- repo: local
		hooks:
		- id: system
		name: yamllint
		entry: poetry run yamllint .
		pass_filenames: false
		always_run: true
		language: system
		- repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
		rev: v2.2.0
		hooks:
		- id: commitlint
		stages: [commit-msg]
		additional_dependencies: ['@commitlint/config-conventional']

CONTRIBUTING.md

+9 −0

Original line number	Diff line number	Diff line
		@@ -3,3 +3,12 @@
		Would you like to contribute? There are 2 ways:
		1. Fork this project, commit your changes there, and do a Merge Request against this project. Don't forget to assign either @falconierif or @hoverht to have a look at your code.
		2. Ask us to become a Developer in this repo, so you can develop in a branch here.

		### pre-commit hooks
		We use pre-commit hooks in this project.
		You don't have to use them, but if you want you can install them this way:
		```bash
		pip3 install poetry
		poetry install
		poetry run pre-commit install
		```

poetry.lock

+193 −1

Original line number	Diff line number	Diff line
		[[package]]
		name = "appdirs"
		version = "1.4.4"
		description = "A small Python module for determining appropriate platform-specific dirs, e.g. a \"user data dir\"."
		category = "dev"
		optional = false
		python-versions = "*"

		[[package]]
		name = "cfgv"
		version = "3.2.0"
		description = "Validate configuration and produce human readable error messages."
		category = "dev"
		optional = false
		python-versions = ">=3.6.1"

		[[package]]
		name = "distlib"
		version = "0.3.1"
		description = "Distribution utilities"
		category = "dev"
		optional = false
		python-versions = "*"

		[[package]]
		name = "filelock"
		version = "3.0.12"
		description = "A platform independent file lock."
		category = "dev"
		optional = false
		python-versions = "*"

		[[package]]
		name = "identify"
		version = "2.1.3"
		description = "File identification library for Python"
		category = "dev"
		optional = false
		python-versions = ">=3.6.1"

		[package.extras]
		license = ["editdistance"]

		[[package]]
		name = "importlib-metadata"
		version = "3.7.3"
		description = "Read metadata from Python packages"
		category = "dev"
		optional = false
		python-versions = ">=3.6"

		[package.dependencies]
		typing-extensions = {version = ">=3.6.4", markers = "python_version < \"3.8\""}
		zipp = ">=0.5"

		[package.extras]
		docs = ["sphinx", "jaraco.packaging (>=8.2)", "rst.linker (>=1.9)"]
		testing = ["pytest (>=3.5,!=3.7.3)", "pytest-checkdocs (>=1.2.3)", "pytest-flake8", "pytest-cov", "pytest-enabler", "packaging", "pep517", "pyfakefs", "flufl.flake8", "pytest-black (>=0.3.7)", "pytest-mypy", "importlib-resources (>=1.3)"]

		[[package]]
		name = "nodeenv"
		version = "1.5.0"
		description = "Node.js virtual environment builder"
		category = "dev"
		optional = false
		python-versions = "*"

		[[package]]
		name = "pathspec"
		version = "0.8.1"
		@@ -6,6 +73,23 @@ category = "dev"
		optional = false
		python-versions = ">=2.7, !=3.0., !=3.1., !=3.2., !=3.3., !=3.4.*"

		[[package]]
		name = "pre-commit"
		version = "2.11.1"
		description = "A framework for managing and maintaining multi-language pre-commit hooks."
		category = "dev"
		optional = false
		python-versions = ">=3.6.1"

		[package.dependencies]
		cfgv = ">=2.0.0"
		identify = ">=1.0.0"
		importlib-metadata = {version = "*", markers = "python_version < \"3.8\""}
		nodeenv = ">=0.11.1"
		pyyaml = ">=5.1"
		toml = "*"
		virtualenv = ">=20.0.8"

		[[package]]
		name = "pyyaml"
		version = "5.4.1"
		@@ -14,6 +98,49 @@ category = "dev"
		optional = false
		python-versions = ">=2.7, !=3.0., !=3.1., !=3.2., !=3.3., !=3.4., !=3.5."

		[[package]]
		name = "six"
		version = "1.15.0"
		description = "Python 2 and 3 compatibility utilities"
		category = "dev"
		optional = false
		python-versions = ">=2.7, !=3.0., !=3.1., !=3.2.*"

		[[package]]
		name = "toml"
		version = "0.10.2"
		description = "Python Library for Tom's Obvious, Minimal Language"
		category = "dev"
		optional = false
		python-versions = ">=2.6, !=3.0., !=3.1., !=3.2.*"

		[[package]]
		name = "typing-extensions"
		version = "3.7.4.3"
		description = "Backported and Experimental Type Hints for Python 3.5+"
		category = "dev"
		optional = false
		python-versions = "*"

		[[package]]
		name = "virtualenv"
		version = "20.4.2"
		description = "Virtual Python Environment builder"
		category = "dev"
		optional = false
		python-versions = "!=3.0.,!=3.1.,!=3.2.,!=3.3.,>=2.7"

		[package.dependencies]
		appdirs = ">=1.4.3,<2"
		distlib = ">=0.3.1,<1"
		filelock = ">=3.0.0,<4"
		importlib-metadata = {version = ">=0.12", markers = "python_version < \"3.8\""}
		six = ">=1.9.0,<2"

		[package.extras]
		docs = ["proselint (>=0.10.2)", "sphinx (>=3)", "sphinx-argparse (>=0.2.5)", "sphinx-rtd-theme (>=0.4.3)", "towncrier (>=19.9.0rc1)"]
		testing = ["coverage (>=4)", "coverage-enable-subprocess (>=1)", "flaky (>=3)", "pytest (>=4)", "pytest-env (>=0.6.2)", "pytest-freezegun (>=0.4.1)", "pytest-mock (>=2)", "pytest-randomly (>=1)", "pytest-timeout (>=1)", "packaging (>=20.0)", "xonsh (>=0.9.16)"]

		[[package]]
		name = "yamllint"
		version = "1.26.0"
		@@ -26,16 +153,60 @@ python-versions = ">=3.5.*"
		pathspec = ">=0.5.3"
		pyyaml = "*"

		[[package]]
		name = "zipp"
		version = "3.4.1"
		description = "Backport of pathlib-compatible object wrapper for zip files"
		category = "dev"
		optional = false
		python-versions = ">=3.6"

		[package.extras]
		docs = ["sphinx", "jaraco.packaging (>=8.2)", "rst.linker (>=1.9)"]
		testing = ["pytest (>=4.6)", "pytest-checkdocs (>=1.2.3)", "pytest-flake8", "pytest-cov", "pytest-enabler", "jaraco.itertools", "func-timeout", "pytest-black (>=0.3.7)", "pytest-mypy"]

		[metadata]
		lock-version = "1.1"
		python-versions = "^3.7"
		content-hash = "60d0b1699afcd0f7fe3f1e48c047c9e6970c106fe7123e294ff5f8b2cfcccf46"
		content-hash = "ed5cb19fab32e471b463ed3d41c88229effe85624a047481120edd2a256ae635"

		[metadata.files]
		appdirs = [
		{file = "appdirs-1.4.4-py2.py3-none-any.whl", hash = "sha256:a841dacd6b99318a741b166adb07e19ee71a274450e68237b4650ca1055ab128"},
		{file = "appdirs-1.4.4.tar.gz", hash = "sha256:7d5d0167b2b1ba821647616af46a749d1c653740dd0d2415100fe26e27afdf41"},
		]
		cfgv = [
		{file = "cfgv-3.2.0-py2.py3-none-any.whl", hash = "sha256:32e43d604bbe7896fe7c248a9c2276447dbef840feb28fe20494f62af110211d"},
		{file = "cfgv-3.2.0.tar.gz", hash = "sha256:cf22deb93d4bcf92f345a5c3cd39d3d41d6340adc60c78bbbd6588c384fda6a1"},
		]
		distlib = [
		{file = "distlib-0.3.1-py2.py3-none-any.whl", hash = "sha256:8c09de2c67b3e7deef7184574fc060ab8a793e7adbb183d942c389c8b13c52fb"},
		{file = "distlib-0.3.1.zip", hash = "sha256:edf6116872c863e1aa9d5bb7cb5e05a022c519a4594dc703843343a9ddd9bff1"},
		]
		filelock = [
		{file = "filelock-3.0.12-py3-none-any.whl", hash = "sha256:929b7d63ec5b7d6b71b0fa5ac14e030b3f70b75747cef1b10da9b879fef15836"},
		{file = "filelock-3.0.12.tar.gz", hash = "sha256:18d82244ee114f543149c66a6e0c14e9c4f8a1044b5cdaadd0f82159d6a6ff59"},
		]
		identify = [
		{file = "identify-2.1.3-py2.py3-none-any.whl", hash = "sha256:46d1816c6a4fc2d1e8758f293a5dcc1ae6404ab344179d7c1e73637bf283beb1"},
		{file = "identify-2.1.3.tar.gz", hash = "sha256:ed4a05fb80e3cbd12e83c959f9ff7f729ba6b66ab8d6178850fd5cb4c1cf6c5d"},
		]
		importlib-metadata = [
		{file = "importlib_metadata-3.7.3-py3-none-any.whl", hash = "sha256:b74159469b464a99cb8cc3e21973e4d96e05d3024d337313fedb618a6e86e6f4"},
		{file = "importlib_metadata-3.7.3.tar.gz", hash = "sha256:742add720a20d0467df2f444ae41704000f50e1234f46174b51f9c6031a1bd71"},
		]
		nodeenv = [
		{file = "nodeenv-1.5.0-py2.py3-none-any.whl", hash = "sha256:5304d424c529c997bc888453aeaa6362d242b6b4631e90f3d4bf1b290f1c84a9"},
		{file = "nodeenv-1.5.0.tar.gz", hash = "sha256:ab45090ae383b716c4ef89e690c41ff8c2b257b85b309f01f3654df3d084bd7c"},
		]
		pathspec = [
		{file = "pathspec-0.8.1-py2.py3-none-any.whl", hash = "sha256:aa0cb481c4041bf52ffa7b0d8fa6cd3e88a2ca4879c533c9153882ee2556790d"},
		{file = "pathspec-0.8.1.tar.gz", hash = "sha256:86379d6b86d75816baba717e64b1a3a3469deb93bb76d613c9ce79edc5cb68fd"},
		]
		pre-commit = [
		{file = "pre_commit-2.11.1-py2.py3-none-any.whl", hash = "sha256:94c82f1bf5899d56edb1d926732f4e75a7df29a0c8c092559c77420c9d62428b"},
		{file = "pre_commit-2.11.1.tar.gz", hash = "sha256:de55c5c72ce80d79106e48beb1b54104d16495ce7f95b0c7b13d4784193a00af"},
		]
		pyyaml = [
		{file = "PyYAML-5.4.1-cp27-cp27m-macosx_10_9_x86_64.whl", hash = "sha256:3b2b1824fe7112845700f815ff6a489360226a5609b96ec2190a45e62a9fc922"},
		{file = "PyYAML-5.4.1-cp27-cp27m-win32.whl", hash = "sha256:129def1b7c1bf22faffd67b8f3724645203b79d8f4cc81f674654d9902cb4393"},
		@@ -59,7 +230,28 @@ pyyaml = [
		{file = "PyYAML-5.4.1-cp39-cp39-win_amd64.whl", hash = "sha256:c20cfa2d49991c8b4147af39859b167664f2ad4561704ee74c1de03318e898db"},
		{file = "PyYAML-5.4.1.tar.gz", hash = "sha256:607774cbba28732bfa802b54baa7484215f530991055bb562efbed5b2f20a45e"},
		]
		six = [
		{file = "six-1.15.0-py2.py3-none-any.whl", hash = "sha256:8b74bedcbbbaca38ff6d7491d76f2b06b3592611af620f8426e82dddb04a5ced"},
		{file = "six-1.15.0.tar.gz", hash = "sha256:30639c035cdb23534cd4aa2dd52c3bf48f06e5f4a941509c8bafd8ce11080259"},
		]
		toml = [
		{file = "toml-0.10.2-py2.py3-none-any.whl", hash = "sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b"},
		{file = "toml-0.10.2.tar.gz", hash = "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f"},
		]
		typing-extensions = [
		{file = "typing_extensions-3.7.4.3-py2-none-any.whl", hash = "sha256:dafc7639cde7f1b6e1acc0f457842a83e722ccca8eef5270af2d74792619a89f"},
		{file = "typing_extensions-3.7.4.3-py3-none-any.whl", hash = "sha256:7cb407020f00f7bfc3cb3e7881628838e69d8f3fcab2f64742a5e76b2f841918"},
		{file = "typing_extensions-3.7.4.3.tar.gz", hash = "sha256:99d4073b617d30288f569d3f13d2bd7548c3a7e4c8de87db09a9d29bb3a4a60c"},
		]
		virtualenv = [
		{file = "virtualenv-20.4.2-py2.py3-none-any.whl", hash = "sha256:2be72df684b74df0ea47679a7df93fd0e04e72520022c57b479d8f881485dbe3"},
		{file = "virtualenv-20.4.2.tar.gz", hash = "sha256:147b43894e51dd6bba882cf9c282447f780e2251cd35172403745fc381a0a80d"},
		]
		yamllint = [
		{file = "yamllint-1.26.0-py2.py3-none-any.whl", hash = "sha256:8a5f8e442f49309eaf3e9d7232ce76f2fc8026f5c0c0b164b83f33fed1399637"},
		{file = "yamllint-1.26.0.tar.gz", hash = "sha256:b0e4c89985c7f5f8451c2eb8c67d804d10ac13a4abe031cbf49bdf3465d01087"},
		]
		zipp = [
		{file = "zipp-3.4.1-py3-none-any.whl", hash = "sha256:51cb66cc54621609dd593d1787f286ee42a5c0adbb4b29abea5a63edc3e03098"},
		{file = "zipp-3.4.1.tar.gz", hash = "sha256:3607921face881ba3e026887d8150cca609d517579abe052ac81fc5aeffdbd76"},
		]

pyproject.toml

+1 −0

Original line number	Diff line number	Diff line
		@@ -10,6 +10,7 @@ python = "^3.7"

		[tool.poetry.dev-dependencies]
		yamllint = "^1.26.0"
		pre-commit = "^2.11.1"

		[build-system]
		requires = ["poetry-core>=1.0.0"]