Skip to content

Commit 5a8bb16

Browse files
committed
feat: init
1 parent 62fe89f commit 5a8bb16

14 files changed

Lines changed: 787 additions & 0 deletions

.gitignore

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
target/
76+
77+
# Jupyter Notebook
78+
.ipynb_checkpoints
79+
80+
# IPython
81+
profile_default/
82+
ipython_config.py
83+
84+
# pyenv
85+
.python-version
86+
87+
# pipenv
88+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91+
# install all needed dependencies.
92+
#Pipfile.lock
93+
94+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
95+
__pypackages__/
96+
97+
# Celery stuff
98+
celerybeat-schedule
99+
celerybeat.pid
100+
101+
# SageMath parsed files
102+
*.sage.py
103+
104+
# Environments
105+
.env
106+
.venv
107+
env/
108+
venv/
109+
ENV/
110+
env.bak/
111+
venv.bak/
112+
113+
# Spyder project settings
114+
.spyderproject
115+
.spyproject
116+
117+
# Rope project settings
118+
.ropeproject
119+
120+
# mkdocs documentation
121+
/site
122+
123+
# mypy
124+
.mypy_cache/
125+
.dmypy.json
126+
dmypy.json
127+
128+
# Pyre type checker
129+
.pyre/

.pre-commit-config.yaml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v6.0.0
4+
hooks:
5+
- id: check-added-large-files
6+
- id: check-merge-conflict
7+
- id: end-of-file-fixer
8+
- id: trailing-whitespace
9+
args: [--markdown-linebreak-ext=md]
10+
exclude: CHANGELOG.md
11+
- id: check-merge-conflict
12+
- id: check-executables-have-shebangs
13+
- id: check-case-conflict
14+
- id: mixed-line-ending
15+
- id: detect-aws-credentials
16+
args: ["--allow-missing-credentials"]
17+
- id: detect-private-key
18+
19+
- repo: https://github.com/jumanjihouse/pre-commit-hooks
20+
rev: 3.0.0
21+
hooks:
22+
- id: shfmt
23+
name: shfmt
24+
args: ["-l", "-i", "2", "-ci", "-sr", "-w"]
25+
- id: shellcheck
26+
name: shellcheck
27+
28+
- repo: https://github.com/igorshubovych/markdownlint-cli
29+
rev: v0.45.0
30+
hooks:
31+
- id: markdownlint
32+
exclude: >
33+
(?x)^(
34+
CHANGELOG.md
35+
)$
36+
37+
- repo: https://github.com/executablebooks/mdformat
38+
rev: 0.7.22
39+
hooks:
40+
- id: mdformat
41+
additional_dependencies:
42+
- mdformat-toc
43+
- mdformat-tables
44+
exclude: >
45+
(?x)^(
46+
CHANGELOG.md
47+
)$
48+
49+
- repo: local
50+
hooks:
51+
- id: enforce-conventional-commits
52+
name: checks commit message for conventional commits formatting
53+
entry: ./python_pre_commit_hooks/enforce_conventional_commits.py
54+
language: python
55+
description: check commit message for conventional commits formatting
56+
stages: [commit-msg]
57+
always_run: false
58+
args:
59+
- --limit-to=hooks,python_pre_commit_hooks

.pre-commit-hooks.yaml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
- id: enforce-conventional-commits
2+
name: checks commit message for conventional commits formatting
3+
entry: enforce-conventional-commits
4+
language: python
5+
description: checks commit message for conventional commits formatting
6+
always_run: false
7+
require_serial: true
8+
stages: [commit-msg]
9+
10+
- id: terramate-fmt
11+
name: terramate fmt
12+
description: |
13+
The `terramate fmt` command is used to format Terramate configuration
14+
code.
15+
entry: hooks/terramate_fmt.sh
16+
language: script
17+
pass_filenames: false
18+
19+
- id: terramate-generate
20+
name: terramate generate
21+
description: |
22+
The `terramate generate` command is used to generate code from Terramate
23+
configuration.
24+
entry: hooks/terramate_generate.sh
25+
language: script
26+
pass_filenames: false

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
# pre-commit-hooks
2+
23
pre-commit-hooks

hooks/terramate_fmt.sh

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#!/usr/bin/env bash
2+
3+
set -euo pipefail
4+
5+
if ! command -v terramate > /dev/null 2>&1; then
6+
echo >&2 "terramate is not available on this system."
7+
echo >&2 "Please install it: 'https://terramate.io/docs/cli/installation'"
8+
exit 1
9+
fi
10+
11+
terramate fmt

hooks/terramate_generate.sh

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#!/usr/bin/env bash
2+
3+
set -euo pipefail
4+
5+
if ! command -v terramate > /dev/null 2>&1; then
6+
echo >&2 "terramate is not available on this system."
7+
echo >&2 "Please install it: 'https://terramate.io/docs/cli/installation'"
8+
exit 1
9+
fi
10+
11+
terramate generate

mise.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[tools]
2+
"pre-commit" = "4.1.0"
3+
"python" = "3.13.1"
4+
"shfmt" = "3.12.0"
5+
"shellcheck" = "0.11.0"

python_pre_commit_hooks/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)