Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add whichkey descriptions #3

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

luqasn
Copy link

@luqasn luqasn commented Feb 1, 2025

including scripts to generate them.

I am not too happy that I had to create separate *.vim files that I cat together, but unfortunately you can't easily include/source sibling files (a.k.a relative to current file) in vimscript, and ideavim seems to lack workaround options I found for 'normal' vim.

Some group descriptions are still missing, e.g. for <leader><tab>. I think that one is a idea-which-key bug.

image

Copy link
Owner

@cufarvid cufarvid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this work! For managing updates - would this be run manually when we notice significant LazyVim changes?

@mikeslattery
Copy link
Collaborator

Nice.

Given the number of moving parts, it seems like this should produce a downloadable artifact (.ideavimrc). I am not sure users are going to be keen on having to run a build process just for a single config file. Some Windows users may not have all of the dependencies.

Perhaps the install instructions should be to download the generated file:

Installation

  1. Download the .ideavimrc file from this repository to your home directory:

    # Unix/Linux/macOS
    curl -Lo ~/.ideavimrc https://raw.githubusercontent.com/cufarvid/lazy-idea/refs/heads/main/.ideavimrc
    
    # Windows Powershell
    Invoke-WebRequest -OutFile "$HOME/.ideavimrc" -Uri "https://raw.githubusercontent.com/cufarvid/lazy-idea/refs/heads/main/.ideavimrct"

or we could publish the file separately and use Github Actions to build.

@cufarvid
Copy link
Owner

cufarvid commented Feb 6, 2025

Nice.

Given the number of moving parts, it seems like this should produce a downloadable artifact (.ideavimrc). I am not sure users are going to be keen on having to run a build process just for a single config file. Some Windows users may not have all of the dependencies.

Perhaps the install instructions should be to download the generated file:

Installation

  1. Download the .ideavimrc file from this repository to your home directory:
    # Unix/Linux/macOS
    curl -Lo ~/.ideavimrc https://raw.githubusercontent.com/cufarvid/lazy-idea/refs/heads/main/.ideavimrc
    
    # Windows Powershell
    Invoke-WebRequest -OutFile "$HOME/.ideavimrc" -Uri "https://raw.githubusercontent.com/cufarvid/lazy-idea/refs/heads/main/.ideavimrct"

or we could publish the file separately and use Github Actions to build.

Absolutely agree. I think the GitHub Actions approach with publishing the .ideavimrc could be a nice approach.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants