evennia/Makefile

# This is used with `make <option>` and is used for running various
# administration operations on the code.

BLACK_FORMAT_CONFIGS = --target-version py37 --line-length 100 --exclude=/docs
TEST_GAME_DIR = .test_game_dir
TESTS ?= evennia

default:
	@echo " Usage: "
	@echo "  make install - install evennia (recommended to activate virtualenv first)"
	@echo "  make fmt/format - run the black autoformatter on the source code"
	@echo "  make lint - run black in --check mode"
	@echo "  make test - run evennia test suite with all default values."
	@echo "  make tests=evennia.path test - run only specific test or tests."
	@echo "  make testp - run test suite using multiple cores."

install:
	pip install -e .

format:
	black $(BLACK_FORMAT_CONFIGS) evennia

fmt: format

lint:
	black --check $(BLACK_FORMAT_CONFIGS) evennia

test:
	evennia --init $(TEST_GAME_DIR);\
	cd $(TEST_GAME_DIR);\
	evennia migrate;\
	evennia test --keepdb $(TESTS);\

testp:
	evennia --init $(TEST_GAME_DIR);\
	cd $(TEST_GAME_DIR);\
	evennia migrate;\
	evennia test --keepdb --parallel 4 $(TESTS);\
Format code with black. Add makefile to run fmt/tests 2019-09-28 18:18:11 +02:00			# This is used with `make <option>` and is used for running various
			`# administration operations on the code.`
Add auto-formatting via black Introduce black, a Python code formatter. Also a Makefile that includes two common targets: * fmt (auto-format the code) * lint (lint the code and return non-zero if out of spec) We can re-use the latter in CI. By introducing a code formatter, we can cut down on stylistic variations across a now-large codebase. We can also avoid most style discussions in PR if we just have this thing enforce it for us. 2019-09-15 21:02:40 -07:00
Ran black on sources 2020-04-12 12:17:06 +02:00			`BLACK_FORMAT_CONFIGS = --target-version py37 --line-length 100 --exclude=/docs`
Format code with black. Add makefile to run fmt/tests 2019-09-28 18:18:11 +02:00			`TEST_GAME_DIR = .test_game_dir`
Better indexing of help suggestions with lunr, better display 2020-04-11 09:42:22 +02:00			`TESTS ?= evennia`
Format code with black. Add makefile to run fmt/tests 2019-09-28 18:18:11 +02:00
			`default:`
			`@echo " Usage: "`
			`@echo " make install - install evennia (recommended to activate virtualenv first)"`
			`@echo " make fmt/format - run the black autoformatter on the source code"`
			`@echo " make lint - run black in --check mode"`
			`@echo " make test - run evennia test suite with all default values."`
			`@echo " make tests=evennia.path test - run only specific test or tests."`
			`@echo " make testp - run test suite using multiple cores."`
Add auto-formatting via black Introduce black, a Python code formatter. Also a Makefile that includes two common targets: * fmt (auto-format the code) * lint (lint the code and return non-zero if out of spec) We can re-use the latter in CI. By introducing a code formatter, we can cut down on stylistic variations across a now-large codebase. We can also avoid most style discussions in PR if we just have this thing enforce it for us. 2019-09-15 21:02:40 -07:00
			`install:`
Format code with black. Add makefile to run fmt/tests 2019-09-28 18:18:11 +02:00			`pip install -e .`
Add auto-formatting via black Introduce black, a Python code formatter. Also a Makefile that includes two common targets: * fmt (auto-format the code) * lint (lint the code and return non-zero if out of spec) We can re-use the latter in CI. By introducing a code formatter, we can cut down on stylistic variations across a now-large codebase. We can also avoid most style discussions in PR if we just have this thing enforce it for us. 2019-09-15 21:02:40 -07:00
Format code with black. Add makefile to run fmt/tests 2019-09-28 18:18:11 +02:00			`format:`
Add auto-formatting via black Introduce black, a Python code formatter. Also a Makefile that includes two common targets: * fmt (auto-format the code) * lint (lint the code and return non-zero if out of spec) We can re-use the latter in CI. By introducing a code formatter, we can cut down on stylistic variations across a now-large codebase. We can also avoid most style discussions in PR if we just have this thing enforce it for us. 2019-09-15 21:02:40 -07:00			`black $(BLACK_FORMAT_CONFIGS) evennia`

Format code with black. Add makefile to run fmt/tests 2019-09-28 18:18:11 +02:00			`fmt: format`

Add auto-formatting via black Introduce black, a Python code formatter. Also a Makefile that includes two common targets: * fmt (auto-format the code) * lint (lint the code and return non-zero if out of spec) We can re-use the latter in CI. By introducing a code formatter, we can cut down on stylistic variations across a now-large codebase. We can also avoid most style discussions in PR if we just have this thing enforce it for us. 2019-09-15 21:02:40 -07:00			`lint:`
			`black --check $(BLACK_FORMAT_CONFIGS) evennia`
Format code with black. Add makefile to run fmt/tests 2019-09-28 18:18:11 +02:00
			`test:`
			`evennia --init $(TEST_GAME_DIR);\`
			`cd $(TEST_GAME_DIR);\`
			`evennia migrate;\`
Better indexing of help suggestions with lunr, better display 2020-04-11 09:42:22 +02:00			`evennia test --keepdb $(TESTS);\`
Format code with black. Add makefile to run fmt/tests 2019-09-28 18:18:11 +02:00
			`testp:`
			`evennia --init $(TEST_GAME_DIR);\`
			`cd $(TEST_GAME_DIR);\`
			`evennia migrate;\`
Better indexing of help suggestions with lunr, better display 2020-04-11 09:42:22 +02:00			`evennia test --keepdb --parallel 4 $(TESTS);\`