support provider prefix in generated filenames

[ctreatma]

This PR introduces a --use-provider-prefix flag for the tfplugindocs generate command. The flag defaults to false, in which case the command behavior around file names matches existing behavior. When the provider prefix is enabled with tfplugindocs generate --use-provider-prefix, resource and data source file names include the <providerShortName>_ prefix.

The conventional paths documentation is updated to cover default behavior and behavior with the --use-provider-prefix flag. Tests haven't been updated yet.

Closes #347

[hashicorp-cla]

All committers have signed the CLA.

[SBGoods]

Hi @ctreatma,
Thank you for the contribution. Our general design philosophy around terraform-plugin-docs is to encourage Terraform public registry and provider ecosystem documentation best practices. The Terraform public registry documentation convention and the majority of Terraform providers on the public registry do not use a provider prefix in file names. Therefore, we are reluctant to add an option to support a provider prefix in the generate subcommand. We have decided to solve underlying issue in #349 by removing the provider prefix from filenames during the migrate command.

I will close out this PR but feel free to reach out and open another issue if you encounter anything else.

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.