fix: exit code and add some make commands + README

.pre-commit-config.yaml

@@ -40,7 +40,7 @@ repos:
           - commit
           - push
 #  - repo: https://github.com/roch1990/peon
-#    rev: '0.15-rc'
+#    rev: '0.15-rc-3'
 #    hooks:
 #      - id: peon
 #        stages:

Makefile

@@ -1,5 +1,10 @@
+.PHONY: local-run
+local-run:
+	pre-commit try-repo ./
+
 .PHONY: tests
 tests:
+	pre-commit run --all
 	coverage run -m pytest ./peon/tests --disable-warnings
 	coverage xml -o coverage-report.xml
 	mutmut --paths-to-mutate ./peon/src --tests-dir ./peon/tests run || true
@@ -8,3 +13,11 @@ tests:
 .PHONY: cov-report
 cov-report:
 	coverage xml -o coverage-report.xml
+
+.PHONY: help
+help:
+	@echo "You can run this helpfull commands:"
+	@echo
+	@echo -e "\tmake local-run   try your changes in pre-commit environment"
+	@echo -e "\tmake tests       start tests"
+	@echo -e "\tmake cov-report  generate coverage-report at cobertura format"

README.md

@@ -22,6 +22,7 @@
 - [Introduction](#introduction)
     - [What is that](#what-is-that)
     - [What eo principles i can check](#what-eo-principles-i-can-check)
+    - [Python versions compability](#python-versions-compability)
 - [Use-cases](#use-cases)
     - [Shell](#from-shell)
     - [Pre-commit hook](#add-linter-to-pre-commit-hooks)
@@ -187,7 +188,13 @@ You can start local test:
 make tests
 ```
 
-this instruction starts both tests - unit and mutual.
+this instruction starts - unit, mutual and security tests.
+
+Yuo can test pre-commit integration:
+
+```bash
+make local-run
+```
 
 Show results of mutual tests:
 

peon/src/lint/lint.py

@@ -37,7 +37,9 @@ def project(self):
         reports.append(principles.no_statements_in_test_methods_except_assert())
         reports.append(principles.no_inheritance())
 
+        report_done = False
         if reports:
             for report in reports:
-                report.send()
+                report_done = report_done or report.send()
+        if report_done:
             sys.exit(1)

peon/src/lint/report/report.py

@@ -17,13 +17,15 @@ def send(self):
         elif self.channel == ReportChannels.file:
             self.to_file()
 
-    def to_stdout(self):
+    def to_stdout(self) -> bool:
         if not self.text:
-            return
+            return False
         print(self.text, file=sys.stdout)
+        return True
 
-    def to_file(self):
+    def to_file(self) -> bool:
         if not self.text:
-            return
+            return False
         with open(ReportChannels.file, 'w') as result:
             result.write(self.text)
+        return True