Added better comments and improved book entry. Renamed several functions and calls to be more clear.

Author: Lindenk

book/src/remapping.md

@@ -53,6 +53,20 @@ Individual keys can be disabled by binding them to the `no_op` command.
 
 To remove the default bindings for all modes defined by the user, `unbind-default-keys = true` can be added to the top level configuration.
 
+```toml
+unbind-default-keys = true
+
+# Only these normal mode bindings will be used
+[keys.normal]
+n = "normal_mode"
+t = "goto_definition"
+
+# No select mode bindings will be used
+[keys.select]
+
+# All default insert mode bindings will be used because new bindings weren't defined
+```
+
 Commands can be found at [Keymap](https://docs.helix-editor.com/keymap.html) Commands.
 
 > Commands can also be found in the source code at [`helix-term/src/commands.rs`](https://github.com/helix-editor/helix/blob/master/helix-term/src/commands.rs) at the invocation of `static_commands!` macro and the `TypableCommandList`.

helix-term/src/application.rs

@@ -89,10 +89,6 @@ impl Application {
         use helix_view::editor::Action;
 
         let config_dir = helix_loader::config_dir();
-        if !config_dir.exists() {
-            std::fs::create_dir_all(&config_dir).ok();
-        }
-
         let theme_loader = std::sync::Arc::new(theme::Loader::new(
             &config_dir,
             &helix_loader::runtime_dir(),

helix-term/src/config.rs

@@ -36,15 +36,18 @@ impl Display for ConfigLoadError {
 
 impl Config {
     // avoids confusion between a default rust struct and default helix keys
+    /// Creates a new empty config
     #[allow(clippy::new_without_default)]
     pub fn new() -> Self {
         Config {
             theme: None,
             unbind_default_keys: false,
-            keys: Default::default(),
-            editor: Default::default(),
+            keys: HashMap::new(),
+            editor: helix_view::editor::Config::default(),
         }
     }
+
+    /// Creates a new config with the default keybindings
     pub fn with_default_keys() -> Self {
         Config {
             theme: None,
@@ -72,8 +75,8 @@ impl Config {
     }
 
     /// Replace our keys for a mode with other's keys for that mode.
-    /// Retains existing keys if other does not redefine them
-    pub fn replace_keys(mut self, other: Self) -> Self {
+    /// Retains existing modes if other does not redefine them
+    pub fn replace_key_modes(mut self, other: Self) -> Self {
         for (mode, keys) in other.keys.into_iter() {
             self.keys.insert(mode, keys);
         }
@@ -82,16 +85,16 @@ impl Config {
     }
 
     /// Take other's keys and replace our modes into them
-    pub fn replace_into_keys(mut self, mut other: Self) -> Self {
+    pub fn replace_into_key_modes(mut self, mut other: Self) -> Self {
         std::mem::swap(&mut self.keys, &mut other.keys);
-        self.replace_keys(other)
+        self.replace_key_modes(other)
     }
 
     pub fn load(config_path: PathBuf) -> Result<Config, ConfigLoadError> {
         match std::fs::read_to_string(config_path) {
             Ok(config) => match toml::from_str::<Config>(&config) {
                 Ok(config) if config.unbind_default_keys => {
-                    Ok(config.replace_into_keys(Config::with_default_keys()))
+                    Ok(config.replace_into_key_modes(Config::with_default_keys()))
                 }
                 Ok(config) => Ok(config.merge_into_keys(Config::with_default_keys())),
 

helix-term/src/keymap.rs

@@ -475,7 +475,7 @@ mod tests {
 
         let mut replaced_config = config
             .clone()
-            .replace_into_keys(Config::with_default_keys());
+            .replace_into_key_modes(Config::with_default_keys());
         assert_ne!(config, replaced_config);
 
         let mut keymap = Keymaps::new(Box::new(Constant(replaced_config.keys.clone())));