Merge pull request #62 from losisin/feature/indent-cli-option

add indent cli option

.github/workflows/ci.yaml

@@ -31,6 +31,8 @@ jobs:
         with:
           args: --timeout 5m0s
           skip-cache: true
+      - name: Check code
+        run: make check
       - name: Run tests
         run: make test-all
       - name: Install plugin

.gitignore

@@ -7,6 +7,7 @@
 
 # Test binary, built with `go test -c`
 *.test
+schema
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/losisin/helm-values-schema-json
-    rev: v1.2.4
+    rev: v1.3.0
     hooks:
       - id: helm-schema
         args:
@@ -10,3 +10,5 @@ repos:
           - --output=values.schema.json
           # Draft version (4, 6, 7, 2019, or 2020) (default 2020)
           - --draft=2020
+          # Indentation spaces (even number)
+          - --indent=4

README.md

@@ -58,7 +58,7 @@ First [install pre-commit](https://pre-commit.com/#install) and then create or u
 ```yaml
 repos:
   - repo: https://github.com/losisin/helm-values-schema-json
-    rev: v1.2.4
+    rev: v1.3.0
     hooks:
       - id: helm-schema
         args: ["-input", "values.yaml"]
@@ -92,6 +92,8 @@ $ helm schema -help
 usage: helm schema [-input STR] [-draft INT] [-output STR]
   -draft int
     	Draft version (4, 6, 7, 2019, or 2020) (default 2020)
+  -indent int
+    	Indentation spaces (even number) (default 4)
   -input value
     	Multiple yamlFiles as inputs (comma-separated)
   -output string

pkg/cmd.go

@@ -16,6 +16,7 @@ func ParseFlags(progname string, args []string) (config *Config, output string,
 	flags.Var(&conf.input, "input", "Multiple yaml files as inputs (comma-separated)")
 	flags.StringVar(&conf.outputPath, "output", "values.schema.json", "Output file path")
 	flags.IntVar(&conf.draft, "draft", 2020, "Draft version (4, 6, 7, 2019, or 2020)")
+	flags.IntVar(&conf.indent, "indent", 4, "Indentation spaces (even number)")
 
 	err = flags.Parse(args)
 	if err != nil {

pkg/cmd_test.go

@@ -13,13 +13,16 @@ func TestParseFlagsPass(t *testing.T) {
 		conf Config
 	}{
 		{[]string{"-input", "values.yaml"},
-			Config{input: multiStringFlag{"values.yaml"}, outputPath: "values.schema.json", draft: 2020, args: []string{}}},
+			Config{input: multiStringFlag{"values.yaml"}, outputPath: "values.schema.json", draft: 2020, indent: 4, args: []string{}}},
 
-		{[]string{"-input", "values1.yaml values2.yaml"},
-			Config{input: multiStringFlag{"values1.yaml values2.yaml"}, outputPath: "values.schema.json", draft: 2020, args: []string{}}},
+		{[]string{"-input", "values1.yaml values2.yaml", "-indent", "2"},
+			Config{input: multiStringFlag{"values1.yaml values2.yaml"}, outputPath: "values.schema.json", draft: 2020, indent: 2, args: []string{}}},
+
+		{[]string{"-input", "values.yaml", "-output", "my.schema.json", "-draft", "2019", "-indent", "2"},
+			Config{input: multiStringFlag{"values.yaml"}, outputPath: "my.schema.json", draft: 2019, indent: 2, args: []string{}}},
 
 		{[]string{"-input", "values.yaml", "-output", "my.schema.json", "-draft", "2019"},
-			Config{input: multiStringFlag{"values.yaml"}, outputPath: "my.schema.json", draft: 2019, args: []string{}}},
+			Config{input: multiStringFlag{"values.yaml"}, outputPath: "my.schema.json", draft: 2019, indent: 4, args: []string{}}},
 	}
 
 	for _, tt := range tests {

pkg/generator.go

@@ -5,6 +5,7 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"strings"
 
 	"gopkg.in/yaml.v3"
 )
@@ -17,6 +18,15 @@ func GenerateJsonSchema(config *Config) error {
 		return err
 	}
 
+	// Determine the indentation string based on the number of spaces
+	if config.indent <= 0 {
+		return errors.New("indentation must be a positive number")
+	}
+	if config.indent%2 != 0 {
+		return errors.New("indentation must be an even number")
+	}
+	indentString := strings.Repeat(" ", config.indent)
+
 	// Initialize a Schema to hold the merged YAML data
 	mergedSchema := &Schema{}
 
@@ -70,10 +80,11 @@ func GenerateJsonSchema(config *Config) error {
 	jsonSchemaMap["$schema"] = schemaURL // Include the schema draft version
 
 	// If validation is successful, marshal the schema and save to the file
-	jsonBytes, err := json.MarshalIndent(jsonSchemaMap, "", "    ")
+	jsonBytes, err := json.MarshalIndent(jsonSchemaMap, "", indentString)
 	if err != nil {
 		return err
 	}
+	jsonBytes = append(jsonBytes, '\n')
 
 	// Write the JSON schema to the output file
 	outputPath := config.outputPath

pkg/generator_test.go

@@ -17,6 +17,7 @@ func TestGenerateJsonSchema(t *testing.T) {
 		},
 		outputPath: "../testdata/output.json",
 		draft:      2020,
+		indent:     4,
 	}
 
 	err := GenerateJsonSchema(config)
@@ -55,11 +56,32 @@ func TestGenerateJsonSchema_Errors(t *testing.T) {
 			},
 			expectedErr: errors.New("invalid draft version"),
 		},
+		{
+			name: "Negative indentation number",
+			config: &Config{
+				input:      []string{"../testdata/basic.yaml"},
+				draft:      2020,
+				outputPath: "testdata/failure/output_readonly_schema.json",
+				indent:     0,
+			},
+			expectedErr: errors.New("indentation must be a positive number"),
+		},
+		{
+			name: "Odd indentation number",
+			config: &Config{
+				input:      []string{"../testdata/basic.yaml"},
+				draft:      2020,
+				outputPath: "testdata/failure/output_readonly_schema.json",
+				indent:     1,
+			},
+			expectedErr: errors.New("indentation must be an even number"),
+		},
 		{
 			name: "Missing file",
 			config: &Config{
-				input: []string{"missing.yaml"},
-				draft: 2020,
+				input:  []string{"missing.yaml"},
+				draft:  2020,
+				indent: 4,
 			},
 			expectedErr: errors.New("error reading YAML file(s)"),
 		},
@@ -69,6 +91,7 @@ func TestGenerateJsonSchema_Errors(t *testing.T) {
 				input:      []string{"../testdata/fail"},
 				outputPath: "testdata/failure/output_readonly_schema.json",
 				draft:      2020,
+				indent:     4,
 			},
 			expectedErr: errors.New("error unmarshaling YAML"),
 		},
@@ -78,6 +101,7 @@ func TestGenerateJsonSchema_Errors(t *testing.T) {
 				input:      []string{"../testdata/basic.yaml"},
 				outputPath: "testdata/failure/output_readonly_schema.json",
 				draft:      2020,
+				indent:     4,
 			},
 			expectedErr: errors.New("error writing schema to file"),
 		},

pkg/utils.go

@@ -7,6 +7,7 @@ type Config struct {
 	input      multiStringFlag
 	outputPath string
 	draft      int
+	indent     int
 
 	args []string
 }

plugin.yaml

@@ -1,5 +1,5 @@
 name: "schema"
-version: "1.2.4"
+version: "1.3.0"
 usage: "generate values.schema.json from values yaml"
 description: "Helm plugin for generating values.schema.json from multiple values files."
 ignoreFlags: false

testdata/anchors.schema.json

@@ -21,4 +21,4 @@
         }
     },
     "type": "object"
-}
+}

testdata/basic.schema.json

@@ -58,4 +58,4 @@
         }
     },
     "type": "object"
-}
+}

testdata/full.schema.json

@@ -168,4 +168,4 @@
         "nameOverride"
     ],
     "type": "object"
-}
+}

testdata/meta.schema.json

@@ -51,4 +51,4 @@
         }
     },
     "type": "object"
-}
+}