Skip to content

Commit

Permalink
chore(evil): clarifications (#41)
Browse files Browse the repository at this point in the history
* doc(evil): remove the mention of a different default theme

* refactor(evil): improve logging to avoid misconceptions

* doc(evil): we don't rebase that often anymore

* doc(evil): document the `editor.evil` option
  • Loading branch information
usagi-flow authored Aug 7, 2024
1 parent 0e5534b commit a2c8565
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,17 @@ These are the current differences compared to the upstream project:
- Basic Vim modeline support ([#3](https://github.com/usagi-flow/evil-helix/pull/3))
- Adjusted defaults ([511060a](https://github.com/usagi-flow/evil-helix/commit/511060abcfcbe9377ec50e8a0ecaf4c0660776bb)):
- The Helix "SEL" mode is called "VIS"
- The default theme is `catppuccin_macchiato`
- Smart tab is disabled by default
- If `color_modes` is enabled, color the file type in the statusline as well ([5503542](https://github.com/usagi-flow/evil-helix/commit/5503542c0314936ea91464f2944666ed42fea86c))
- Minimalistic window separator ([dd990ca](https://github.com/usagi-flow/evil-helix/commit/dd990cad1cb92a024321aca19728c68cb066dd09))

Moreover, evil-helix introduces the `editor.evil` option, which is `true` by default. It can be set to false to completely deactivate evil-helix behavior without having to use a different build:

```toml
[editor]
evil = true # Default; set this to `false` to disable evil-helix behavior
```

## Project philosophy

### Configurable features instead of plugins
Expand Down Expand Up @@ -98,4 +104,4 @@ Considering the kind and frequency of changes to this repository, it makes sense

## Development

Keep in mind the `main` branch is regularly being rebased onto the upstream `master` branch.
Keep in mind the `main` branch may be rebased onto the upstream `master` branch.
2 changes: 1 addition & 1 deletion helix-term/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ impl Config {
.expect("Incorrect type for `editor.config`, expected `bool`");
}

log::info!("Evil mode not set in local/global config");
log::debug!("Evil mode not explicitly set in local/global config, will enable default");
return true;
}

Expand Down

0 comments on commit a2c8565

Please sign in to comment.