jsbeckr/emacs.d
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add straight package manager

Browse Source
This commit is contained in:
Rahul Martim Juliato
2025-04-05 21:39:35 -03:00
parent 3d83c32e19
commit ebfab32d5c
4 changed files with 367 additions and 326 deletions
Download Patch File Download Diff File Expand all files Collapse all files

172
README.md
View File

@@ -6,7 +6,6 @@ setup, you don't need to leave behind your favorite terminal or tools
like `yazi`, `starship`, `lazygit`, and `lazydocker` just to
give Emacs a try.
Use Emacs the same way you'd use `Neovim`, seamlessly integrating it
into your workflow inside terminal multiplexers like `tmux` or
`Zellij`, while also enjoying modern features such as `treesitter`
@@ -14,13 +13,11 @@ and `LSP`—no hassle.
![Demo](doc/demo01.png)
**Emacs-Kick** isn’t a full-fledged distribution but rather a
**starting point** for building your own Emacs configuration. It’s
designed to be especially accessible for Vim/Neovim users, letting you
explore the power of Emacs without committing to its entire ecosystem.
You can take advantage of Emacs’ features without needing to master
every Emacs-specific workflow right away. And if you find yourself
enjoying it, you can:
@@ -32,15 +29,13 @@ enjoying it, you can:
OR...
- Just keep using it on TUI, it is all up to you!
With Emacs-Kick, the goal is to empower you to explore Emacs at your
own pace. The sky's the limit! 🌟
## Minimum Requirements
- Emacs version **>=30**
- You can verify your version by running:
- Emacs version **>=30.1**
- You can verify your installed Emacs version by running:
```bash
emacs --version
@@ -54,7 +49,6 @@ emacs --version
`~/.emacs.d`, please back it up before proceeding. You can do this
by renaming the directory:
```bash
mv ~/.emacs.d ~/.emacs.d.backup
```
@@ -65,7 +59,6 @@ files such as `~/.emacs.d`, `~/.emacs`, `~/.emacs~`,
`~/.config/emacs`, `~/.config/doom`, `~/.config/cache/emacs` and
any other related files.
After deleting/backing up, clone the repository:
```bash
@@ -74,7 +67,7 @@ git clone https://github.com/LionyxML/emacs-kick.git ~/.emacs.d
2. **Run the setup**:
After cloning, install the configuration by running:
After cloning, install the configuration by running:
```bash
emacs -nw --eval="(ek/first-install)"
@@ -90,13 +83,15 @@ cd ~/.emacs.d/ && ./ek-reinstall.sh
Both methods will install all necessary packages and apply the
configuration.
**NOTE**: You will be prompted to install Tree-sitter grammars and
download some fonts (this configuration uses Nerd Fonts by
default). While you can choose to do this later, it is highly
recommended to complete these steps during the installation process
for the best experience!
**NOTE**: During the initial setup, you'll be prompted to install Tree-sitter
grammars and download some fonts. This configuration uses **Nerd Fonts** by
default, so installing them now is highly recommended for the best experience.
On first launch, Emacs will also **native compile some external packages**,
which may take a little time. Additionally, the first time you perform certain
actions—like opening the tree explorer, Emacs may compile related components in
the background. This is completely normal and only happens once per feature.
You might notice a brief moment of sluggish performance during this initial
compilation.
3. **Set terminal mode by default**:
@@ -131,87 +126,87 @@ emacs
```
**Usage Tips**:
- **Leader Key**: The leader key is set to `SPC` (spacebar),
`which-key` is there to help you discover keybindings.
`which-key` is there to help you discover keybindings.
- **Help Commands**:
- `SPC h i` opens the Emacs info documentation (`M-x info`).
- `SPC h v` allows you to explore available variables.
- `SPC h f` lets you explore functions.
- `SPC h k` displays keybindings.
- `SPC h i` opens the Emacs info documentation (`M-x info`).
- `SPC h v` allows you to explore available variables.
- `SPC h f` lets you explore functions.
- `SPC h k` displays keybindings.
**Troubleshooting**:
- If you encounter any issues during installation, check the
`*Messages*` buffer for more information. You can switch between
buffers with `SPC SPC`, and navigate options using `C-p` and `C-n`.
- If you encounter any issues during installation, check the
`*Messages*` buffer for more information. You can switch between
buffers with `SPC SPC`, and navigate options using `C-p` and `C-n`.
## Available Commands
| Keybinding | Action |
|---------------------|-------------------------------------------|
| `SPC` | Leader key |
| `C-d` | Scroll down |
| `C-u` | Scroll up |
| `<leader> s f` | Find file |
| `<leader> s g` | Grep |
| `<leader> s G` | Git grep |
| `<leader> s r` | Ripgrep |
| `<leader> s h` | Consult info |
| `<leader> /` | Consult line |
| `<leader> x x` | Consult Flymake |
| `] d` | Next Flymake error |
| `[ d` | Previous Flymake error |
| `<leader> x d` | Dired |
| `<leader> x j` | Dired jump |
| `<leader> x f` | Find file |
| `] c` | Next diff hunk |
| `[ c` | Previous diff hunk |
| `<leader> e e` | Toggle NeoTree |
| `<leader> g g` | Open Magit status |
| `<leader> g l` | Show current log |
| `<leader> g d` | Show diff for current file |
| `<leader> g D` | Show diff for hunk |
| `<leader> g b` | Annotate buffer with version control info |
| `] b` | Switch to next buffer |
| `[ b` | Switch to previous buffer |
| `<leader> b i` | Consult buffer list |
| `<leader> b b` | Open Ibuffer |
| `<leader> b d` | Kill current buffer |
| `<leader> b k` | Kill current buffer |
| `<leader> b x` | Kill current buffer |
| `<leader> b s` | Save buffer |
| `<leader> b l` | Consult buffer |
| `<leader>SPC` | Consult buffer |
| `<leader> p b` | Consult project buffer |
| `<leader> p p` | Switch project |
| `<leader> p f` | Find file in project |
| `<leader> p g` | Find regexp in project |
| `<leader> p k` | Kill project buffers |
| `<leader> p D` | Dired for project |
| `P` | Yank from kill ring |
| `<leader> P` | Yank from kill ring |
| `<leader> .` | Embark act |
| `<leader> u` | Undo tree visualize |
| `<leader> h m` | Describe current mode |
| `<leader> h f` | Describe function |
| `<leader> h v` | Describe variable |
| `<leader> h k` | Describe key |
| `] t` | Go to next tab |
| `[ t` | Go to previous tab |
| `<leader> m p` | Format with Prettier |
| `<leader> c a` | Execute code action |
| `<leader> r n` | Rename symbol |
| `gI` | Find implementation |
| `<leader> l f` | Format buffer via LSP |
| `K` | Show hover documentation |
| `gcc` | Comment/uncomment current line |
| `gc` | Comment/uncomment selected region |
| `gd` | Goto definitions |
| `gr` | Goto references |
| Keybinding | Action |
| -------------- | ----------------------------------------- |
| `SPC` | Leader key |
| `C-d` | Scroll down |
| `C-u` | Scroll up |
| `<leader> s f` | Find file |
| `<leader> s g` | Grep |
| `<leader> s G` | Git grep |
| `<leader> s r` | Ripgrep |
| `<leader> s h` | Consult info |
| `<leader> /` | Consult line |
| `<leader> x x` | Consult Flymake |
| `] d` | Next Flymake error |
| `[ d` | Previous Flymake error |
| `<leader> x d` | Dired |
| `<leader> x j` | Dired jump |
| `<leader> x f` | Find file |
| `] c` | Next diff hunk |
| `[ c` | Previous diff hunk |
| `<leader> e e` | Toggle NeoTree |
| `<leader> g g` | Open Magit status |
| `<leader> g l` | Show current log |
| `<leader> g d` | Show diff for current file |
| `<leader> g D` | Show diff for hunk |
| `<leader> g b` | Annotate buffer with version control info |
| `] b` | Switch to next buffer |
| `[ b` | Switch to previous buffer |
| `<leader> b i` | Consult buffer list |
| `<leader> b b` | Open Ibuffer |
| `<leader> b d` | Kill current buffer |
| `<leader> b k` | Kill current buffer |
| `<leader> b x` | Kill current buffer |
| `<leader> b s` | Save buffer |
| `<leader> b l` | Consult buffer |
| `<leader>SPC` | Consult buffer |
| `<leader> p b` | Consult project buffer |
| `<leader> p p` | Switch project |
| `<leader> p f` | Find file in project |
| `<leader> p g` | Find regexp in project |
| `<leader> p k` | Kill project buffers |
| `<leader> p D` | Dired for project |
| `P` | Yank from kill ring |
| `<leader> P` | Yank from kill ring |
| `<leader> .` | Embark act |
| `<leader> u` | Undo tree visualize |
| `<leader> h m` | Describe current mode |
| `<leader> h f` | Describe function |
| `<leader> h v` | Describe variable |
| `<leader> h k` | Describe key |
| `] t` | Go to next tab |
| `[ t` | Go to previous tab |
| `<leader> m p` | Format with Prettier |
| `<leader> c a` | Execute code action |
| `<leader> r n` | Rename symbol |
| `gI` | Find implementation |
| `<leader> l f` | Format buffer via LSP |
| `K` | Show hover documentation |
| `gcc` | Comment/uncomment current line |
| `gc` | Comment/uncomment selected region |
| `gd` | Goto definitions |
| `gr` | Goto references |
...and a lot more, discoverable with which-key :)
## Contributing
This package is intentionally designed with a specific vision in mind,
@@ -219,17 +214,14 @@ reflecting my own opinions and preferences. While contributions are
welcome, please understand that this configuration is quite
opinionated.
If you have suggestions or requests, they will be considered
carefully, but I cannot make any promises regarding implementation or
acceptance. Your input is valuable, and I appreciate any help or
feedback to improve the project.
To contribute, feel free to open an issue or submit a pull
request. Let's make this configuration even better together!
## About PRs
Always welcome, not a promise to accept though (see above). Please