9ecef4c25f
This PR does too many things :(
1. Major refactoring of the dev/scripts and dev/code-generation folders.
Primarily this was removing duplicate code and cleaning up some poorly written code snippets as well as making them more idempotent so then can be re-run over and over again but still maintain the same results. This is working on my machine, but I've been having problems in CI and comparing diffs so running generators in CI will have to wait.
2. Re-Implement using the generated api routes for testing
This was a _huge_ refactor that touched damn near every test file but now we have auto-generated typed routes with inline hints and it's used for nearly every test excluding a few that use classes for better parameterization. This should greatly reduce errors when writing new tests.
3. Minor Perf improvements for the All Recipes endpoint
A. Removed redundant loops
B. Uses orjson to do the encoding directly and returns a byte response instead of relying on the default
jsonable_encoder.
4. Fix some TS type errors that cropped up for seemingly no reason half way through the PR.
See this issue https://github.com/phillipdupuis/pydantic-to-typescript/issues/28
Basically, the generated TS type is not-correct since Pydantic will automatically fill in null fields. The resulting TS type is generated with a ? to indicate it can be null even though we _know_ that i can't be.
134 lines
3.9 KiB
Makefile
134 lines
3.9 KiB
Makefile
define BROWSER_PYSCRIPT
|
|
import os, webbrowser, sys
|
|
|
|
from urllib.request import pathname2url
|
|
|
|
webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
|
|
endef
|
|
export BROWSER_PYSCRIPT
|
|
|
|
define PRINT_HELP_PYSCRIPT
|
|
import re, sys
|
|
|
|
for line in sys.stdin:
|
|
match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
|
|
if match:
|
|
target, help = match.groups()
|
|
print("%-20s %s" % (target, help))
|
|
endef
|
|
export PRINT_HELP_PYSCRIPT
|
|
|
|
BROWSER := python -c "$$BROWSER_PYSCRIPT"
|
|
|
|
help:
|
|
@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
|
|
|
|
.PHONY: docs
|
|
docs: ## 📄 Start Mkdocs Development Server
|
|
poetry run python dev/code-generation/gen_docs_api.py && \
|
|
cd docs && poetry run python -m mkdocs serve
|
|
|
|
code-gen: ## 🤖 Run Code-Gen Scripts
|
|
poetry run python dev/scripts/app_routes_gen.py
|
|
|
|
# -----------------------------------------------------------------------------
|
|
# Backend makefile
|
|
|
|
.PHONY: setup
|
|
setup: ## 🏗 Setup Development Instance
|
|
poetry install && \
|
|
cd frontend && \
|
|
yarn install && \
|
|
cd ..
|
|
|
|
poetry run pre-commit install
|
|
|
|
cp -n template.env .env || true
|
|
|
|
@echo "🏗 Development Setup Complete "
|
|
@echo "❗️ Tips"
|
|
@echo " 1. run 'make backend' to start the API server"
|
|
@echo " 2. run 'make frontend' to start the Node Server"
|
|
@echo " 3. Testing the Natural Language Processor? Try 'make setup-model' to get the most recent model"
|
|
|
|
setup-model: ## 🤖 Get the latest NLP CRF++ Model
|
|
@echo Fetching NLP Model - CRF++ is still Required
|
|
curl -L0 https://github.com/mealie-recipes/nlp-model/releases/download/v1.0.0/model.crfmodel --output ./mealie/services/parser_services/crfpp/model.crfmodel
|
|
|
|
|
|
clean-data: ## ⚠️ Removes All Developer Data for a fresh server start
|
|
rm -r ./dev/data/recipes/
|
|
rm -r ./dev/data/users/
|
|
rm -f ./dev/data/mealie*.db
|
|
rm -f ./dev/data/mealie.log
|
|
rm -f ./dev/data/.secret
|
|
|
|
clean-pyc: ## 🧹 Remove Python file artifacts
|
|
find ./mealie -name '*.pyc' -exec rm -f {} +
|
|
find ./mealie -name '*.pyo' -exec rm -f {} +
|
|
find ./mealie -name '*~' -exec rm -f {} +
|
|
find ./mealie -name '__pycache__' -exec rm -fr {} +
|
|
|
|
clean-test: ## 🧹 Remove test and coverage artifacts
|
|
rm -fr .tox/
|
|
rm -f .coverage
|
|
rm -fr htmlcov/
|
|
rm -fr .pytest_cache
|
|
|
|
backend-clean: clean-pyc clean-test ## 🧹 Remove all build, test, coverage and Python artifacts
|
|
rm -fr .mypy_cache
|
|
|
|
backend-typecheck:
|
|
poetry run mypy mealie
|
|
|
|
backend-test: ## 🧪 Run tests quickly with the default Python
|
|
poetry run pytest
|
|
|
|
backend-format: ## 🧺 Format, Check and Flake8
|
|
poetry run isort .
|
|
poetry run black .
|
|
|
|
backend-lint:
|
|
poetry run flake8 mealie tests
|
|
|
|
backend-all: backend-format backend-lint backend-typecheck backend-test ## 🧪 Runs all the backend checks and tests
|
|
|
|
backend-coverage: ## ☂️ Check code coverage quickly with the default Python
|
|
poetry run pytest
|
|
poetry run coverage report -m
|
|
poetry run coveragepy-lcov
|
|
poetry run coverage html
|
|
$(BROWSER) htmlcov/index.html
|
|
|
|
backend: ## 🎬 Start Mealie Backend Development Server
|
|
poetry run python mealie/db/init_db.py && \
|
|
poetry run python mealie/app.py
|
|
|
|
# -----------------------------------------------------------------------------
|
|
# Frontend makefile
|
|
|
|
.PHONY: frontend
|
|
frontend: ## 🎬 Start Mealie Frontend Development Server
|
|
cd frontend && yarn run dev
|
|
|
|
frontend-build: ## 🏗 Build Frontend in frontend/dist
|
|
cd frontend && yarn run build
|
|
|
|
frontend-generate: ## 🏗 Generate Code for Frontend
|
|
poetry run python dev/code-generation/gen_frontend_types.py
|
|
|
|
frontend-lint: ## 🧺 Run yarn lint
|
|
cd frontend && yarn lint
|
|
|
|
# -----------------------------------------------------------------------------
|
|
# Docker makefile
|
|
|
|
docker-dev: ## 🐳 Build and Start Docker Development Stack
|
|
docker-compose -f docker-compose.dev.yml -p dev-mealie down && \
|
|
docker-compose -f docker-compose.dev.yml -p dev-mealie up --build
|
|
|
|
docker-prod: ## 🐳 Build and Start Docker Production Stack
|
|
docker-compose -f docker-compose.yml -p mealie up --build
|
|
|
|
generate:
|
|
poetry run python dev/code-generation/main.py
|