making the robots easier and happier (#1343)

.github/workflows/kanidm_book.yml

@@ -32,7 +32,7 @@ jobs:
 
       - name: Test document formatting
         run: |
-          make test/doc/format
+          make doc/format
 
       - name: Setup mdBook
         uses: peaceiris/actions-mdbook@v1

Makefile

@@ -97,6 +97,10 @@ test/radiusd: build/radiusd
 test:
 	cargo test
 
+.PHONY: precommit
+precommit: ## all the usual test things
+precommit: test codespell test/pykanidm doc/format
+
 .PHONY: vendor
 vendor:
 	cargo vendor
@@ -147,11 +151,6 @@ test/pykanidm/mypy: ## python library type checking
 test/pykanidm: ## run the kanidm python module test suite (mypy/lint/pytest)
 test/pykanidm: test/pykanidm/pytest test/pykanidm/mypy test/pykanidm/lint
 
-.PHONY: test/doc/format
-test/doc/format: ## Format docs and the Kanidm book
-	find . -type f  -not -path './target/*' -name \*.md \
-		-exec deno fmt --check $(MARKDOWN_FORMAT_ARGS) "{}" +
-
 ########################################################################
 
 .PHONY: doc
@@ -161,7 +160,15 @@ doc:
 
 .PHONY: doc/format
 doc/format: ## Format docs and the Kanidm book
-	find . -type f -name \*.md -exec deno fmt $(MARKDOWN_FORMAT_ARGS) "{}" +
+	find . -type f  -not -path './target/*' -not -path '*/.venv/*' \
+		-name \*.md \
+		-exec deno fmt --check $(MARKDOWN_FORMAT_ARGS) "{}" +
+
+.PHONY: doc/format/fix
+doc/format/fix: ## Fix docs and the Kanidm book
+	find . -type f  -not -path './target/*' -not -path '*/.venv/*' \
+		-name \*.md \
+		-exec deno fmt  $(MARKDOWN_FORMAT_ARGS) "{}" +
 
 .PHONY: book
 book: ## Build the Kanidm book

README.md

@@ -99,8 +99,8 @@ of resource overhead and difficulty for administration.
 
 Kanidm aims to have the features richness of FreeIPA, but without the resource and administration
 overheads. If you want a complete IDM package, but in a lighter footprint and easier to manage, then
-Kanidm is probably for you. In testing with 3000 users + 1500 groups, Kanidm is 3 times faster
-for search operations and 5 times faster for modification and addition of entries (your results may
+Kanidm is probably for you. In testing with 3000 users + 1500 groups, Kanidm is 3 times faster for
+search operations and 5 times faster for modification and addition of entries (your results may
 differ however, but generally Kanidm is much faster than FreeIPA).
 
 ## Developer Getting Started