tfproviderdocs icon indicating copy to clipboard operation
tfproviderdocs copied to clipboard

check: Verify arguments and attributes are listed in alphabetical order

Open anGie44 opened this issue 5 years ago • 1 comments

Would be nice to help readability by sorting arguments and attributes listed in a resource/data-source documentation. Additional handling might be with block attributes where we generally define them and their nested attributes in a sub-heading outside of the bullet point lists.

anGie44 avatar Jul 17 '20 16:07 anGie44

Experimental support for this has been added via new -enable-contents-check and -require-schema-ordering flags in version 0.8.0 of tfproviderdocs. Please note that this only supports the "top" arguments/attribute lists and not sub-sections at the current time.

bflad avatar Oct 26 '20 19:10 bflad

This project will be archived in preference of the revamped validate command in github.com/hashicorp/terraform-plugin-docs implementing much of the basic validation logic from this project. Feature requests should be submitted over there at this point.

bflad avatar May 19 '24 19:05 bflad