Make main module doc generation optional when generating recursively

[blakegong]

Description of your changes

When using recursive: true, terraform-docs currently generates the doc for ./{OUTPUT_FILE} and ./modules/*/{OUTPUT_FILE}. However, for some pure module repositories, the generation at ./{OUTPUT_FILE} might be unwanted.

In #613, skip-root-readme was suggested as the option name. However, in my opinion, it is the best to name booleans in a non-negative manner to avoid confusion when reading the code, which means skip (or e.g. no-root) should be avoided. Therefore, I went with --recursive-include-main which defaults to true, to preserve existing behaviour.

Closes #613.

I have:

• Read and followed terraform-docs' [contribution process].
• All tests pass when I run make test.

How has this code been tested

I tried it on my own TF modules repository, which has a vpc module inside:

➜  terraform-modules ✗ terraform-docs markdown table --recursive --output-file README.md .          
README.md updated successfully
modules/vpc/README.md updated successfully

➜  terraform-modules ✗ terraform-docs markdown table --recursive --recursive-include-main=false --output-file README.md .
modules/vpc/README.md updated successfully

Notice that with --recursive-include-main=false, README.md updated successfully message has disappeared, as it is no longer being generated.

[blakegong]

Oops just realised there are documents to update, will add that. Edit: docs added

Meanwhile, do let me know if this PR looks reasonable to you :)

[blakegong]

@khos2ow @metmajer could you help take a look? 🙏

[blakegong]

@khos2ow 👋 🙏

[blakegong]

@khos2ow @metmajer could you help take a look again? 🙏🙏

All the CI runs are green. Just let me know what you think!

[blakegong]

@khos2ow @metmajer pinging for reviews 🙏

[miguelaferreira]

I'm currently unable to run terraform-docs via pre-commit checks because of #613. It would be great if a maintainer would spare some time to review this PR.

[nosrio]

Hi! What is missing for this to be merged?

[armsnyder]

This looks like a very simple and low risk change. I hope a maintainer sees this and can get it merged.

[armsnyder]

Looks like you don't need to include (default true) in the regular description since then it gets added twice.

[riemers]

Started 2022, is the project still maintained?

[martinm82]

Any chance this PR could be merged as this is a great addition to the available functionality.

[DaveKLloyd]

I would really like his feature also. Will this be merged any time soon?

[kngatineau]

Would love to see this merged, would be handy!