Skip to content

Commit 90942f7

Browse files
khos2owkhos2ow
committed
Move format package from internal to public
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
1 parent ca8f833 commit 90942f7

File tree

248 files changed

+62
-17
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

248 files changed

+62
-17
lines changed

‎internal/format/asciidoc_document.go renamed to ‎format/asciidoc_document.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ func NewAsciidocDocument(settings *print.Settings) print.Engine {
3737
tt := template.New(settings, items...)
3838
tt.CustomFunc(gotemplate.FuncMap{
3939
"type": func(t string) string {
40-
result, extraline := printFencedAsciidocCodeBlock(t, "hcl")
40+
result, extraline := PrintFencedAsciidocCodeBlock(t, "hcl")
4141
if !extraline {
4242
result += "\n"
4343
}
@@ -47,7 +47,7 @@ func NewAsciidocDocument(settings *print.Settings) print.Engine {
4747
if v == "n/a" {
4848
return v
4949
}
50-
result, extraline := printFencedAsciidocCodeBlock(v, "json")
50+
result, extraline := PrintFencedAsciidocCodeBlock(v, "json")
5151
if !extraline {
5252
result += "\n"
5353
}

‎internal/format/asciidoc_document_test.go renamed to ‎format/asciidoc_document_test.go

File renamed without changes.

‎internal/format/asciidoc_table.go renamed to ‎format/asciidoc_table.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,13 @@ func NewAsciidocTable(settings *print.Settings) print.Engine {
3737
tt := template.New(settings, items...)
3838
tt.CustomFunc(gotemplate.FuncMap{
3939
"type": func(t string) string {
40-
inputType, _ := printFencedCodeBlock(t, "")
40+
inputType, _ := PrintFencedCodeBlock(t, "")
4141
return inputType
4242
},
4343
"value": func(v string) string {
4444
var result = "n/a"
4545
if v != "" {
46-
result, _ = printFencedCodeBlock(v, "")
46+
result, _ = PrintFencedCodeBlock(v, "")
4747
}
4848
return result
4949
},

‎internal/format/asciidoc_table_test.go renamed to ‎format/asciidoc_table_test.go

File renamed without changes.

‎internal/format/common_test.go renamed to ‎format/common_test.go

File renamed without changes.

‎format/doc.go

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
/*
2+
Copyright 2021 The terraform-docs Authors.
3+
4+
Licensed under the MIT license (the "License"); you may not
5+
use this file except in compliance with the License.
6+
7+
You may obtain a copy of the License at the LICENSE file in
8+
the root directory of this source tree.
9+
*/
10+
11+
// Package format provides different, out of the box supported, output formats.
12+
//
13+
// Usage
14+
//
15+
// A specific format can be instantiated either for `format.Factory()` function or
16+
// directly calling its function (e.g. `NewMarkdownTable`, etc)
17+
//
18+
// formatter, err := format.Factory("markdown table", settings)
19+
// if err != nil {
20+
// return err
21+
// }
22+
//
23+
// generator, err := formatter.Generate(tfmodule)
24+
// if err != nil {
25+
// return err
26+
// }
27+
//
28+
// output, err := generator.ExecuteTemplate("")
29+
// if err != nil {
30+
// return err
31+
// }
32+
//
33+
// Supported formats are:
34+
//
35+
// • `NewAsciidocDocument`
36+
// • `NewAsciidocTable`
37+
// • `NewJSON`
38+
// • `NewMarkdownDocument`
39+
// • `NewMarkdownTable`
40+
// • `NewPretty`
41+
// • `NewTfvarsHCL`
42+
// • `NewTfvarsJSON`
43+
// • `NewTOML`
44+
// • `NewXML`
45+
// • `NewYAML`
46+
//
47+
package format

‎internal/format/factory.go renamed to ‎format/factory.go

File renamed without changes.

‎internal/format/factory_test.go renamed to ‎format/factory_test.go

File renamed without changes.

‎internal/format/json.go renamed to ‎format/json.go

File renamed without changes.

‎internal/format/json_test.go renamed to ‎format/json_test.go

File renamed without changes.

‎internal/format/markdown_document.go renamed to ‎format/markdown_document.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ func NewMarkdownDocument(settings *print.Settings) print.Engine {
3535
tt := template.New(settings, items...)
3636
tt.CustomFunc(gotemplate.FuncMap{
3737
"type": func(t string) string {
38-
result, extraline := printFencedCodeBlock(t, "hcl")
38+
result, extraline := PrintFencedCodeBlock(t, "hcl")
3939
if !extraline {
4040
result += "\n"
4141
}
@@ -45,7 +45,7 @@ func NewMarkdownDocument(settings *print.Settings) print.Engine {
4545
if v == "n/a" {
4646
return v
4747
}
48-
result, extraline := printFencedCodeBlock(v, "json")
48+
result, extraline := PrintFencedCodeBlock(v, "json")
4949
if !extraline {
5050
result += "\n"
5151
}

‎internal/format/markdown_document_test.go renamed to ‎format/markdown_document_test.go

File renamed without changes.

‎internal/format/markdown_table.go renamed to ‎format/markdown_table.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ func NewMarkdownTable(settings *print.Settings) print.Engine {
3535
tt := template.New(settings, items...)
3636
tt.CustomFunc(gotemplate.FuncMap{
3737
"type": func(t string) string {
38-
inputType, _ := printFencedCodeBlock(t, "")
38+
inputType, _ := PrintFencedCodeBlock(t, "")
3939
return inputType
4040
},
4141
"value": func(v string) string {
4242
var result = "n/a"
4343
if v != "" {
44-
result, _ = printFencedCodeBlock(v, "")
44+
result, _ = PrintFencedCodeBlock(v, "")
4545
}
4646
return result
4747
},

‎internal/format/markdown_table_test.go renamed to ‎format/markdown_table_test.go

File renamed without changes.

‎internal/format/pretty.go renamed to ‎format/pretty.go

File renamed without changes.

‎internal/format/pretty_test.go renamed to ‎format/pretty_test.go

File renamed without changes.

‎internal/format/templates/asciidoc_document.tmpl renamed to ‎format/templates/asciidoc_document.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_document_footer.tmpl renamed to ‎format/templates/asciidoc_document_footer.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_document_header.tmpl renamed to ‎format/templates/asciidoc_document_header.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_document_inputs.tmpl renamed to ‎format/templates/asciidoc_document_inputs.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_document_modules.tmpl renamed to ‎format/templates/asciidoc_document_modules.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_document_outputs.tmpl renamed to ‎format/templates/asciidoc_document_outputs.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_document_providers.tmpl renamed to ‎format/templates/asciidoc_document_providers.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_document_requirements.tmpl renamed to ‎format/templates/asciidoc_document_requirements.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_document_resources.tmpl renamed to ‎format/templates/asciidoc_document_resources.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_table.tmpl renamed to ‎format/templates/asciidoc_table.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_table_footer.tmpl renamed to ‎format/templates/asciidoc_table_footer.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_table_header.tmpl renamed to ‎format/templates/asciidoc_table_header.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_table_inputs.tmpl renamed to ‎format/templates/asciidoc_table_inputs.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_table_modules.tmpl renamed to ‎format/templates/asciidoc_table_modules.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_table_outputs.tmpl renamed to ‎format/templates/asciidoc_table_outputs.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_table_providers.tmpl renamed to ‎format/templates/asciidoc_table_providers.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_table_requirements.tmpl renamed to ‎format/templates/asciidoc_table_requirements.tmpl

File renamed without changes.

‎internal/format/templates/asciidoc_table_resources.tmpl renamed to ‎format/templates/asciidoc_table_resources.tmpl

File renamed without changes.

‎internal/format/templates/markdown_document.tmpl renamed to ‎format/templates/markdown_document.tmpl

File renamed without changes.

‎internal/format/templates/markdown_document_footer.tmpl renamed to ‎format/templates/markdown_document_footer.tmpl

File renamed without changes.

‎internal/format/templates/markdown_document_header.tmpl renamed to ‎format/templates/markdown_document_header.tmpl

File renamed without changes.

‎internal/format/templates/markdown_document_inputs.tmpl renamed to ‎format/templates/markdown_document_inputs.tmpl

File renamed without changes.

‎internal/format/templates/markdown_document_modules.tmpl renamed to ‎format/templates/markdown_document_modules.tmpl

File renamed without changes.

‎internal/format/templates/markdown_document_outputs.tmpl renamed to ‎format/templates/markdown_document_outputs.tmpl

File renamed without changes.

‎internal/format/templates/markdown_document_providers.tmpl renamed to ‎format/templates/markdown_document_providers.tmpl

File renamed without changes.

‎internal/format/templates/markdown_document_requirements.tmpl renamed to ‎format/templates/markdown_document_requirements.tmpl

File renamed without changes.

‎internal/format/templates/markdown_document_resources.tmpl renamed to ‎format/templates/markdown_document_resources.tmpl

File renamed without changes.

‎internal/format/templates/markdown_table.tmpl renamed to ‎format/templates/markdown_table.tmpl

File renamed without changes.

‎internal/format/templates/markdown_table_footer.tmpl renamed to ‎format/templates/markdown_table_footer.tmpl

File renamed without changes.

‎internal/format/templates/markdown_table_header.tmpl renamed to ‎format/templates/markdown_table_header.tmpl

File renamed without changes.

‎internal/format/templates/markdown_table_inputs.tmpl renamed to ‎format/templates/markdown_table_inputs.tmpl

File renamed without changes.

‎internal/format/templates/markdown_table_modules.tmpl renamed to ‎format/templates/markdown_table_modules.tmpl

File renamed without changes.

‎internal/format/templates/markdown_table_outputs.tmpl renamed to ‎format/templates/markdown_table_outputs.tmpl

File renamed without changes.

‎internal/format/templates/markdown_table_providers.tmpl renamed to ‎format/templates/markdown_table_providers.tmpl

File renamed without changes.

‎internal/format/templates/markdown_table_requirements.tmpl renamed to ‎format/templates/markdown_table_requirements.tmpl

File renamed without changes.

‎internal/format/templates/markdown_table_resources.tmpl renamed to ‎format/templates/markdown_table_resources.tmpl

File renamed without changes.

‎internal/format/templates/pretty.tmpl renamed to ‎format/templates/pretty.tmpl

File renamed without changes.

‎internal/format/templates/tfvars_hcl.tmpl renamed to ‎format/templates/tfvars_hcl.tmpl

File renamed without changes.

‎internal/format/testdata/asciidoc/document-Base.golden renamed to ‎format/testdata/asciidoc/document-Base.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-Empty.golden renamed to ‎format/testdata/asciidoc/document-Empty.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-HideAll.golden renamed to ‎format/testdata/asciidoc/document-HideAll.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-HideEmpty.golden renamed to ‎format/testdata/asciidoc/document-HideEmpty.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-IndentationOfFour.golden renamed to ‎format/testdata/asciidoc/document-IndentationOfFour.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-OnlyDataSources.golden renamed to ‎format/testdata/asciidoc/document-OnlyDataSources.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-OnlyFooter.golden renamed to ‎format/testdata/asciidoc/document-OnlyFooter.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-OnlyHeader.golden renamed to ‎format/testdata/asciidoc/document-OnlyHeader.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-OnlyInputs.golden renamed to ‎format/testdata/asciidoc/document-OnlyInputs.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-OnlyModulecalls.golden renamed to ‎format/testdata/asciidoc/document-OnlyModulecalls.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-OnlyOutputs.golden renamed to ‎format/testdata/asciidoc/document-OnlyOutputs.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-OnlyProviders.golden renamed to ‎format/testdata/asciidoc/document-OnlyProviders.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-OnlyRequirements.golden renamed to ‎format/testdata/asciidoc/document-OnlyRequirements.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-OnlyResources.golden renamed to ‎format/testdata/asciidoc/document-OnlyResources.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-OutputValues.golden renamed to ‎format/testdata/asciidoc/document-OutputValues.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-OutputValuesNoSensitivity.golden renamed to ‎format/testdata/asciidoc/document-OutputValuesNoSensitivity.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-WithAnchor.golden renamed to ‎format/testdata/asciidoc/document-WithAnchor.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-WithRequired.golden renamed to ‎format/testdata/asciidoc/document-WithRequired.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-WithoutDefault.golden renamed to ‎format/testdata/asciidoc/document-WithoutDefault.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/document-WithoutType.golden renamed to ‎format/testdata/asciidoc/document-WithoutType.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-Base.golden renamed to ‎format/testdata/asciidoc/table-Base.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-Empty.golden renamed to ‎format/testdata/asciidoc/table-Empty.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-HideAll.golden renamed to ‎format/testdata/asciidoc/table-HideAll.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-HideEmpty.golden renamed to ‎format/testdata/asciidoc/table-HideEmpty.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-IndentationOfFour.golden renamed to ‎format/testdata/asciidoc/table-IndentationOfFour.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-OnlyDataSources.golden renamed to ‎format/testdata/asciidoc/table-OnlyDataSources.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-OnlyFooter.golden renamed to ‎format/testdata/asciidoc/table-OnlyFooter.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-OnlyHeader.golden renamed to ‎format/testdata/asciidoc/table-OnlyHeader.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-OnlyInputs.golden renamed to ‎format/testdata/asciidoc/table-OnlyInputs.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-OnlyModulecalls.golden renamed to ‎format/testdata/asciidoc/table-OnlyModulecalls.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-OnlyOutputs.golden renamed to ‎format/testdata/asciidoc/table-OnlyOutputs.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-OnlyProviders.golden renamed to ‎format/testdata/asciidoc/table-OnlyProviders.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-OnlyRequirements.golden renamed to ‎format/testdata/asciidoc/table-OnlyRequirements.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-OnlyResources.golden renamed to ‎format/testdata/asciidoc/table-OnlyResources.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-OutputValues.golden renamed to ‎format/testdata/asciidoc/table-OutputValues.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-OutputValuesNoSensitivity.golden renamed to ‎format/testdata/asciidoc/table-OutputValuesNoSensitivity.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-WithAnchor.golden renamed to ‎format/testdata/asciidoc/table-WithAnchor.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-WithRequired.golden renamed to ‎format/testdata/asciidoc/table-WithRequired.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-WithoutDefault.golden renamed to ‎format/testdata/asciidoc/table-WithoutDefault.golden

File renamed without changes.

‎internal/format/testdata/asciidoc/table-WithoutType.golden renamed to ‎format/testdata/asciidoc/table-WithoutType.golden

File renamed without changes.

‎internal/format/testdata/common/footer-FooterFromADOCFile.golden renamed to ‎format/testdata/common/footer-FooterFromADOCFile.golden

File renamed without changes.

‎internal/format/testdata/common/footer-FooterFromMDFile.golden renamed to ‎format/testdata/common/footer-FooterFromMDFile.golden

File renamed without changes.

‎internal/format/testdata/common/footer-FooterFromTFFile.golden renamed to ‎format/testdata/common/footer-FooterFromTFFile.golden

File renamed without changes.

‎internal/format/testdata/common/footer-FooterFromTXTFile.golden renamed to ‎format/testdata/common/footer-FooterFromTXTFile.golden

File renamed without changes.

‎internal/format/testdata/common/header-HeaderFromADOCFile.golden renamed to ‎format/testdata/common/header-HeaderFromADOCFile.golden

File renamed without changes.

‎internal/format/testdata/common/header-HeaderFromMDFile.golden renamed to ‎format/testdata/common/header-HeaderFromMDFile.golden

File renamed without changes.

‎internal/format/testdata/common/header-HeaderFromTFFile.golden renamed to ‎format/testdata/common/header-HeaderFromTFFile.golden

File renamed without changes.

‎internal/format/testdata/common/header-HeaderFromTXTFile.golden renamed to ‎format/testdata/common/header-HeaderFromTXTFile.golden

File renamed without changes.

‎internal/format/testdata/common/sort-NoSort.golden renamed to ‎format/testdata/common/sort-NoSort.golden

File renamed without changes.

‎internal/format/testdata/common/sort-SortByName.golden renamed to ‎format/testdata/common/sort-SortByName.golden

File renamed without changes.

‎internal/format/testdata/common/sort-SortByRequired.golden renamed to ‎format/testdata/common/sort-SortByRequired.golden

File renamed without changes.

‎internal/format/testdata/common/sort-SortByType.golden renamed to ‎format/testdata/common/sort-SortByType.golden

File renamed without changes.

‎internal/format/testdata/json/json-Base.golden renamed to ‎format/testdata/json/json-Base.golden

File renamed without changes.

‎internal/format/testdata/json/json-Empty.golden renamed to ‎format/testdata/json/json-Empty.golden

File renamed without changes.

‎internal/format/testdata/json/json-EscapeCharacters.golden renamed to ‎format/testdata/json/json-EscapeCharacters.golden

File renamed without changes.

‎internal/format/testdata/json/json-HideAll.golden renamed to ‎format/testdata/json/json-HideAll.golden

File renamed without changes.

‎internal/format/testdata/json/json-OnlyDataSources.golden renamed to ‎format/testdata/json/json-OnlyDataSources.golden

File renamed without changes.

‎internal/format/testdata/json/json-OnlyFooter.golden renamed to ‎format/testdata/json/json-OnlyFooter.golden

File renamed without changes.

‎internal/format/testdata/json/json-OnlyHeader.golden renamed to ‎format/testdata/json/json-OnlyHeader.golden

File renamed without changes.

‎internal/format/testdata/json/json-OnlyInputs.golden renamed to ‎format/testdata/json/json-OnlyInputs.golden

File renamed without changes.

‎internal/format/testdata/json/json-OnlyModulecalls.golden renamed to ‎format/testdata/json/json-OnlyModulecalls.golden

File renamed without changes.

‎internal/format/testdata/json/json-OnlyOutputs.golden renamed to ‎format/testdata/json/json-OnlyOutputs.golden

File renamed without changes.

‎internal/format/testdata/json/json-OnlyProviders.golden renamed to ‎format/testdata/json/json-OnlyProviders.golden

File renamed without changes.

‎internal/format/testdata/json/json-OnlyRequirements.golden renamed to ‎format/testdata/json/json-OnlyRequirements.golden

File renamed without changes.

‎internal/format/testdata/json/json-OnlyResources.golden renamed to ‎format/testdata/json/json-OnlyResources.golden

File renamed without changes.

‎internal/format/testdata/json/json-OutputValues.golden renamed to ‎format/testdata/json/json-OutputValues.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-Base.golden renamed to ‎format/testdata/markdown/document-Base.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-Empty.golden renamed to ‎format/testdata/markdown/document-Empty.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-EscapeCharacters.golden renamed to ‎format/testdata/markdown/document-EscapeCharacters.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-HideAll.golden renamed to ‎format/testdata/markdown/document-HideAll.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-HideEmpty.golden renamed to ‎format/testdata/markdown/document-HideEmpty.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-IndentationOfFour.golden renamed to ‎format/testdata/markdown/document-IndentationOfFour.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-OnlyDataSources.golden renamed to ‎format/testdata/markdown/document-OnlyDataSources.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-OnlyFooter.golden renamed to ‎format/testdata/markdown/document-OnlyFooter.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-OnlyHeader.golden renamed to ‎format/testdata/markdown/document-OnlyHeader.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-OnlyInputs.golden renamed to ‎format/testdata/markdown/document-OnlyInputs.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-OnlyModulecalls.golden renamed to ‎format/testdata/markdown/document-OnlyModulecalls.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-OnlyOutputs.golden renamed to ‎format/testdata/markdown/document-OnlyOutputs.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-OnlyProviders.golden renamed to ‎format/testdata/markdown/document-OnlyProviders.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-OnlyRequirements.golden renamed to ‎format/testdata/markdown/document-OnlyRequirements.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-OnlyResources.golden renamed to ‎format/testdata/markdown/document-OnlyResources.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-OutputValues.golden renamed to ‎format/testdata/markdown/document-OutputValues.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-OutputValuesNoSensitivity.golden renamed to ‎format/testdata/markdown/document-OutputValuesNoSensitivity.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-WithAnchor.golden renamed to ‎format/testdata/markdown/document-WithAnchor.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-WithRequired.golden renamed to ‎format/testdata/markdown/document-WithRequired.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-WithoutDefault.golden renamed to ‎format/testdata/markdown/document-WithoutDefault.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-WithoutHTML.golden renamed to ‎format/testdata/markdown/document-WithoutHTML.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-WithoutHTMLWithAnchor.golden renamed to ‎format/testdata/markdown/document-WithoutHTMLWithAnchor.golden

File renamed without changes.

‎internal/format/testdata/markdown/document-WithoutType.golden renamed to ‎format/testdata/markdown/document-WithoutType.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-Base.golden renamed to ‎format/testdata/markdown/table-Base.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-Empty.golden renamed to ‎format/testdata/markdown/table-Empty.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-EscapeCharacters.golden renamed to ‎format/testdata/markdown/table-EscapeCharacters.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-HideAll.golden renamed to ‎format/testdata/markdown/table-HideAll.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-HideEmpty.golden renamed to ‎format/testdata/markdown/table-HideEmpty.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-IndentationOfFour.golden renamed to ‎format/testdata/markdown/table-IndentationOfFour.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-OnlyDataSources.golden renamed to ‎format/testdata/markdown/table-OnlyDataSources.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-OnlyFooter.golden renamed to ‎format/testdata/markdown/table-OnlyFooter.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-OnlyHeader.golden renamed to ‎format/testdata/markdown/table-OnlyHeader.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-OnlyInputs.golden renamed to ‎format/testdata/markdown/table-OnlyInputs.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-OnlyModulecalls.golden renamed to ‎format/testdata/markdown/table-OnlyModulecalls.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-OnlyOutputs.golden renamed to ‎format/testdata/markdown/table-OnlyOutputs.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-OnlyProviders.golden renamed to ‎format/testdata/markdown/table-OnlyProviders.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-OnlyRequirements.golden renamed to ‎format/testdata/markdown/table-OnlyRequirements.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-OnlyResources.golden renamed to ‎format/testdata/markdown/table-OnlyResources.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-OutputValues.golden renamed to ‎format/testdata/markdown/table-OutputValues.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-OutputValuesNoSensitivity.golden renamed to ‎format/testdata/markdown/table-OutputValuesNoSensitivity.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-WithAnchor.golden renamed to ‎format/testdata/markdown/table-WithAnchor.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-WithRequired.golden renamed to ‎format/testdata/markdown/table-WithRequired.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-WithoutDefault.golden renamed to ‎format/testdata/markdown/table-WithoutDefault.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-WithoutHTML.golden renamed to ‎format/testdata/markdown/table-WithoutHTML.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-WithoutHTMLWithAnchor.golden renamed to ‎format/testdata/markdown/table-WithoutHTMLWithAnchor.golden

File renamed without changes.

‎internal/format/testdata/markdown/table-WithoutType.golden renamed to ‎format/testdata/markdown/table-WithoutType.golden

File renamed without changes.

‎internal/format/testdata/pretty/pretty-Base.golden renamed to ‎format/testdata/pretty/pretty-Base.golden

File renamed without changes.

‎internal/format/testdata/pretty/pretty-Empty.golden renamed to ‎format/testdata/pretty/pretty-Empty.golden

File renamed without changes.

‎internal/format/testdata/pretty/pretty-HideAll.golden renamed to ‎format/testdata/pretty/pretty-HideAll.golden

File renamed without changes.

‎internal/format/testdata/pretty/pretty-OnlyDataSources.golden renamed to ‎format/testdata/pretty/pretty-OnlyDataSources.golden

File renamed without changes.

‎internal/format/testdata/pretty/pretty-OnlyFooter.golden renamed to ‎format/testdata/pretty/pretty-OnlyFooter.golden

File renamed without changes.

‎internal/format/testdata/pretty/pretty-OnlyHeader.golden renamed to ‎format/testdata/pretty/pretty-OnlyHeader.golden

File renamed without changes.

‎internal/format/testdata/pretty/pretty-OnlyInputs.golden renamed to ‎format/testdata/pretty/pretty-OnlyInputs.golden

File renamed without changes.

‎internal/format/testdata/pretty/pretty-OnlyModulecalls.golden renamed to ‎format/testdata/pretty/pretty-OnlyModulecalls.golden

File renamed without changes.

‎internal/format/testdata/pretty/pretty-OnlyOutputs.golden renamed to ‎format/testdata/pretty/pretty-OnlyOutputs.golden

File renamed without changes.

‎internal/format/testdata/pretty/pretty-OnlyProviders.golden renamed to ‎format/testdata/pretty/pretty-OnlyProviders.golden

File renamed without changes.

‎internal/format/testdata/pretty/pretty-OnlyRequirements.golden renamed to ‎format/testdata/pretty/pretty-OnlyRequirements.golden

File renamed without changes.

‎internal/format/testdata/pretty/pretty-OnlyResources.golden renamed to ‎format/testdata/pretty/pretty-OnlyResources.golden

File renamed without changes.

‎internal/format/testdata/pretty/pretty-OutputValues.golden renamed to ‎format/testdata/pretty/pretty-OutputValues.golden

File renamed without changes.

‎internal/format/testdata/pretty/pretty-WithColor.golden renamed to ‎format/testdata/pretty/pretty-WithColor.golden

File renamed without changes.

‎internal/format/testdata/tfvars/hcl-Base.golden renamed to ‎format/testdata/tfvars/hcl-Base.golden

File renamed without changes.

‎internal/format/testdata/tfvars/hcl-Empty.golden renamed to ‎format/testdata/tfvars/hcl-Empty.golden

File renamed without changes.

‎internal/format/testdata/tfvars/hcl-EscapeCharacters.golden renamed to ‎format/testdata/tfvars/hcl-EscapeCharacters.golden

File renamed without changes.

‎internal/format/testdata/tfvars/hcl-NoInputs.golden renamed to ‎format/testdata/tfvars/hcl-NoInputs.golden

File renamed without changes.

‎internal/format/testdata/tfvars/hcl-PrintDescription.golden renamed to ‎format/testdata/tfvars/hcl-PrintDescription.golden

File renamed without changes.

‎internal/format/testdata/tfvars/hcl-SortByName.golden renamed to ‎format/testdata/tfvars/hcl-SortByName.golden

File renamed without changes.

‎internal/format/testdata/tfvars/hcl-SortByRequired.golden renamed to ‎format/testdata/tfvars/hcl-SortByRequired.golden

File renamed without changes.

‎internal/format/testdata/tfvars/hcl-SortByType.golden renamed to ‎format/testdata/tfvars/hcl-SortByType.golden

File renamed without changes.

‎internal/format/testdata/tfvars/json-Base.golden renamed to ‎format/testdata/tfvars/json-Base.golden

File renamed without changes.

‎internal/format/testdata/tfvars/json-Empty.golden renamed to ‎format/testdata/tfvars/json-Empty.golden

File renamed without changes.

‎internal/format/testdata/tfvars/json-EscapeCharacters.golden renamed to ‎format/testdata/tfvars/json-EscapeCharacters.golden

File renamed without changes.

‎internal/format/testdata/tfvars/json-NoInputs.golden renamed to ‎format/testdata/tfvars/json-NoInputs.golden

File renamed without changes.

‎internal/format/testdata/tfvars/json-SortByName.golden renamed to ‎format/testdata/tfvars/json-SortByName.golden

File renamed without changes.

‎internal/format/testdata/tfvars/json-SortByRequired.golden renamed to ‎format/testdata/tfvars/json-SortByRequired.golden

File renamed without changes.

‎internal/format/testdata/tfvars/json-SortByType.golden renamed to ‎format/testdata/tfvars/json-SortByType.golden

File renamed without changes.

‎internal/format/testdata/toml/toml-Base.golden renamed to ‎format/testdata/toml/toml-Base.golden

File renamed without changes.

‎internal/format/testdata/toml/toml-Empty.golden renamed to ‎format/testdata/toml/toml-Empty.golden

File renamed without changes.

‎internal/format/testdata/toml/toml-HideAll.golden renamed to ‎format/testdata/toml/toml-HideAll.golden

File renamed without changes.

‎internal/format/testdata/toml/toml-OnlyDataSources.golden renamed to ‎format/testdata/toml/toml-OnlyDataSources.golden

File renamed without changes.

‎internal/format/testdata/toml/toml-OnlyFooter.golden renamed to ‎format/testdata/toml/toml-OnlyFooter.golden

File renamed without changes.

‎internal/format/testdata/toml/toml-OnlyHeader.golden renamed to ‎format/testdata/toml/toml-OnlyHeader.golden

File renamed without changes.

‎internal/format/testdata/toml/toml-OnlyInputs.golden renamed to ‎format/testdata/toml/toml-OnlyInputs.golden

File renamed without changes.

‎internal/format/testdata/toml/toml-OnlyModulecalls.golden renamed to ‎format/testdata/toml/toml-OnlyModulecalls.golden

File renamed without changes.

‎internal/format/testdata/toml/toml-OnlyOutputs.golden renamed to ‎format/testdata/toml/toml-OnlyOutputs.golden

File renamed without changes.

‎internal/format/testdata/toml/toml-OnlyProviders.golden renamed to ‎format/testdata/toml/toml-OnlyProviders.golden

File renamed without changes.

‎internal/format/testdata/toml/toml-OnlyRequirements.golden renamed to ‎format/testdata/toml/toml-OnlyRequirements.golden

File renamed without changes.

‎internal/format/testdata/toml/toml-OnlyResources.golden renamed to ‎format/testdata/toml/toml-OnlyResources.golden

File renamed without changes.

‎internal/format/testdata/toml/toml-OutputValues.golden renamed to ‎format/testdata/toml/toml-OutputValues.golden

File renamed without changes.

‎internal/format/testdata/xml/xml-Base.golden renamed to ‎format/testdata/xml/xml-Base.golden

File renamed without changes.

‎internal/format/testdata/xml/xml-Empty.golden renamed to ‎format/testdata/xml/xml-Empty.golden

File renamed without changes.

‎internal/format/testdata/xml/xml-HideAll.golden renamed to ‎format/testdata/xml/xml-HideAll.golden

File renamed without changes.

‎internal/format/testdata/xml/xml-OnlyDataSources.golden renamed to ‎format/testdata/xml/xml-OnlyDataSources.golden

File renamed without changes.

‎internal/format/testdata/xml/xml-OnlyFooter.golden renamed to ‎format/testdata/xml/xml-OnlyFooter.golden

File renamed without changes.

‎internal/format/testdata/xml/xml-OnlyHeader.golden renamed to ‎format/testdata/xml/xml-OnlyHeader.golden

File renamed without changes.

‎internal/format/testdata/xml/xml-OnlyInputs.golden renamed to ‎format/testdata/xml/xml-OnlyInputs.golden

File renamed without changes.

‎internal/format/testdata/xml/xml-OnlyModulecalls.golden renamed to ‎format/testdata/xml/xml-OnlyModulecalls.golden

File renamed without changes.

‎internal/format/testdata/xml/xml-OnlyOutputs.golden renamed to ‎format/testdata/xml/xml-OnlyOutputs.golden

File renamed without changes.

‎internal/format/testdata/xml/xml-OnlyProviders.golden renamed to ‎format/testdata/xml/xml-OnlyProviders.golden

File renamed without changes.

‎internal/format/testdata/xml/xml-OnlyRequirements.golden renamed to ‎format/testdata/xml/xml-OnlyRequirements.golden

File renamed without changes.

‎internal/format/testdata/xml/xml-OnlyResources.golden renamed to ‎format/testdata/xml/xml-OnlyResources.golden

File renamed without changes.

‎internal/format/testdata/xml/xml-OutputValues.golden renamed to ‎format/testdata/xml/xml-OutputValues.golden

File renamed without changes.

‎internal/format/testdata/yaml/yaml-Base.golden renamed to ‎format/testdata/yaml/yaml-Base.golden

File renamed without changes.

‎internal/format/testdata/yaml/yaml-Empty.golden renamed to ‎format/testdata/yaml/yaml-Empty.golden

File renamed without changes.

‎internal/format/testdata/yaml/yaml-HideAll.golden renamed to ‎format/testdata/yaml/yaml-HideAll.golden

File renamed without changes.

‎internal/format/testdata/yaml/yaml-OnlyDataSources.golden renamed to ‎format/testdata/yaml/yaml-OnlyDataSources.golden

File renamed without changes.

‎internal/format/testdata/yaml/yaml-OnlyFooter.golden renamed to ‎format/testdata/yaml/yaml-OnlyFooter.golden

File renamed without changes.

‎internal/format/testdata/yaml/yaml-OnlyHeader.golden renamed to ‎format/testdata/yaml/yaml-OnlyHeader.golden

File renamed without changes.

‎internal/format/testdata/yaml/yaml-OnlyInputs.golden renamed to ‎format/testdata/yaml/yaml-OnlyInputs.golden

File renamed without changes.

‎internal/format/testdata/yaml/yaml-OnlyModulecalls.golden renamed to ‎format/testdata/yaml/yaml-OnlyModulecalls.golden

File renamed without changes.

‎internal/format/testdata/yaml/yaml-OnlyOutputs.golden renamed to ‎format/testdata/yaml/yaml-OnlyOutputs.golden

File renamed without changes.

‎internal/format/testdata/yaml/yaml-OnlyProviders.golden renamed to ‎format/testdata/yaml/yaml-OnlyProviders.golden

File renamed without changes.

‎internal/format/testdata/yaml/yaml-OnlyRequirements.golden renamed to ‎format/testdata/yaml/yaml-OnlyRequirements.golden

File renamed without changes.

‎internal/format/testdata/yaml/yaml-OnlyResources.golden renamed to ‎format/testdata/yaml/yaml-OnlyResources.golden

File renamed without changes.

‎internal/format/testdata/yaml/yaml-OutputValues.golden renamed to ‎format/testdata/yaml/yaml-OutputValues.golden

File renamed without changes.

‎internal/format/tfvars_hcl.go renamed to ‎format/tfvars_hcl.go

File renamed without changes.

‎internal/format/tfvars_hcl_test.go renamed to ‎format/tfvars_hcl_test.go

File renamed without changes.

‎internal/format/tfvars_json.go renamed to ‎format/tfvars_json.go

File renamed without changes.

‎internal/format/tfvars_json_test.go renamed to ‎format/tfvars_json_test.go

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
/*
22
Copyright 2021 The terraform-docs Authors.
3-
43
Licensed under the MIT license (the "License"); you may not
54
use this file except in compliance with the License.
6-
75
You may obtain a copy of the License at the LICENSE file in
86
the root directory of this source tree.
97
*/

‎internal/format/toml.go renamed to ‎format/toml.go

File renamed without changes.

‎internal/format/toml_test.go renamed to ‎format/toml_test.go

File renamed without changes.

‎internal/format/util.go renamed to ‎format/util.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,24 +44,24 @@ func sanitize(markdown string) string {
4444
return result
4545
}
4646

47-
// printFencedCodeBlock prints codes in fences, it automatically detects if
47+
// PrintFencedCodeBlock prints codes in fences, it automatically detects if
4848
// the input 'code' contains '\n' it will use multi line fence, otherwise it
4949
// wraps the 'code' inside single-tick block.
5050
// If the fenced is multi-line it also appens an extra '\n` at the end and
5151
// returns true accordingly, otherwise returns false for non-carriage return.
52-
func printFencedCodeBlock(code string, language string) (string, bool) {
52+
func PrintFencedCodeBlock(code string, language string) (string, bool) {
5353
if strings.Contains(code, "\n") {
5454
return fmt.Sprintf("\n\n```%s\n%s\n```\n", language, code), true
5555
}
5656
return fmt.Sprintf("`%s`", code), false
5757
}
5858

59-
// printFencedAsciidocCodeBlock prints codes in fences, it automatically detects if
59+
// PrintFencedAsciidocCodeBlock prints codes in fences, it automatically detects if
6060
// the input 'code' contains '\n' it will use multi line fence, otherwise it
6161
// wraps the 'code' inside single-tick block.
6262
// If the fenced is multi-line it also appens an extra '\n` at the end and
6363
// returns true accordingly, otherwise returns false for non-carriage return.
64-
func printFencedAsciidocCodeBlock(code string, language string) (string, bool) {
64+
func PrintFencedAsciidocCodeBlock(code string, language string) (string, bool) {
6565
if strings.Contains(code, "\n") {
6666
return fmt.Sprintf("\n[source,%s]\n----\n%s\n----\n", language, code), true
6767
}

‎internal/format/util_test.go renamed to ‎format/util_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ func TestFenceCodeBlock(t *testing.T) {
122122
for _, tt := range tests {
123123
t.Run(tt.name, func(t *testing.T) {
124124
assert := assert.New(t)
125-
actual, extraline := printFencedCodeBlock(tt.code, tt.language)
125+
actual, extraline := PrintFencedCodeBlock(tt.code, tt.language)
126126

127127
assert.Equal(tt.expected, actual)
128128
assert.Equal(tt.extraline, extraline)

‎internal/format/xml.go renamed to ‎format/xml.go

File renamed without changes.

‎internal/format/xml_test.go renamed to ‎format/xml_test.go

File renamed without changes.

‎internal/format/yaml.go renamed to ‎format/yaml.go

File renamed without changes.

‎internal/format/yaml_test.go renamed to ‎format/yaml_test.go

File renamed without changes.

‎internal/cli/run.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import (
2323
"github.com/spf13/viper"
2424

2525
pluginsdk "github.com/terraform-docs/plugin-sdk/plugin"
26-
"github.com/terraform-docs/terraform-docs/internal/format"
26+
"github.com/terraform-docs/terraform-docs/format"
2727
"github.com/terraform-docs/terraform-docs/internal/plugin"
2828
"github.com/terraform-docs/terraform-docs/internal/version"
2929
"github.com/terraform-docs/terraform-docs/terraform"

‎scripts/docs/generate.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import (
2323
"github.com/spf13/cobra"
2424

2525
"github.com/terraform-docs/terraform-docs/cmd"
26-
"github.com/terraform-docs/terraform-docs/internal/format"
26+
"github.com/terraform-docs/terraform-docs/format"
2727
"github.com/terraform-docs/terraform-docs/internal/print"
2828
"github.com/terraform-docs/terraform-docs/terraform"
2929
)

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy