Introduce variable validation output into markdown table output. #675

rquadling · 2023-03-04T18:10:59Z

Description of your changes

Work in progress fix for #674.

This currently makes output like

## Inputs

| Name | Description | Type | Default | Required | Validation |
|------|-------------|------|---------|:--------:|------------|
| <a name="input_variable_with_no_validation"></a> [variable\_with\_no\_validation](#input\_variable\_with\_no\_validation) | This variable has no validation | `string` | `""` | no | None |
| <a name="input_variable_with_one_validation"></a> [variable\_with\_one\_validation](#input\_variable\_with\_one\_validation) | This variable has one validation | `string` | `""` | no | var.variable\_with\_one\_validation must be empty or 10 characters long. |
| <a name="input_variable_with_two_validations"></a> [variable\_with\_two\_validations](#input\_variable\_with\_two\_validations) | This variable has two validations | `string` | n/a | yes | var.variable\_with\_two\_validations must be 10 characters long.<br>var.variable\_with\_two\_validations must start with 'magic'. |

which renders as ...

=========================================

Inputs

Name	Description	Type	Default	Required	Validation
variable_with_no_validation	This variable has no validation	`string`	`""`	no	None
variable_with_one_validation	This variable has one validation	`string`	`""`	no	var.variable_with_one_validation must be empty or 10 characters long.
variable_with_two_validations	This variable has two validations	`string`	n/a	yes	var.variable_with_two_validations must be 10 characters long. var.variable_with_two_validations must start with 'magic'.

=========================================

If anyone can provide pointers on what I need to do next (where/how tests are put together, what else to update, etc).

so0k · 2023-04-01T02:31:13Z

go.sum

+github.com/rquadling/terraform-config-inspect v0.0.0-20230303172622-9dd357c8a974 h1:iUSNgwjav+yZfRPSGUyywed1cvQdJPw8HaDRR1TMfw0=
+github.com/rquadling/terraform-config-inspect v0.0.0-20230303172622-9dd357c8a974/go.mod h1:l8HcFPm9cQh6Q0KSWoYPiePqMvRFenybP1CH2MjKdlg=


this comment posted yesterday for the upstream terraform-config-inspect libraries support on validation, doesn't look promising

hashicorp/terraform-config-inspect#74 (comment)

would it make sense to use a fork?

I'd be happy to maintain a fork, but I'm not an expert in Terraform or Go, but with help I'm happy to learn.

I've asked if there is any other option of having enhancements being maintained as a community fork or branch.

For me, the biggest issue is about trust. I COULD create the lib, but my experience in Go is not good enough to know if I've introduced something that will cause problems upstream. Having the package within the Hashicorp domain would, I hope, get a greater number of eyes on it and so better reviews, etc.

Another option is to resurrect https://github.com/terraform-docs/terraform-config-inspect.

jason-johnson · 2023-09-14T12:05:50Z

format/templates/markdown_table_inputs.tmpl

@@ -12,10 +12,12 @@
        {{- if .Config.Settings.Type }} Type |{{ end }}
        {{- if .Config.Settings.Default }} Default |{{ end }}
        {{- if .Config.Settings.Required }} Required |{{ end }}
+        {{- if .Config.Settings.Required }} Validation |{{ end }}


Shouldn't this be Config.Settings.Validation?

rafaljanicki · 2024-07-04T12:56:29Z

Hey, that'd be really fancy to have! Any chance to get this merged?

rquadling · 2024-07-05T11:18:43Z

The main problem is that the changes to terraform-docs also requires a change to another Hashicorp library that they will NOT accept PRs on. So I cloned it. And made the changes. But GoLang is not my primary language and so I'm needing community support on the fork (make sure I've set it up properly and keeping it upto date, but also working out the "releases" thing as ... again ... GoLang is really not my primary language).

Once the fork of the blocked Hashicorp library is accepted (it could be moved and re-instate the Terraform Docs fork that got abandoned a long time ago), then this PR makes more sense.

For me, the BIG advantage is that, for me, 'validation/error messages' become part of the auto-generated documentation.

It means any module a developer builds, that has validation, they automatically show the possible errors to their users.

It means you really only have to write the documentation about validations once. In code. Where it will be used. No need to manually update a manual or another README.

This really does make a lot of sense.

I just don't know how to shout about it loud enough to get help in getting in it, nor do I know what I've missed that is more "project" oriented.

So anyone reading this comment and has SOME time to spare, please review and help me move it forward!

I know that there are currently conflicts, but this is on 2 files I really don't know how to handle, as like I said, in GoLang, I'm a newbie! So please help!!

Signed-off-by: Richard Quadling <RQuadling@GMail.com>

…from rquadling/terraform-config-inspet Signed-off-by: Richard Quadling <RQuadling@GMail.com>

These formats already have content filtering, so adding filtering for validations seemed appropriate Signed-off-by: Richard Quadling <RQuadling@GMail.com>

Signed-off-by: Richard Quadling <RQuadling@GMail.com>

The tests already had a PrintDescriptions, so added PrintValidations, and PrintEverything Signed-off-by: Richard Quadling <RQuadling@GMail.com>

Whilst the variable_with_no_validation is just a standard string, it made sense to have one just for the set of 0, 1, and many validations. Signed-off-by: Richard Quadling <RQuadling@GMail.com>

Signed-off-by: Richard Quadling <RQuadling@GMail.com>

The updates here were generated by `make docs`. Signed-off-by: Richard Quadling <RQuadling@GMail.com>

This was all done by hand as I didn't work out how to automate the updates and have version control check for things being wrong or inconsistent. Signed-off-by: Richard Quadling <RQuadling@GMail.com>

pull-request-size bot added the size/M label Mar 4, 2023

so0k reviewed Apr 1, 2023

View reviewed changes

jason-johnson reviewed Sep 14, 2023

View reviewed changes

rquadling force-pushed the master branch from 8ef8656 to 46eb39c Compare September 22, 2023 09:31

rquadling force-pushed the master branch from 46eb39c to c65c478 Compare December 29, 2023 16:15

pull-request-size bot added size/XXL and removed size/M labels Dec 29, 2023

rquadling force-pushed the master branch from c65c478 to 5f54c02 Compare December 29, 2023 16:17

rquadling mentioned this pull request Dec 29, 2023

Display input validation error messages. #674

Open

rquadling force-pushed the master branch from 3e1df23 to b925341 Compare January 18, 2024 09:59

rquadling force-pushed the master branch 4 times, most recently from c738f8d to 40ea1fb Compare March 22, 2024 13:32

rquadling added 14 commits April 9, 2025 17:04

Introduce variable validation output into markdown table output.

aac6037

Signed-off-by: Richard Quadling <RQuadling@GMail.com>

Correct property used to create validation column heading

4c9bd02

Signed-off-by: Richard Quadling <RQuadling@GMail.com>

Update to the latest versions of things, especially the rebased fork …

7bfa45d

…from rquadling/terraform-config-inspet Signed-off-by: Richard Quadling <RQuadling@GMail.com>

Add --validation option to asciidoc, markdown, and hcl formats

f5bf6f3

These formats already have content filtering, so adding filtering for validations seemed appropriate Signed-off-by: Richard Quadling <RQuadling@GMail.com>

Reset the alignment of tfvars will now happen if validations are present

08eadb3

Signed-off-by: Richard Quadling <RQuadling@GMail.com>

Add validation to the map of possible command settings

f44d820

Signed-off-by: Richard Quadling <RQuadling@GMail.com>

Minor typos

6170a9c

Signed-off-by: Richard Quadling <RQuadling@GMail.com>

Add showValidation function for tfvars_hcl templates

19f10f5

Signed-off-by: Richard Quadling <RQuadling@GMail.com>

Create tests for tfvars_hcl

89cba71

The tests already had a PrintDescriptions, so added PrintValidations, and PrintEverything Signed-off-by: Richard Quadling <RQuadling@GMail.com>

Add some variables related to testing validation output

a4cbeac

Whilst the variable_with_no_validation is just a standard string, it made sense to have one just for the set of 0, 1, and many validations. Signed-off-by: Richard Quadling <RQuadling@GMail.com>

Add validation to the input templates

5f28b97

Signed-off-by: Richard Quadling <RQuadling@GMail.com>

Updated generated documentation

f9d43e8

The updates here were generated by `make docs`. Signed-off-by: Richard Quadling <RQuadling@GMail.com>

Update the testdata results

bf499ca

This was all done by hand as I didn't work out how to automate the updates and have version control check for things being wrong or inconsistent. Signed-off-by: Richard Quadling <RQuadling@GMail.com>

Linter fix

bdf7620

rquadling added 3 commits April 9, 2025 17:16

Do not attempt to publish

5d5b1ad

Remove alias from repo

c167902

Tidy mods

091712c

rquadling force-pushed the master branch from 6092bf9 to 091712c Compare April 10, 2025 18:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Introduce variable validation output into markdown table output. #675

Introduce variable validation output into markdown table output. #675

Uh oh!

rquadling commented Mar 4, 2023

Uh oh!

so0k Apr 1, 2023

Uh oh!

rquadling Apr 8, 2023

Uh oh!

rquadling Apr 14, 2023

Uh oh!

jason-johnson Sep 14, 2023

Uh oh!

rafaljanicki commented Jul 4, 2024

Uh oh!

rquadling commented Jul 5, 2024

Uh oh!

Uh oh!

		github.com/rquadling/terraform-config-inspect v0.0.0-20230303172622-9dd357c8a974 h1:iUSNgwjav+yZfRPSGUyywed1cvQdJPw8HaDRR1TMfw0=
		github.com/rquadling/terraform-config-inspect v0.0.0-20230303172622-9dd357c8a974/go.mod h1:l8HcFPm9cQh6Q0KSWoYPiePqMvRFenybP1CH2MjKdlg=

Introduce variable validation output into markdown table output. #675

Are you sure you want to change the base?

Introduce variable validation output into markdown table output. #675

Uh oh!

Conversation

rquadling commented Mar 4, 2023

Description of your changes

Inputs

Uh oh!

so0k Apr 1, 2023

Choose a reason for hiding this comment

Uh oh!

rquadling Apr 8, 2023

Choose a reason for hiding this comment

Uh oh!

rquadling Apr 14, 2023

Choose a reason for hiding this comment

Uh oh!

jason-johnson Sep 14, 2023

Choose a reason for hiding this comment

Uh oh!

rafaljanicki commented Jul 4, 2024

Uh oh!

rquadling commented Jul 5, 2024

Uh oh!

Uh oh!