Commit e070528b authored by Jan Reimes's avatar Jan Reimes
Browse files

feat(build): add Justfile for build and linting commands

- Introduced Justfile to streamline build, linting, and cleaning tasks
- Removed outdated Makefile to simplify project setup
- Added dependencies for mdformat and rust-just in pyproject.toml
parent ebf9a508
Loading
Loading
Loading
Loading

Justfile

0 → 100644
+36 −0
Original line number Diff line number Diff line
set windows-shell := ["powershell.exe", "-NoLogo", "-Command"]

# Default command - list all available commands
default:
	@just --list

# Clean generated artefacts
clean:
    uv run ruff clean
    uv run python scripts/clean.py

# Lint the codebase
lint:
    uv run ruff format --check
    uv run ruff check --fix tests mcp_config_converter
    uv run isort --check-only tests mcp_config_converter
    uv run undersort --check tests mcp_config_converter
    uv run ty check

# Lint the documentation
lint-md:
    uv run mdformat .\mcp_config_converter
    uv run mdformat docs
    uv run mdformat AGENTS.md README.md

# Format the codebase
format:
    uv run ruff format tests mcp_config_converter
    uv run isort tests mcp_config_converter
    uv run undersort tests mcp_config_converter

# Build the project
build:
    @uv run scripts/remove_version.py
    uv build --clear --refresh .

Makefile

deleted100644 → 0
+0 −46
Original line number Diff line number Diff line
.PHONY: install
install: ## Install the virtual environment and install the pre-commit hooks
	@echo "🚀 Creating virtual environment using uv"
	@uv sync
	@uv run pre-commit install

.PHONY: check
check: ## Run code quality tools.
	@echo "🚀 Checking lock file consistency with 'pyproject.toml'"
	@uv lock --locked
	@echo "🚀 Linting code: Running pre-commit"
	@uv run pre-commit run -a
	@echo "🚀 Static type checking: Running ty"
	@uv run ty check
	@echo "🚀 Checking for obsolete dependencies: Running deptry"
	@uv run deptry src

.PHONY: test
test: ## Test the code with pytest
	@echo "🚀 Testing code: Running pytest"
	@uv run python -m pytest --cov --cov-config=pyproject.toml --cov-report=xml

.PHONY: build
build: clean-build ## Build wheel file
	@echo "🚀 Creating wheel file"
	@uvx --from build pyproject-build --installer uv

.PHONY: clean-build
clean-build: ## Clean build artifacts
	@echo "🚀 Removing build artifacts"
	@uv run python -c "import shutil; import os; shutil.rmtree('dist') if os.path.exists('dist') else None"

.PHONY: docs-test
docs-test: ## Test if documentation can be built without warnings or errors
	@uv run mkdocs build -s

.PHONY: docs
docs: ## Build and serve the documentation
	@uv run mkdocs serve

.PHONY: help
help:
	@uv run python -c "import re; \
	[[print(f'\033[36m{m[0]:<20}\033[0m {m[1]}') for m in re.findall(r'^([a-zA-Z_-]+):.*?## (.*)$$', open(makefile).read(), re.M)] for makefile in ('$(MAKEFILE_LIST)').strip().split()]"

.DEFAULT_GOAL := help
+2 −0
Original line number Diff line number Diff line
@@ -47,6 +47,8 @@ dev = [
    "mkdocs-material>=8.5.10",
    "mkdocstrings[python]>=0.26.1",
    "pytest-asyncio>=1.2.0",
    "mdformat>=1.0.0",
    "rust-just>=1.46.0",
]

[build-system]