feat(qa): add json examples validation (#3186)

Author: Codelax

internal/qa/example.go

@@ -0,0 +1,39 @@
+package qa
+
+import (
+	"encoding/json"
+	"fmt"
+
+	"github.com/scaleway/scaleway-cli/v2/internal/core"
+)
+
+type CommandInvalidJSONExampleError struct {
+	Command *core.Command
+}
+
+func (err CommandInvalidJSONExampleError) Error() string {
+	return fmt.Sprintf("command has invalid json examples '%s'",
+		err.Command.GetCommandLine("scw"),
+	)
+}
+
+// testArgSpecInvalidError tests that all argspecs have a corresponding in their command's argstype.
+func testCommandInvalidJSONExampleError(commands *core.Commands) []error {
+	errors := []error(nil)
+
+	for _, command := range commands.GetAll() {
+		for _, example := range command.Examples {
+			if example.ArgsJSON != "" {
+				out := map[string]any{}
+				err := json.Unmarshal([]byte(example.ArgsJSON), &out)
+				if err != nil {
+					errors = append(errors, &CommandInvalidJSONExampleError{
+						Command: command,
+					})
+				}
+			}
+		}
+	}
+
+	return errors
+}

internal/qa/qa.go

@@ -21,6 +21,7 @@ func LintCommands(commands *core.Commands) []error {
 	errors = append(errors, testAtLeastOneExampleIsPresentError(commands)...)
 	errors = append(errors, testArgSpecInvalidError(commands)...)
 	errors = append(errors, testArgSpecMissingError(commands)...)
+	errors = append(errors, testCommandInvalidJSONExampleError(commands)...)
 
 	errors = filterIgnore(errors)