summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoe2022-03-09 18:34:12 +0000
committerGitHub2022-03-09 18:34:12 +0000
commit8d7a25b4d49ef5cd7f5d85585d60e52bdc2bc0c5 (patch)
treebcac808dbb22a0f7931382190a809524ec28bfe6
parent3f603b27f1251cb77462d350d3f8277546b765de (diff)
Add --edit-config flag to directly open config.toml (#1771)
Co-authored-by: Gokul Soumya <gokulps15@gmail.com>
-rw-r--r--book/src/configuration.md2
-rw-r--r--helix-term/src/application.rs3
-rw-r--r--helix-term/src/args.rs2
-rw-r--r--helix-term/src/main.rs1
4 files changed, 8 insertions, 0 deletions
diff --git a/book/src/configuration.md b/book/src/configuration.md
index 023f7dc1..2e4cab8a 100644
--- a/book/src/configuration.md
+++ b/book/src/configuration.md
@@ -5,6 +5,8 @@ To override global configuration parameters, create a `config.toml` file located
* Linux and Mac: `~/.config/helix/config.toml`
* Windows: `%AppData%\helix\config.toml`
+> Note: You may use `hx --edit-config` to create and edit the `config.toml` file.
+
Example config:
```toml
diff --git a/helix-term/src/application.rs b/helix-term/src/application.rs
index 3eee3396..e885bc49 100644
--- a/helix-term/src/application.rs
+++ b/helix-term/src/application.rs
@@ -113,6 +113,9 @@ impl Application {
editor.open(path, Action::VerticalSplit)?;
// Unset path to prevent accidentally saving to the original tutor file.
doc_mut!(editor).set_path(None)?;
+ } else if args.edit_config {
+ let path = conf_dir.join("config.toml");
+ editor.open(path, Action::VerticalSplit)?;
} else if !args.files.is_empty() {
let first = &args.files[0].0; // we know it's not empty
if first.is_dir() {
diff --git a/helix-term/src/args.rs b/helix-term/src/args.rs
index 4f386aea..11bad08c 100644
--- a/helix-term/src/args.rs
+++ b/helix-term/src/args.rs
@@ -11,6 +11,7 @@ pub struct Args {
pub load_tutor: bool,
pub verbosity: u64,
pub files: Vec<(PathBuf, Position)>,
+ pub edit_config: bool,
}
impl Args {
@@ -26,6 +27,7 @@ impl Args {
"--version" => args.display_version = true,
"--help" => args.display_help = true,
"--tutor" => args.load_tutor = true,
+ "--edit-config" => args.edit_config = true,
"--health" => {
args.health = true;
args.health_arg = argv.next_if(|opt| !opt.starts_with('-'));
diff --git a/helix-term/src/main.rs b/helix-term/src/main.rs
index cde26c2e..607f1f59 100644
--- a/helix-term/src/main.rs
+++ b/helix-term/src/main.rs
@@ -60,6 +60,7 @@ ARGS:
FLAGS:
-h, --help Prints help information
+ --edit-config Opens the helix config file
--tutor Loads the tutorial
--health [LANG] Checks for potential errors in editor setup
If given, checks for config errors in language LANG