fix: megalinter fixes for blank space and formatting

Author: practicalli-johnny

docs/build-tool/babashka-task-runner.md

@@ -6,5 +6,4 @@ Babashka provides a [task runner](https://book.babashka.org/#tasks) which can be
 
 [:fontawesome-solid-book-open: Babashka Task Runner](https://book.babashka.org/#tasks)
 
-
 <!-- TODO: create tasks to manage a clojure project (as has been done with make) -->

docs/build-tool/index.md

@@ -2,6 +2,5 @@
 
 Build tools can support a wide range of development tasks
 
-
 * [GNU make](make.md) - language agnostic build tool, define any tasks
 * [babashka](babashka.md) - write a built tool using Clojure

docs/build-tool/make.md

@@ -196,7 +196,6 @@ A `Makefile` defines targets called via the `make` command. Each target can run
 
 > Practicalli also uses `make` to [configure and build the latest versions of Emacs](https://practical.li/blog/posts/build-emacs-28-on-ubuntu/){target=_blank} and other Linux open source software
 
-
 ## Defining tasks
 
 Create a `Makefile` in the root of a project and define a target by typing a suitable name followed by a `:` character, e.g. `test:`
@@ -211,7 +210,6 @@ repl:  ## Run Clojure REPL with rich terminal UI (Rebel Readline)
     clojure -M:env/dev:env/test:repl/rebel
 ```
 
-
 ### Common target naming
 
 Targets used across Practicalli projects follow the [make standard targets for users](https://www.gnu.org/software/make/manual/html_node/Standard-Targets.html)
@@ -232,7 +230,6 @@ Targets used across Practicalli projects follow the [make standard targets for u
 
 [:fontawesome-brands-github: practicalli/dotfiles/Makefile](https://github.com/practicalli/dotfiles/blob/main/Makefile) also defines docker targets to build and compose images locally, inspect images and prune containers and images.
 
-
 ## Target dependencies
 
 A `Makefile` target can depend on either a file name or another target in the `Makefile`.
@@ -247,14 +244,12 @@ Add the filename of a file after the name of the target, to depend on if that fi
 
 Clojure CLI Example: If the `deps` target depends on `deps.edn` and the file has not changed since last run, the deps target will not run again.
 
-
 ## deps target - depend on a file
 
 The deps target would use Clojure CLI or Leiningen to download dependencies.
 
 Configuring the `deps` target to depend on `deps.edn` or `project.clj` file, then if the file has not changed the deps will not run again.
 
-
 A Clojure CLI example depends on the `deps.edn` file that defines all the library dependencies for the project, tools for testing and packaging the Clojure service.  The `-P` flag is the prepare option, a dry run that only downloads the dependencies for the given tasks.
 
 ```makefile
@@ -265,7 +260,6 @@ deps: deps.edn  ## Prepare dependencies for test and dist targets
 
 > `:env/test` adds libraries to run Kaocha and libraries used to run unit tests.  `:package/uberjar` runs a tool that creates an uberjar.
 
-
 ## Clean target - hiding command failure
 
 The clean target should remove files and directories created by the build (compile) process, to ensure a consistent approach to building each time.
@@ -281,7 +275,6 @@ clean:
     - rm -rf ./.cpcache
 ```
 
-
 ## MegaLinter target - simplifying a command
 
 The `lint` target is an example of how the `Makefile` simplifies the command line interface.
@@ -303,7 +296,6 @@ lint-clean:
     - rm -rf ./megalinter-reports
 ```
 
-
 ## Enhancing make output
 
 The `info` message is used with each target to enhances the readability of the make output, especially when multiple targets and commands are involved, or if commands are generating excessive output to standard out.
@@ -316,7 +308,6 @@ The `info` message is used with each target to enhances the readability of the m
 
 ![Makefile showing make all output with info messages to separate the Clojure commands and output](https://raw.githubusercontent.com/practicalli/graphic-design/live/clojure/makefile-clojure-make-all-output-with-info.png)
 
-
 ## Avoiding file name collisions
 
 Although unlikely, if a filename in the root of a project has the same name as a `Makefile` target, it can be used instead of running the targets command
@@ -329,7 +320,6 @@ Although unlikely, if a filename in the root of a project has the same name as a
 
 > Reference: [:fontawesome-solid-book-open: Makefile Tutorial: phony](https://makefiletutorial.com/#phony){target=_blank .md-button}
 
-
 ## Halt on failure
 
 `.DELETE_ON_ERROR:` halts any further commands if a command returns non-zero exit status.  Useful as short-circuit to stop tasks when further work is not valuable, e.g. if tests fail then it may not be valuable to build the Clojure project.
@@ -341,13 +331,11 @@ all: deps test-ci dist clean
 
 > Reference: [:fontawesome-solid-book-open: Makefile Tutorial:  delete_on_error](https://makefiletutorial.com/#delete_on_error){target=_blank .md-button}
 
-
 ## References
 
 [:fontawesome-solid-book-open: Makefile Tutorial by Example](https://makefiletutorial.com/){target=_blank .md-button}
 [:fontawesome-brands-github: practicalli/dotfiles Makefile](https://github.com/practicalli/dotfiles/blob/main/Makefile){target=_blank .md-button}
 
-
 ## Summary
 
 A `Makefile` can simplify the command line interface for any task with a Clojure project (or any other language and tooling).

docs/careers/engineering-manager.md

@@ -4,7 +4,6 @@ Management roles are there to balance the needs of the organisation with the eng
 
 The role naturally focuses on on the larger goals and challenges facing the engineering teams, supporting the engineers to solve specific challenges using their own skills and experiences (that is why they were hired)
 
-
 ## Meetings
 
 [one to one](/engineering-playbook/practices/discussions/one-to-one-meeting.md) are regularly held with direct reports and those people the engineering manager reports to, ensuring there is good working relationship between the respective people.
@@ -18,15 +17,13 @@ Engineering team meetings may occasionally be joined to review how effective the
 - [standup](/engineering-playbook/practices/discussions/standup.md) can highlight issues with motivation and team cohesiveness
 - [retrospective](/engineering-playbook/practices/discussions/retrospective.md) can help identify action items that the engineering manager can actively support or help direct others to support
 
-
 !!! HINT "Performance reviews supported by one-to-one meetings"
     Where performance reviews are applicable, include the review as an aspect to raise with one-to-one meetings with direct reports throughout the year.
 
     The need to complete a review should be raised as early as possible in one-to-one meetings and regularly raised (even if only briefly) to ensure supporting tasks are carried out to swiftly complete the review at the appropriate time.
 
     Creating regular journal entries can speed up the completion of a self-written performance review submission
 
-
 ## Journal
 
 Write regular journal entries and encourage others to do the same by sharing the journal across the organisation (except for private notes)
@@ -35,7 +32,6 @@ Use the knowledge sharing tool for the organisation, e.g. [Atlassian Confluence]
 
 > TODO: example jornal, e.g. from Billie & 100 days of code
 
-
 ## Management anti-patters
 
 **micro-management** is highly ineffective, demonstrates lack of trust, highlights poor communication and lack of management skills.  Shows lack of understanding of the needs of the business and engineering teams.

docs/code-quality/clojure.md

@@ -1,6 +1,5 @@
 # Clojure Quality tools
 
-
 ## Syntax & Idiom check
 
 [clj-kondo](https://github.com/borkdude/clj-kondo/) is a lint tool that highlights syntactic errors and suggests idioms for Clojure, ClojureScript and EDN.
@@ -12,12 +11,10 @@ clj-kondo can also be used as a command line tool for checking projects in devel
 !!! HINT "Clojure LSP includes clj-kondo"
     [Clojure LSP install](clojure-lsp/) includes clj-kondo, removing the need for a separate install of clj-kondo
 
-
 [clj-kondo install guide](https://github.com/borkdude/clj-kondo/blob/master/doc/install.md){target=_blank .md-button}
 
 [Clj-kondo config](https://github.com/clj-kondo/config) contains additional configuration for using clj-kondo with libraries that extend the Clojure language via macros.
 
-
 ### Command Line
 
 Run `clj-kondo` with the --lint option and specify a file or path
@@ -34,7 +31,6 @@ Analyse a project, running the clj-kondo command from the root of the project
 clj-kondo --lint .
 ```
 
-
 ### GitHub workflow
 
 Add clj-kondo linting to continuous integration workflow checks for syntax errors with Clojure files.
@@ -43,7 +39,6 @@ Add clj-kondo linting to continuous integration workflow checks for syntax error
 [Clojure Lint & Reviewdog](https://github.com/marketplace/actions/clojure-lint-action){target=_blank .md-button}
 [Setup clj-kondo](https://github.com/marketplace/actions/setup-clj-kondo){target=_blank .md-button}
 
-
 !!! EXAMPLE "Setup Clojure with clj-kondo and cljstyle checks"
     ```yaml
     ---
@@ -85,11 +80,9 @@ Add clj-kondo linting to continuous integration workflow checks for syntax error
           - run: echo "🍏 Job status is ${{ job.status }}."
     ```
 
-
 ??? INFO "Setup clojure-lsp Action"
     [Setup Clojure-LSP](https://github.com/marketplace/actions/setup-clojure-lsp) contains clj-kondo so can also be used within a continuous integration workflow as well as provide .
 
-
 ## Format Check and Fix
 
 Code is easier to read and work with when it is consistent format that follows common rules.
@@ -102,13 +95,11 @@ A consistent format between editors also minimises version control changes not r
 * [cljstyle](https://github.com/greglook/cljstyle){target=_blank} - binary and library (re-write of cljfmt)
 * [zprint](https://github.com/kkinnear/zprint){target=_blank} - binary & library
 
-
 ??? INFO "Tooling that uses the Clojure Style Guide"
     Emacs `clojure-mode` and Clojure LSP (via cljfmt) format code following the most common Clojure style guide rules, although cljfmt rules are quite strick so Practicalli disables many of them.
 
     cljstyle default configuration follows the majority of styles and has the same defaults as cljfmt. Practicalli Clojure CLI Config tweaks a few rules to make code more readable and allow for repl design experiments.
 
-
 ### cljstyle
 
 Cljstyle is a rewrite of cljfmt, designed to be easier to configure. The default rules implement many of the style rules from the Clojure community style guide and is compatible with cljfmt.
@@ -118,7 +109,6 @@ Call with the `check` option to report formatting issues, providing a coloured d
 ![Clojure cljstyle format tool - check format diff example](https://raw.githubusercontent.com/practicalli/graphic-design/live/clojure/clojure-cljstyle-check-diff-example-light.png#only-light)
 ![Clojure cljstyle format tool - check format diff example](https://raw.githubusercontent.com/practicalli/graphic-design/live/clojure/clojure-cljstyle-check-diff-example-dark.png#only-dark)
 
-
 Call with `fix` option to automatically update all Clojure files with fixes, indicating which files have changed.
 
 Cljstyle will examine all files in the current directory and any sub-directories.
@@ -141,7 +131,6 @@ Cljstyle will examine all files in the current directory and any sub-directories
     cljstyle fix
     ```
 
-
 === "Practicalli Clojure CLI Config"
     cljstyle can be used as a library without installing the cljstyle binary.  [Practicalli Clojure CLI Config](/clojure/clojure-cli/practicalli-config/) defines the `:format/cljstyle` alias which should be passed wither the `check` or `format` option
 
@@ -191,7 +180,6 @@ Cljstyle will examine all files in the current directory and any sub-directories
 !!! HINT "Stage changes before automatically fixing format"
     Practicalli suggests staging (or committing) changes before running `cljstyle fix` to easily undo undesired changes or simply confirm what changes have been made
 
-
 !!! EXAMPLE "Practicall configuration"
     Practicalli updated the default cljstyle configuration with the following changes
 
@@ -212,7 +200,6 @@ Cljstyle will examine all files in the current directory and any sub-directories
       {:enabled? false}
     ```
 
-
 ### cljfmt
 
 cljfmt is not available as a separate binary, although it a fixed part of the Clojure LSP server implementation.
@@ -236,7 +223,6 @@ Or specify cljfmt configuration within the Clojure LSP configuration file
 
     The default cljfmt rules feel overly strict and Practicalli configuration disables the more draconian rules to make code far more readable
 
-
 ### zprint
 
 zprint is a highly configurable format tool for both Clojure code and Clojure/EDN structures, available as a library and command line tool
@@ -245,7 +231,6 @@ zprint has advanced features over cljstyle and cljfmt, although may require some
 
 [zprint available styles](https://github.com/kkinnear/zprint/blob/main/doc/reference.md#style-and-style-map){target=_blank .md-button}
 
-
 ??? WARNING "No built-in diff option"
     zprint requires an external diff tool to see the format changes made, as zprint only reports on the files changed and not the content of those files that has changed.
 
@@ -288,7 +273,6 @@ zprint has advanced features over cljstyle and cljfmt, although may require some
     zprint -lfsw **/*.clj *.edn *.clj
     ```
 
-
 === "Practicalli Clojure CLI Config"
     zprint can be used as a library without installing the binary.  [Practicalli Clojure CLI Config](/clojure/clojure-cli/practicalli-config/) defines the `:format/zprint` alias which checks the format of a file and reports which files required
 
@@ -339,7 +323,6 @@ zprint has advanced features over cljstyle and cljfmt, although may require some
 
     `$HOME/.zprintrc` is used for the configuration applied to all files, although this can be overridden in each project (or even as zprint comments in particular files)
 
-
 [zprint - GitHub repo](https://github.com/kkinnear/zprint){target=_blank .md-button}
 [zprint - clojars](https://clojars.org/zprint){target=_blank .md-button}
 [zprint - cljdoc](https://cljdoc.org/d/zprint/zprint/1.2.5/doc/introduction){target=_blank .md-button}

docs/code-quality/index.md

@@ -9,12 +9,10 @@ Those same tools can check important quality rules when sharing code via continu
 
 The development team should agree on the rules that are valueable for these tools to apply, including those recommended by the community around the programming language or configuration file specification.
 
-
 ## Recommended Tools
 
 MegaLinter provides an extensive range of lint tools all in one, using docker images to remove tool installation requirements.
 
 [MegaLinter - extensive collection of lint tools](megalinter.md){target=_blank .md-button}
 
-
 [Clojure Quality Tools](clojure.md){target=_blank .md-button}

docs/code-quality/megalinter.md

@@ -13,7 +13,6 @@ Supported Linters have their own page listing the lint and format tools it provi
 
     MegaLinter run via a GitHub workflow has no requirements
 
-
 ## MegaLinter Locally
 
 The most effective way to manage lint and format issues is to run MegaLinter locally, before pushing changes to a Continuous Integration service.
@@ -24,7 +23,6 @@ Install a recent version of [:globe_with_meridians: Node.js](https://nodejs.org/
 
 > `npx mega-linter-runner` runs MegaLinter without the need for a specific npm install.
 
-
 ### Create a configuration
 
 !!! HINT "Use the Practicalli MegaLinter Configuration"
@@ -69,7 +67,6 @@ Use the `--fix` option with the local MegaLinter runner to automatically apply l
 ??? HINT "Stage or Commit changes before MegaLinter runner automatic fix"
     If code and configuration changes are staged or committed before running with `--fix` then automatic fixes can easily be discarded or treated as a separate commit using any Git tool.
 
-
 !!! NOTE ""
     ```shell
     npx mega-linter-runner --fix --flavor java --env "'MEGALINTER_CONFIG=.github/config/megalinter.yaml'" --remove-container
@@ -93,24 +90,22 @@ Add a `lint` task to the project Makefile and run `make lint` to call the `mega-
 !!! HINT "Options for MegaLinter Runner"
     [MegaLinter Runner options](https://megalinter.io/latest/mega-linter-runner/)
 
-
 ## MegaLinter Configuration
 
 Create a configuration file to use with the local `mega-linter-runner` and [GitHub workflow](#github-workflow)
 
 `.github/config/megalinter.yaml` is a recommeded location for the MegaLinter configuration file, especially when using GitHub workflow.
 
-
 ??? EXAMPLE "Practicalli MegaLinter Configuration"
     ```yaml
     ---
     # Configuration file for MegaLinter
     #
     # General configuration:
-    # https://oxsecurity.github.io/megalinter/configuration/
+    # <https://oxsecurity.github.io/megalinter/configuration/>
     #
     # Specific Linters:
-    # https://oxsecurity.github.io/megalinter/latest/supported-linters/
+    # <https://oxsecurity.github.io/megalinter/latest/supported-linters/>
 
     # ------------------------
     # Linters