From e85c7ab07fcce1165682c81ded91c11c81557cb4 Mon Sep 17 00:00:00 2001 From: Nico Korthout Date: Sat, 18 Dec 2021 12:04:35 +0100 Subject: [PATCH] Warn multimodule users about **/*.md includes Including '**/*.md' means that all md files in all sub directories are found. In a multi-module maven project, where spotless is run for each module it would mean that markdown files in sub modules are also found by modules at a higher level of the module hierarchie (i.e. sub modules are sub directories of an other module). This means that files would be processed by the formatter multiple times. Which is obviously less performant. Generally, users should be proteced from this, by decent default settings. However, if we would not include '**/*.md' users might be surprised to learn that some of their files are left untouched. Instead, I chose to warn multi-module users specifically about this. Because the impact (and surprise) of not formatting files in nested folder structures is likely greater than the hit in performance due to processing the files multiple times. Also note that the first problem occurs for both regular maven projects as well as multi-module projects and the latter only occurs on multi-module projects. --- plugin-maven/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/plugin-maven/README.md b/plugin-maven/README.md index 005f125df7..3323d5c65b 100644 --- a/plugin-maven/README.md +++ b/plugin-maven/README.md @@ -594,6 +594,7 @@ All configuration settings are optional, they are described in detail [here](htt + *.md **/*.md