feat(json editor): add a format json button and simple validation errors

foss42 · Apr 3, 2024 · 17ca893 · 17ca893
1 parent 404fccd
commit 17ca893
Showing 1 changed file with 133 additions and 40 deletions.
diff --git a/lib/widgets/editor_json.dart b/lib/widgets/editor_json.dart
@@ -2,6 +2,7 @@ import 'package:code_text_field/code_text_field.dart';
 import 'package:flutter/material.dart';
 import 'package:highlight/languages/json.dart';
 import 'package:apidash/consts.dart';
+import 'dart:convert' as convert;
 
 class JsonTextFieldEditor extends StatefulWidget {
   const JsonTextFieldEditor({
@@ -19,10 +20,10 @@ class JsonTextFieldEditor extends StatefulWidget {
 }
 
 class _JsonTextFieldEditorState extends State<JsonTextFieldEditor> {
-  final TextEditingController controller = TextEditingController();
   late final FocusNode editorFocusNode;
+  late bool _focused = false;
   CodeController? _codeController;
-  bool _focused = false;
+  late String? _jsonError;
 
   @override
   void initState() {
@@ -38,6 +39,13 @@ class _JsonTextFieldEditorState extends State<JsonTextFieldEditor> {
         _focused = editorFocusNode.hasFocus;
       });
     });
+
+    // iniialize errors
+    if (_codeController!.text.isEmpty) {
+      _jsonError = null;
+    } else {
+      _jsonError = getJsonParsingError(_codeController!.text);
+    }
   }
 
   @override
@@ -47,48 +55,133 @@ class _JsonTextFieldEditorState extends State<JsonTextFieldEditor> {
     super.dispose();
   }
 
+  void _setJsonError(String? error) => setState(() => _jsonError = error);
   @override
   Widget build(BuildContext context) {
-    if (widget.initialValue != null) {
-      controller.text = widget.initialValue!;
-    }
-    return CodeTheme(
-      data: CodeThemeData(
-          styles: Theme.of(context).brightness == Brightness.dark
-              ? kDarkCodeTheme
-              : kLightCodeTheme),
-      child: CodeField(
-        key: Key(widget.fieldKey),
-        controller: _codeController!,
-        focusNode: editorFocusNode,
-        keyboardType: TextInputType.multiline,
-        expands: true,
-        maxLines: null,
-        textStyle: kCodeStyle,
-        lineNumbers: false,
-        hintText: "Enter content (json)",
-        hintStyle: TextStyle(
-          color: Theme.of(context).colorScheme.outline.withOpacity(
-                kHintOpacity,
+    return Column(
+      children: [
+        Expanded(
+            child: CodeTheme(
+          data: CodeThemeData(
+              styles: Theme.of(context).brightness == Brightness.dark
+                  ? kDarkCodeTheme
+                  : kLightCodeTheme),
+          child: CodeField(
+            key: Key(widget.fieldKey),
+            controller: _codeController!,
+            focusNode: editorFocusNode,
+            keyboardType: TextInputType.multiline,
+            expands: true,
+            maxLines: null,
+            textStyle: kCodeStyle,
+            lineNumbers: false,
+            hintText: "Enter content (json)",
+            hintStyle: TextStyle(
+              color: Theme.of(context).colorScheme.outline.withOpacity(
+                    kHintOpacity,
+                  ),
+            ),
+            onChanged: (value) {
+              widget.onChanged?.call(value);
+              validateJson(value);
+            },
+            decoration: BoxDecoration(
+              color: Color.alphaBlend(
+                  (Theme.of(context).brightness == Brightness.dark
+                          ? Theme.of(context).colorScheme.onPrimaryContainer
+                          : Theme.of(context).colorScheme.primaryContainer)
+                      .withOpacity(kForegroundOpacity),
+                  Theme.of(context).colorScheme.surface),
+              border: Border.fromBorderSide(BorderSide(
+                  color: _focused
+                      ? Theme.of(context).colorScheme.primary.withOpacity(
+                            kHintOpacity,
+                          )
+                      : Theme.of(context).colorScheme.surfaceVariant)),
+              borderRadius: _jsonError == null
+                  ? kBorderRadius8
+                  : const BorderRadius.only(
+                      topLeft: Radius.circular(8),
+                      topRight: Radius.circular(8)),
+            ),
+          ),
+        )),
+        _jsonError == null
+            ? const SizedBox.shrink()
+            : Container(
+                padding: kP8,
+                decoration: BoxDecoration(
+                    color: Theme.of(context).colorScheme.error,
+                    borderRadius: const BorderRadius.only(
+                        bottomLeft: Radius.circular(8),
+                        bottomRight: Radius.circular(8))),
+                child: Center(
+                  child: Text(
+                    _jsonError ?? '',
+                    style: TextStyle(
+                      color: Theme.of(context).colorScheme.onError,
+                      fontWeight: FontWeight.bold,
+                    ),
+                  ),
+                ),
               ),
+        Padding(
+          padding: kP8,
+          child: ElevatedButton(
+            onPressed: _jsonError != null
+                ? null
+                : () {
+                    if (_codeController!.text.isNotEmpty) {
+                      formatJson();
+                    }
+                  },
+            child: const Text(
+              'Format JSON',
+              style: kTextStyleButton,
+            ),
+          ),
         ),
-        onChanged: widget.onChanged,
-        decoration: BoxDecoration(
-          color: Color.alphaBlend(
-              (Theme.of(context).brightness == Brightness.dark
-                      ? Theme.of(context).colorScheme.onPrimaryContainer
-                      : Theme.of(context).colorScheme.primaryContainer)
-                  .withOpacity(kForegroundOpacity),
-              Theme.of(context).colorScheme.surface),
-          border: Border.fromBorderSide(BorderSide(
-              color: _focused
-                  ? Theme.of(context).colorScheme.primary.withOpacity(
-                        kHintOpacity,
-                      )
-                  : Theme.of(context).colorScheme.surfaceVariant)),
-          borderRadius: kBorderRadius8,
-        ),
-      ),
+      ],
     );
   }
+
+  bool isValidJson(String jsonString) {
+    if (jsonString.isEmpty) return false;
+    try {
+      convert.json.decode(jsonString);
+      return true;
+    } catch (_) {
+      return false;
+    }
+  }
+
+  String? getJsonParsingError(String? jsonString) {
+    if (jsonString == null) return null;
+
+    try {
+      convert.json.decode(jsonString);
+      return null;
+    } on FormatException catch (e) {
+      return e.toString().replaceAll("FormatException: ", "");
+    }
+  }
+
+  void validateJson(String jsonString) {
+    if (jsonString.isEmpty) {
+      _setJsonError(null);
+      return;
+    }
+    if (isValidJson(jsonString)) {
+      _setJsonError(null);
+      return;
+    }
+    _setJsonError(getJsonParsingError(jsonString));
+  }
+
+  void formatJson() {
+    if (!isValidJson(_codeController!.text)) return;
+    final oldText = _codeController!.text;
+    var jsonObject = convert.json.decode(oldText);
+    _codeController!.text = kEncoder.convert(jsonObject);
+  }
 }