refactor(Makefile): update Makefile

metaopt · XuehaiPan · Jul 10, 2022 · Jul 7, 2022 · Jul 7, 2022 · Jul 7, 2022
commit 9730748c3ea58bd8690bbe05c8e39a20ebd6f899
diff --git a/Makefile b/Makefile
@@ -1,33  1,51 @@
 print-%  : ; @echo $* = $($*)
-SHELL          = /bin/bash
 PROJECT_NAME   = torchopt
-PROJECT_PATH   = ${PROJECT_NAME}/
-PROJECT_FOLDER = $(PROJECT_NAME) examples include src tests
-PYTHON_FILES   = $(shell find examples torchopt tests -type f -name "*.py" -o -name "*.pyi")
-CPP_FILES      = $(shell find . -type f -name "*.h" -o -name "*.cpp" -o -name "*.cuh" -o -name "*.cu")
-COMMIT_HASH    = $(shell git log -1 --format=%h)
 COPYRIGHT      = "MetaOPT Team. All Rights Reserved."
 PROJECT_PATH   = ${PROJECT_NAME}
 SHELL          = /bin/bash
 SOURCE_FOLDERS = $(PROJECT_PATH) examples include src tests
 PYTHON_FILES   = $(shell find $(SOURCE_FOLDERS) -type f -name "*.py" -o -name "*.pyi")
 CXX_FILES      = $(shell find $(SOURCE_FOLDERS) -type f -name "*.h" -o -name "*.cpp" -o -name "*.cuh" -o -name "*.cu")
 COMMIT_HASH    = $(shell git log -1 --format=%h)
 PATH           := $(HOME)/go/bin:$(PATH)
 PYTHON         ?= $(shell command -v python3 || command -v python)
 
 .PHONY: default
 default: install
 
-# installation
 install:
 	$(PYTHON) -m pip install .
 
-check_install = python3 -c "import $(1)" || (cd && pip3 install $(1) --upgrade && cd -)
-check_install_extra = python3 -c "import $(1)" || (cd && pip3 install $(2) --upgrade && cd -)
 # Tools Installation
 
 check_pip_install = $(PYTHON) -m pip show $(1) &>/dev/null || (cd && $(PYTHON) -m pip install $(1) --upgrade)
 check_pip_install_extra = $(PYTHON) -m pip show $(1) &>/dev/null || (cd && $(PYTHON) -m pip install $(2) --upgrade)
 
 flake8-install:
-	$(call check_install, flake8)
-	$(call check_install_extra, bugbear, flake8_bugbear)
 	$(call check_pip_install,flake8)
 	$(call check_pip_install_extra,bugbear,flake8_bugbear)
 
 py-format-install:
-	$(call check_install, isort)
-	$(call check_install, yapf)
 	$(call check_pip_install,isort)
 	$(call check_pip_install,yapf)
 
 mypy-install:
-	$(call check_install, mypy)
 	$(call check_pip_install,mypy)
 
 docs-install:
 	$(call check_pip_install,pydocstyle)
 	$(call check_pip_install,doc8)
 	$(call check_pip_install,sphinx)
 	$(call check_pip_install,sphinx_rtd_theme)
 	$(call check_pip_install_extra,sphinxcontrib.spelling,sphinxcontrib.spelling pyenchant)
 
 pytest-install:
 	$(call check_pip_install,pytest)
 	$(call check_pip_install,pytest_cov)
 	$(call check_pip_install,pytest_xdist)
 
 cpplint-install:
-	$(call check_install, cpplint)
 	$(call check_pip_install,cpplint)
 
 clang-format-install:
 	command -v clang-format-11 || sudo apt-get install -y clang-format-11
@@ -42,65  60,67 @@ go-install:
 addlicense-install: go-install
 	command -v addlicense || go install github.com/google/addlicense@latest
 
-doc-install:
-	$(call check_install, pydocstyle)
-	$(call check_install, doc8)
-	$(call check_install, sphinx)
-	$(call check_install, sphinx_rtd_theme)
-	$(call check_install_extra, sphinxcontrib.spelling, sphinxcontrib.spelling pyenchant)
-
-pytest-install:
-	$(call check_install, pytest)
-	$(call check_install, pytest_cov)
-	$(call check_install, pytest_xdist)
-
-
-# test
 # Tests
 
 pytest: pytest-install
-	pytest tests --cov ${PROJECT_PATH} --durations 0 -v --cov-report term-missing --color=yes
 	cd tests && $(PYTHON) -m pytest unit --cov ${PROJECT_PATH} --durations 0 -v --cov-report term-missing --color=yes
 
 test: pytest
 
-# python linter
 # Python linters
 
 flake8: flake8-install
-	flake8 $(PYTHON_FILES) --count --select=E9,F63,F7,F82,E225,E251 --show-source --statistics
 	$(PYTHON) -m flake8 $(PYTHON_FILES) --count --select=E9,F63,F7,F82,E225,E251 --show-source --statistics
 
 py-format: py-format-install
-	isort --project torchopt --check $(PYTHON_FILES) && \
-	yapf --in-place --recursive $(PYTHON_FILES)
 	$(PYTHON) -m isort --project torchopt --check $(PYTHON_FILES) && \
 	$(PYTHON) -m yapf --in-place --recursive $(PYTHON_FILES)
 
 mypy: mypy-install
-	mypy $(PROJECT_NAME)
 	$(PYTHON) -m mypy $(PROJECT_NAME)
 
-# c   linter
 # C   linters
 
 cpplint: cpplint-install
-	cpplint $(CPP_FILES)
 	$(PYTHON) -m cpplint $(CXX_FILES)
 
 clang-format: clang-format-install
-	clang-format-11 --style=file -i $(CPP_FILES) -n --Werror
 	clang-format-11 --style=file -i $(CXX_FILES) -n --Werror
 
-# documentation
 # Documentation
 
 addlicense: addlicense-install
-	addlicense -c $(COPYRIGHT) -l apache -y 2022 -check $(PROJECT_FOLDER)
 	addlicense -c $(COPYRIGHT) -l apache -y 2022 -check $(SOURCE_FOLDERS)
 
 docstyle: docs-install
 	$(PYTHON) -m pydocstyle $(PROJECT_NAME) && doc8 docs && make -C docs html SPHINXOPTS="-W"
 
 docs: docs-install
 	make -C docs html && cd _build/html && $(PYTHON) -m http.server
 
 spelling: docs-install
 	make -C docs spelling SPHINXOPTS="-W"
 
 clean-docs:
 	make -C docs clean
 
-docstyle: doc-install
-	pydocstyle $(PROJECT_NAME) && doc8 docs && cd docs && make html SPHINXOPTS="-W"
 # Utility functions
 
-doc: doc-install
-	cd docs && make html && cd _build/html && python3 -m http.server
 lint: flake8 py-format mypy clang-format cpplint addlicense
 
-spelling: doc-install
-	cd docs && make spelling SPHINXOPTS="-W"
 format: py-format-install clang-format-install addlicense-install
 	$(PYTHON) -m isort --project torchopt $(PYTHON_FILES)
 	$(PYTHON) -m yapf --in-place --recursive $(PYTHON_FILES)
 	clang-format-11 -style=file -i $(CXX_FILES)
 	addlicense -c $(COPYRIGHT) -l apache -y 2022 $(SOURCE_FOLDERS)
 
-doc-clean:
-	cd docs && make clean
 clean-py:
 	find . -type f -name  '*.py[co]' -delete
 	find . -depth -type d -name ".mypy_cache" -exec rm -r "{}"  
 	find . -depth -type d -name ".pytest_cache" -exec rm -r "{}"  
 
-lint: flake8 py-format clang-format cpplint mypy
 clean-build:
 	rm -rf build/ dist/
 	rm -rf *.egg-info .eggs
 
-format: py-format-install clang-format-install
-	isort $(PYTHON_FILES)
-	yapf -ir $(PYTHON_FILES)
-	clang-format-11 -style=file -i $(CPP_FILES)
-	addlicense -c $(COPYRIGHT) -l apache -y 2022 $(PROJECT_FOLDER)
 clean: clean-py clean-build clean-docs