Skip to content

Commit 3cce23e

Browse files
committed
Add markdownlint
1 parent 493f50a commit 3cce23e

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

.markdownlint.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"default": true,
3+
"MD003": { "style": "atx_closed" },
4+
"MD007": { "indent": 4 },
5+
"no-hard-tabs": false,
6+
"whitespace": false
7+
}

Makefile

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,7 @@ images:
293293
# help: isort - Organise & sort imports with isort
294294
# help: flake8 - PEP-8 style & logical errors
295295
# help: pylint - Pylint static analysis
296+
# help: markdownlint - Lint Markdown files with markdownlint (requires markdownlint-cli)
296297
# help: mypy - Static type-checking with mypy
297298
# help: bandit - Security scan with bandit
298299
# help: pydocstyle - Docstring style checker
@@ -320,11 +321,11 @@ images:
320321
# List of individual lint targets; lint loops over these
321322
LINTERS := isort flake8 pylint mypy bandit pydocstyle pycodestyle pre-commit \
322323
ruff pyright radon pyroma pyre spellcheck importchecker \
323-
pytype check-manifest
324+
pytype check-manifest markdownlint
324325

325326
.PHONY: lint $(LINTERS) black fawltydeps wily depend snakeviz pstats \
326-
spellcheck-sort tox \
327-
pytype check-manifest
327+
spellcheck-sort tox pytype sbom
328+
328329

329330
## --------------------------------------------------------------------------- ##
330331
## Master target
@@ -356,6 +357,9 @@ flake8: ## 🐍 flake8 checks
356357
pylint: ## 🐛 pylint checks
357358
pylint mcpgateway
358359

360+
markdownlint: ## 📖 Markdown linting
361+
markdownlint -c .markdownlint.json .
362+
359363
mypy: ## 🏷️ mypy type-checking
360364
mypy mcpgateway
361365

@@ -374,7 +378,7 @@ pre-commit: ## 🪄 Run pre-commit hooks
374378
ruff: ## ⚡ Ruff lint + format
375379
ruff check mcpgateway && ruff format mcpgateway
376380

377-
ty: ## ⚡ Ty type checker
381+
ty: ## ⚡ Ty type checker
378382
ty check mcpgateway
379383

380384
pyright: ## 🏷️ Pyright type-checking
@@ -428,8 +432,7 @@ tox: ## 🧪 Multi-Python tox matrix
428432
pdm python install 3.11 3.12
429433
python -m tox -p 2
430434

431-
.PHONY: sbom
432-
sbom:
435+
sbom: ## 🛡️ Generate SBOM & security report
433436
@echo "🛡️ Generating SBOM & security report…"
434437
@rm -Rf "$(VENV_DIR).sbom"
435438
@python3 -m venv "$(VENV_DIR).sbom"
@@ -440,11 +443,11 @@ sbom:
440443
@trivy sbom $(PROJECT_NAME).sbom.json | tee -a $(DOCS_DIR)/docs/test/sbom.md
441444
@/bin/bash -c "source $(VENV_DIR).sbom/bin/activate && python3 -m pdm outdated | tee -a $(DOCS_DIR)/docs/test/sbom.md"
442445

443-
pytype:
446+
pytype: ## 🧠 Pytype static type analysis
444447
@echo "🧠 Pytype analysis…"
445448
pytype -V 3.12 -j auto mcpgateway
446449

447-
check-manifest:
450+
check-manifest: ## 📦 Verify MANIFEST.in completeness
448451
@echo "📦 Verifying MANIFEST.in completeness…"
449452
check-manifest
450453

0 commit comments

Comments
 (0)