Skip to content

🔨 Add Makefile to expose common developer commands#1728

Open
rickwporter wants to merge 2 commits intofastapi:masterfrom
rickwporter:rickwporter/makefile
Open

🔨 Add Makefile to expose common developer commands#1728
rickwporter wants to merge 2 commits intofastapi:masterfrom
rickwporter:rickwporter/makefile

Conversation

@rickwporter
Copy link
Copy Markdown
Contributor

When switching projects, it is sometimes difficult to recall the commands that should be run for common developer tasks. A Makefile with help provides an easy means to document the commands.

Here's an example:

(typer) % make

Usage:
  make 

General
  help             Print this message
  clean            Removes all bulid/test artifacts

Tests
  test             Run tests
  cov              Runs tests and produces HTML coverage report

Docs
  docs-build       Build docs
  docs-status      Check docs status

Lint
  lint-check       Perform all linting (ruff, ty, and mypy)
  lint-fix         Attempt to fix linting issues
  mypy-check       Perform mypy checking
  ty-check         Perform ty checks
  ruff-check       Perform ruff formatting checks
  ruff-format      Formats files
(typer) % make lint-check
uv run ruff check
All checks passed!
uv run ty check typer
All checks passed!
uv run mypy typer
Success: no issues found in 16 source files
(typer) % 

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants