Refactor schemamd and functionmd packages to internal/

hashicorp · Mar 13, 2024 · a1b156e · a1b156e
1 parent cc6300a
commit a1b156e
Show file tree

Hide file tree

Showing 28 changed files with 14 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -158,8 +158,8 @@ The `validate` subcommand can be used to validate the provider website documenta
 |---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `InvalidDirectoriesCheck` | Checks for valid subdirectory structure and throws an error if an invalid Terraform Provider documentation subdirectory is found.                                                   |
 | `MixedDirectoriesCheck`   | Throws an error if both legacy documentation (`/website/docs`) and registry documentation (`/docs`) are found.                                                                      |
-| `NumberOfFilesCheck`      | Throws an error if the number of files in a directory is larger than the registry limit.                                                                                            |
-| `FileSizeCheck`           | Throws an error if the documentation file is above the registry storage limit.                                                                                                      |
+| `NumberOfFilesCheck`      | Throws an error if the number of files in a directory is larger than the public registry limit.                                                                                     |
+| `FileSizeCheck`           | Throws an error if the documentation file is above the public registry storage limit.                                                                                               |
 | `FileExtensionCheck`      | Throws an error if the extension of the given file is not a valid registry documentation extension.                                                                                 |
 | `FrontMatterCheck`        | Checks the YAML frontmatter of documentation for missing required fields or invalid fields.                                                                                         |
 | `FileMismatchCheck`       | Throws an error if the names/number of resources/datasources/functions in the provider schema does not match the names/number of files in the corresponding documentation directory |
@@ -327,12 +327,6 @@ Your help and patience is truly appreciated.
 
 ## Contributing
 
-## Go Compatibility
-
-This project follows the [support policy](https://golang.org/doc/devel/release.html#policy) of Go as its support policy. The two latest major releases of Go are supported by the project.
-
-Currently, that means Go **1.21** or later must be used when including this project as a dependency.
-
 ### License Headers
 All source code files in this repository (excluding autogenerated files like `go.mod`, prose, and files excluded in [.copywrite.hcl](.copywrite.hcl)) must have a license header at the top.
 

diff --git a/functionmd/render.go → internal/functionmd/render.go b/functionmd/render.go → internal/functionmd/render.go
@@ -10,7 +10,7 @@ import (
 
 	tfjson "github.com/hashicorp/terraform-json"
 
-	"github.com/hashicorp/terraform-plugin-docs/schemamd"
+	"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
 )
 
 // RenderArguments returns a Markdown formatted string of the function arguments.

diff --git a/functionmd/render_test.go → internal/functionmd/render_test.go b/functionmd/render_test.go → internal/functionmd/render_test.go
@@ -12,7 +12,7 @@ import (
 	"github.com/google/go-cmp/cmp"
 	tfjson "github.com/hashicorp/terraform-json"
 
-	"github.com/hashicorp/terraform-plugin-docs/functionmd"
+	"github.com/hashicorp/terraform-plugin-docs/internal/functionmd"
 )
 
 func TestRenderArguments(t *testing.T) {

diff --git a/functionmd/testdata/example_arguments.md → .../functionmd/testdata/example_arguments.md b/functionmd/testdata/example_arguments.md → .../functionmd/testdata/example_arguments.md
diff --git a/functionmd/testdata/example_signature.md → .../functionmd/testdata/example_signature.md b/functionmd/testdata/example_signature.md → .../functionmd/testdata/example_signature.md
diff --git a/functionmd/testdata/example_vararg.md → ...nal/functionmd/testdata/example_vararg.md b/functionmd/testdata/example_vararg.md → ...nal/functionmd/testdata/example_vararg.md
diff --git a/...d/testdata/function_signature.schema.json → ...d/testdata/function_signature.schema.json b/...d/testdata/function_signature.schema.json → ...d/testdata/function_signature.schema.json
diff --git a/internal/provider/template.go b/internal/provider/template.go
@@ -16,10 +16,10 @@ import (
 
 	tfjson "github.com/hashicorp/terraform-json"
 
-	"github.com/hashicorp/terraform-plugin-docs/functionmd"
+	"github.com/hashicorp/terraform-plugin-docs/internal/functionmd"
 	"github.com/hashicorp/terraform-plugin-docs/internal/mdplain"
+	"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
 	"github.com/hashicorp/terraform-plugin-docs/internal/tmplfuncs"
-	"github.com/hashicorp/terraform-plugin-docs/schemamd"
 )
 
 const (

diff --git a/schemamd/behaviors.go → internal/schemamd/behaviors.go b/schemamd/behaviors.go → internal/schemamd/behaviors.go
diff --git a/schemamd/behaviors_test.go → internal/schemamd/behaviors_test.go b/schemamd/behaviors_test.go → internal/schemamd/behaviors_test.go
diff --git a/schemamd/render.go → internal/schemamd/render.go b/schemamd/render.go → internal/schemamd/render.go
diff --git a/schemamd/render_test.go → internal/schemamd/render_test.go b/schemamd/render_test.go → internal/schemamd/render_test.go
@@ -11,7 +11,8 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	tfjson "github.com/hashicorp/terraform-json"
-	"github.com/hashicorp/terraform-plugin-docs/schemamd"
+
+	"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
 )
 
 func TestRender(t *testing.T) {

diff --git a/schemamd/testdata/aws_acm_certificate.md → .../schemamd/testdata/aws_acm_certificate.md b/schemamd/testdata/aws_acm_certificate.md → .../schemamd/testdata/aws_acm_certificate.md
diff --git a/.../testdata/aws_acm_certificate.schema.json → .../testdata/aws_acm_certificate.schema.json b/.../testdata/aws_acm_certificate.schema.json → .../testdata/aws_acm_certificate.schema.json
diff --git a/...d/testdata/aws_route_table_association.md → ...d/testdata/aws_route_table_association.md b/...d/testdata/aws_route_table_association.md → ...d/testdata/aws_route_table_association.md
diff --git a/...a/aws_route_table_association.schema.json → ...a/aws_route_table_association.schema.json b/...a/aws_route_table_association.schema.json → ...a/aws_route_table_association.schema.json
diff --git a/...mamd/testdata/awscc_acmpca_certificate.md → ...mamd/testdata/awscc_acmpca_certificate.md b/...mamd/testdata/awscc_acmpca_certificate.md → ...mamd/testdata/awscc_acmpca_certificate.md
diff --git a/...data/awscc_acmpca_certificate.schema.json → ...data/awscc_acmpca_certificate.schema.json b/...data/awscc_acmpca_certificate.schema.json → ...data/awscc_acmpca_certificate.schema.json
diff --git a/schemamd/testdata/awscc_logs_log_group.md → ...schemamd/testdata/awscc_logs_log_group.md b/schemamd/testdata/awscc_logs_log_group.md → ...schemamd/testdata/awscc_logs_log_group.md
diff --git a/...testdata/awscc_logs_log_group.schema.json → ...testdata/awscc_logs_log_group.schema.json b/...testdata/awscc_logs_log_group.schema.json → ...testdata/awscc_logs_log_group.schema.json
diff --git a/schemamd/write_attribute_description.go → ...l/schemamd/write_attribute_description.go b/schemamd/write_attribute_description.go → ...l/schemamd/write_attribute_description.go
diff --git a/schemamd/write_attribute_description_test.go → ...emamd/write_attribute_description_test.go b/schemamd/write_attribute_description_test.go → ...emamd/write_attribute_description_test.go
@@ -11,7 +11,7 @@ import (
 	tfjson "github.com/hashicorp/terraform-json"
 	"github.com/zclconf/go-cty/cty"
 
-	"github.com/hashicorp/terraform-plugin-docs/schemamd"
+	"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
 )
 
 func TestWriteAttributeDescription(t *testing.T) {

diff --git a/schemamd/write_block_type_description.go → .../schemamd/write_block_type_description.go b/schemamd/write_block_type_description.go → .../schemamd/write_block_type_description.go
diff --git a/...mamd/write_block_type_description_test.go → ...mamd/write_block_type_description_test.go b/...mamd/write_block_type_description_test.go → ...mamd/write_block_type_description_test.go
@@ -9,7 +9,8 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	tfjson "github.com/hashicorp/terraform-json"
-	"github.com/hashicorp/terraform-plugin-docs/schemamd"
+
+	"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
 )
 
 func TestWriteBlockTypeDescription(t *testing.T) {

diff --git a/...rite_nested_attribute_type_description.go → ...rite_nested_attribute_type_description.go b/...rite_nested_attribute_type_description.go → ...rite_nested_attribute_type_description.go
diff --git a/...nested_attribute_type_description_test.go → ...nested_attribute_type_description_test.go b/...nested_attribute_type_description_test.go → ...nested_attribute_type_description_test.go
@@ -9,8 +9,9 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	tfjson "github.com/hashicorp/terraform-json"
-	"github.com/hashicorp/terraform-plugin-docs/schemamd"
 	"github.com/zclconf/go-cty/cty"
+
+	"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
 )
 
 func TestWriteNestedAttributeTypeDescription(t *testing.T) {

diff --git a/schemamd/write_type.go → internal/schemamd/write_type.go b/schemamd/write_type.go → internal/schemamd/write_type.go
diff --git a/schemamd/write_type_test.go → internal/schemamd/write_type_test.go b/schemamd/write_type_test.go → internal/schemamd/write_type_test.go
@@ -11,7 +11,7 @@ import (
 	"github.com/google/go-cmp/cmp"
 	"github.com/zclconf/go-cty/cty"
 
-	"github.com/hashicorp/terraform-plugin-docs/schemamd"
+	"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
 )
 
 func TestWriteType(t *testing.T) {