Update config (#599)

* Update default config * Add check_default_config test * Fix doc * Bold italic
Riey · Nov 25, 2022 · 85f1517 · 85f1517
1 parent 2d19432
commit 85f1517
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 36 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -34,6 +34,11 @@
         "random": "cpp",
         "optional": "cpp"
     },
+    "yaml.customTags": [
+        "!Mode scalar",
+        "!Toggle sequence",
+        "!Switch scalar",
+    ],
     "C_Cpp.errorSquiggles": "Disabled",
     "cmake.sourceDirectory": "${workspaceFolder}/src",
     "rust-analyzer.procMacro.enable": true,

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -6,6 +6,8 @@
 
 ### Improve
 
+* Update default config file
+
 ## 3.0.0
 
 ### Breaking
@@ -15,6 +17,7 @@
 * Builtin sebeolsik `3-90` and `3-91` changed with all jungseong to uncomposable except for `ㅑ`, `ㅕ`,`ㅡ`, `ㅜ(9)`, `ㅗ(/)` [#542](https://github.com/Riey/kime/issues/542)
 * Respect NUMLOCK state [#591](https://github.com/Riey/kime/issues/591)
 * Remove support GTK2
+* ***Config file format has changed*** see [wiki](https://github.com/Riey/kime/wiki/3.0.0-Migration-guide) for more information
 
 ### Improve
 

diff --git a/res/default_config.yaml b/res/default_config.yaml
@@ -1,66 +1,56 @@
----
 daemon:
   modules:
-    - Xim
-    - Wayland
-    - Indicator
+  - Xim
+  - Wayland
+  - Indicator
 indicator:
   icon_color: Black
 log:
   global_level: DEBUG
 engine:
+  translation_layer: null
   default_category: Latin
   global_category_state: false
   global_hotkeys:
     M-C-Backslash:
-      behavior:
-        Mode: Math
+      behavior: !Mode Math
       result: ConsumeIfProcessed
     Super-Space:
-      behavior:
-        Toggle:
-          - Hangul
-          - Latin
+      behavior: !Toggle
+      - Hangul
+      - Latin
       result: Consume
     M-C-E:
-      behavior:
-        Mode: Emoji
+      behavior: !Mode Emoji
       result: ConsumeIfProcessed
     Esc:
-      behavior:
-        Switch: Latin
+      behavior: !Switch Latin
       result: Bypass
     Muhenkan:
-      behavior:
-        Toggle:
-          - Hangul
-          - Latin
+      behavior: !Toggle
+      - Hangul
+      - Latin
       result: Consume
     AltR:
-      behavior:
-        Toggle:
-          - Hangul
-          - Latin
+      behavior: !Toggle
+      - Hangul
+      - Latin
       result: Consume
     Hangul:
-      behavior:
-        Toggle:
-          - Hangul
-          - Latin
+      behavior: !Toggle
+      - Hangul
+      - Latin
       result: Consume
   category_hotkeys:
     Hangul:
       ControlR:
-        behavior:
-          Mode: Hanja
+        behavior: !Mode Hanja
         result: Consume
       HangulHanja:
-        behavior:
-          Mode: Hanja
+        behavior: !Mode Hanja
         result: Consume
       F9:
-        behavior:
-          Mode: Hanja
+        behavior: !Mode Hanja
         result: ConsumeIfProcessed
   mode_hotkeys:
     Math:
@@ -84,9 +74,10 @@ engine:
       Tab:
         behavior: Commit
         result: ConsumeIfProcessed
+  candidate_font: D2Coding
   xim_preedit_font:
-    - D2Coding
-    - 15.0
+  - D2Coding
+  - 15.0
   latin:
     layout: Qwerty
     preferred_direct: true
@@ -96,6 +87,6 @@ engine:
     preedit_johab: Needed
     addons:
       all:
-        - ComposeChoseongSsang
+      - ComposeChoseongSsang
       dubeolsik:
-        - TreatJongseongAsChoseong
+      - TreatJongseongAsChoseong
diff --git a/src/engine/core/tests/config.rs b/src/engine/core/tests/config.rs
@@ -0,0 +1,7 @@
+#[test]
+fn check_default_config() {
+    assert_eq!(
+        serde_yaml::to_string(&kime_engine_core::RawConfig::default()).unwrap(),
+        include_str!("../../../../res/default_config.yaml")
+    );
+}